Plan Manager - GetPlanDetails

Version: 7C

HC7 Build: 7.00.0012 and later

API Build: 1.00.0001 and later

Plan Manager - GetPlanDetails retrieves details of a specified plan. This web service call can be made as http://your-domain.com/HC7API/PlanManager.asmx?op=GetPlanDetails.

Input Parameters

• HostUserName

• HostPassword

• OwnerName -  owner name of plan whose details you want to retrieve

• PlanName - name of plan whose details you want to retrieve

• OptionalParam

• Language
   

Output Parameters

• PlanID - a unique identification number assigned to each plan

• PlanName

• PlanDescription - detailed description of plan

• CancellationPolicy

• Platform

• Status

• FinancialDetails (XML Node)

• PlanResources (XML Node)

Sample Optional Parameters

<Parameters>

<Parameter Name = "Language">French</Parameter>

</Parameters>

Sample SOAP Request

POST /HC7API/PlanManager.asmx HTTP/1.1

Host: your-domain.com

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://tempuri.org/GetPlanDetails"

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

  <soap:Body>

    <GetPlanDetails xmlns="http://tempuri.org/">

      <HostUserName>host</HostUserName>

      <HostPassword>host123</HostPassword>

      <OwnerName>david</OwnerName>

      <PlanName>MyPlan</PlanName>

      <OptionalParam>xml</OptionalParam>

    </GetPlanDetails>

  </soap:Body>

</soap:Envelope>
 

Sample HTTP Request

POST /HC7API/PlanManager.asmx/GetPlanDetails HTTP/1.1

Host: your-domain.com

Content-Type: application/x-www-form-urlencoded

Content-Length: length

HostUserName=host&HostPassword=host123&OwnerName=david&PlanName=MyPlan&OptionalParam=xml
 

Sample C# Code

public PlanManager.Response GetPlanDetails(string strHostUserName, string strHostPassword, string strOwnerName, string strPlanName)

{

         try

         {

                   PlanManager.PlanManager oPlan = new PlanManager.PlanManager();

                   PlanManager.Response oResponse = new PlanManager.Response();

                   oResponse = oPlan.GetPlanDetails(strHostUserName, strHostPassword, strOwnerName, strPlanName,

                   null);

         }

         catch

         {

         }

         return oResponse;

}
 

Sample Response

<Response>

    <Method>GetPlanDetails</Method>

    <Status>true</Status>

    <ErrorCode>74900001</ErrorCode>

    <ErrorDescription>Operation completed successfully.</ErrorDescription>

    <Result>

        <PlanDetails xmlns="">

            <Plan>

                <PlanID>2</PlanID>

                <PlanName>MyPlan</PlanName>

                <PlanDescription>This is my New Plan</PlanDescription>

                                       .......

                                       .......

                                       .......

                <FinancialDetails>

                    <SetupPrice>3.00</SetupPrice>

                    <RecurringPrice>3.00</RecurringPrice>

                                       .......

                                       .......

                                       .......

                </FinancialDetails>

                <PlanResources>

                    <RecordCount>32</RecordCount>

                    <RecordRow>

                        <ResourceID>6</ResourceID>

                        <ResourceName>User Accounts</ResourceName>

                        <Quantity>10</Quantity>

                        <ResourceID>3</ResourceID>

                        <ResourceName>Domains</ResourceName>

                        <Quantity>5</Quantity>

                    </RecordRow>

                          .......

                          .......

                          .......

                </PlanResources>

            </Plan>

               .......

               .......

               .......

        </PlanDetails>

    <Result>

</Response>