Plan Manager - GetPurchasedPlans

Version: 7C

HC7 Build: 7.00.0012 and later

API Build: 1.00.0001 and later

Plan Manager - GetPurchasdPlans retrieves all purchased plans purchased by a specified user. This web service call can be made as http://your-domain.com/HC7API/PlanManager.asmx?op=GetPurchasedPlans.

Input Parameters

• HostUserName

• HostPassword

• OwnerName - user name whose purchased plans you want to retrieve

• OptionalParam

• PurchasedDate - search filter (mm/dd/yyyy)

• NextBillingDay - search filter (mm/dd/yyyy)

• Language
   

Output Parameters

• PurchasedPlanID - unique identification number given to each purchased plan instance

• PlanName - name of the plan instance

• PurchasedOn - purchased date

• DueSince - invoice due date, in case plan is unpaid

• NextBillingDay - next invoicing day

Sample Optional Parameters

<Parameters>

<Parameter Name = "PurchasedDate">05/22/2007</Parameter>

<Parameter Name = "NextBillingDay">01/01/2008</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/GetPurchasedPlans"

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

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

      <HostUserName>host</HostUserName>

      <HostPassword>host123</HostPassword>

      <OwnerName>john</OwnerName>

      <OptionalParam>xml</OptionalParam>

    </GetPurchasedPlans>

  </soap:Body>

</soap:Envelope>

Sample HTTP Request

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

Host: your-domain.com

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

Content-Length: length

HostUserName=host&HostPassword=host123&OwnerName=john&OptionalParam=xml

Sample C# Code

public PlanManager.Response GetPurchasedPlans(string strHostUserName, string strHostPassword, string strOwnerName)

{

         try

         {

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

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

                   XmlDocument oDoc = new XmlDocument();

 //Adding root node

 XmlNode xOptionalParam = oDoc.CreateNode(XmlNodeType.Element,"Parameters","");

 //Adding sub nodes

 XmlNode xParameter = oDoc.CreateNode(XmlNodeType.Element,"Parameter","");

 XmlAttribute xAttribute = oDoc.CreateAttribute("Name");

 xAttribute.Value = "PurchasedDate ";

 xParameter.Attributes.Append(xAttribute);

 xParameter.InnerText = "05/22/2007";

 xOptionalParam.AppendChild(xParameter);

 .......

 .......

 .......

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

                   OptionalParam);

         }

         catch

         {

         }

         return oResponse;

}

Sample Response

<Response>

    <Method>GetPurchasedPlans</Method>

    <Status>true</Status>

    <ErrorCode>74900001</ErrorCode>

    <ErrorDescription>Operation completed successfully</ErrorDescription>

    <Result>

        <PurchasedPlans xmlns="">

        <RecordCount>1</RecordCount>

            <RecordRow>

                <PurchasedPlanID>12</PurchasedPlanID>

                <PlanName>MyPlan</PlanName>

                <PurchasedOn>Apr 26, 2007</PurchasedOn>

                <DueSince>Jun 15, 2007</DueSince>

                <NextBillingDaty>May 26, 2007</NextBillingDay>

            </RecordRow>

        </PurchasedPlans>

    </Result>

</Response>