Plan Manager - GetPlans

Version: 7C

HC7 Build: 7.00.0012 and later

API Build: 1.00.0001 and later

Plan Manager - GetPlans retrieves all plans under a specified owner. This web service call can be made as http://your-domain.com/HC7API/PlanManager.asmx?op=GetPlans.

Input Parameters

• HostUserName

• HostPassword

• OwnerName - user name whose plans you want to retrieve

• OptionalParam

• Platform

• PlanName - search filter

• Language
   

Output Parameters

• PlanID - a unique identification number given to each plan

• PlanName

• Status

• PlanType

Sample Optional Parameters

<Parameters>

<Parameter Name = "Platform">Windows</Parameter>

<Parameter Name = "PlanName">Basic</Parameter>

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

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

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

      <HostUserName>host</HostUserName>

      <HostPassword>host123</HostPassword>

      <OwnerName>david</OwnerName>

      <OptionalParam>xml</OptionalParam>

    </GetPlans>

  </soap:Body>

</soap:Envelope>

Sample HTTP Request

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

Host: your-domain.com

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

Content-Length: length

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

Sample C# Code

public PlanManager.Response GetPlans(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 = "Platform";

                    xParameter.Attributes.Append(xAttribute);

                    xParameter.InnerText = "Windows";

                    xOptionalParam.AppendChild(xParameter);

                    .......

                    .......

                    .......

                    oResponse = oPlan.GetPlans(strHostUserName, strHostPassword, strOwnerName, OptionalParam);

         }

         catch

         {

         }

         return oResponse;

}

Sample Response

<Response>

    <Method>GetPlans</ Method>

    <Status>true</Status>

    <ErrorCode>74900001</ErrorCode>

    <ErrorDescription>Operation completed successfully.</ErrorDescription>

    <Result>

        <Plans xmlns="">

           <RecordCount>6</RecordCount>

                <RecordRow>

                    <PlanID>12</PlanID>

                    <PlanName>Basic Plan</PlanName>

                    <Status>Available</Status>

                    <PlanType>Windows</PlanType>

                 </RecordRow>

                      .......

                      .......

                      .......

                 <RecordRow>

                    <PlanID>38</PlanID>

                    <PlanName>Basic Linux Plan</PlanName>

                    <Status>Available</Status>

                    <PlanType>Linux</PlanType>

                 </RecordRow>

             </Plans>

    </Result>

</Response>