Plan Manager - GetSoldAddOns

Version: 7C

HC7 Build: 7.00.0012 and later

API Build: 1.00.0001 and later

Plan Manager - GetSoldAddOns retrieves all the addons sold to a specified sold plan instance. This web service call can be made as http://your-domain.com/HC7API/PlanManager.asmx?op=GetSoldAddOns.

Input Parameters

• HostUserName

• HostPassword

• OwnerName - user name whose sold addons you want to retrieve

• SoldPlanID - unique identification number of sold plan instance whose addon you want to retrieve

• OptionalParam

• Language
   

Output Parameters

• SoldAddOnID - unique identification number given to each sold addon instance

• SoldPlanID - unique identification number given to each sold plan instance

• ResourceName - name of added resource

• ResourceType

• Quantity - quantity of resource added

• BillingMethod - Bill with Plan / Monthly Billing

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/GetSoldAddOns"

<?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>

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

      <HostUserName>host</HostUserName>

      <HostPassword>host123</HostPassword>

      <OwnerName>david</OwnerName>

      <SoldPlanID>12</SoldPlanID>

      <OptionalParam>xml</OptionalParam>

    </GetSoldAddOns>

  </soap:Body>

</soap:Envelope>

Sample HTTP Request

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

Host: your-domain.com

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

Content-Length: length

HostUserName=host&HostPassword=host123&OwnerName=david&SoldPlanID=12&OptionalParam=xml

Sample C# Code

public PlanManager.Response GetSoldAddOns(string strHostUserName, string strHostPassword, string strOwnerName, int nSoldPlanID)

{

         try

         {

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

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

                    oResponse = oPlan.GetSoldAddOns(strHostUserName, strHostPassword, strOwnerName,   

                    nSoldPlanID, null);

         }

         catch

         {

         }

         return oResponse;

}

Sample Response

<Response>

    <Method> GetSoldAddOns</Method>

    <Status>true</Status>

    <ErrorCode>74900001</ErrorCode>

    <ErrorDescription>Operation completed successfully</ErrorDescription>

    <Result>

        <SoldAddOns xmlns="">

        <RecordCount>1</RecordCount>

            <RecordRow>

                <SoldAddOnID>27</SoldAddOnID>

                <SoldPlanID>2</SoldPlanID>

                <ResourceName>User Accounts</ResourceName>

                <ResourceType>System</ResourceType>

                <Qunatity>1</Qunatity>

                <BillingMethod>Monthly Billing</BillingMethod>

            </RecordRow>

        </SoldAddOns>

    </Result>

</Response>