Plan Manager - AddPlan

Version: 7C

HC7 Build: 7.00.0012 and later

API Build: 1.00.0001 and later

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

Input Parameters

• HostUserName

• HostPassword

• OwnerName - user name under which you want to add plan

• PlanName - name of plan to be added

• Platform

• ResourceList - XML packet containing name and quantity of resource, see sample below

• OptionalParam

•  PlanDescription - detailed description of plan to be created

•  CancellationPolicy - detailed cancellation policy of plan to be created

•  Status

• SetupPrice

•  PromotionalPrice

•  PromotionalDuration - duration in months i.e. 1,4,5

•  MonthlyRecurringPrice - price to be charged, if plan will be sold on monthly basis

•  QuarterlyRecurringPrice - price to be charged, if plan will be sold on quarterly basis

•  BiannualRecurringPrice - price to be charged, if plan will be sold on biannual basis

•  YearlyRecurringPrice - price to be charged, if plan will be sold on yearly basis

•  OtherRecurringDuration - any recurring duration other than mentioned above

•  OtherRecurringPrice - price to be charged, if plan will be sold for other recurring duration

•  DefaultDuration - duration to be selected when plan will be sold without user interaction like on Website/User Creation

•  Language
   

Sample ResourceList Parameter

<Resources>

<Resource Name="User Accounts">10</Resource>

<Resource Name="Domains">Unlimited</Resource>

<Resource Name="Mail Domains">Excluded</Resource>

.......

.......

                                        .......

</Resources>

Output Parameters

N/A

Sample Optional Parameters

<Parameters>

<Parameter Name = "PlanDescription">This is my new plan</Parameter>

<Parameter Name = "Status">Available</Parameter>

<Parameter Name = "SetupPrice">2.30</Parameter>

<Parameter Name = "MonthlyRecurringPrice">4.9</Parameter>

<Parameter Name = "DefaultDuration">1</Parameter>

<Parameter Name = "PromotionalPrice">2.30</Parameter>

<Parameter Name = "PromotionalDuration">1</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/AddPlan"

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

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

      <HostUserName>host</HostUserName>

      <HostPassword>host123</HostPassword>

      <OwnerName>david</OwnerName>

      <PlanName>MyPlan</PlanName>

      <Platform>Windows</Platform>

      <ResourceList>xml</ResourceList>

      <OptionalParam>xml</OptionalParam>

    </AddPlan>

  </soap:Body>

</soap:Envelope>

Sample HTTP Request

POST /HC7API/PlanManager.asmx/AddPlan 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&Platform=
Windows&ResourceList=xml&OptionalParam=xml

Sample C# Code

public PlanManager.Response AddPlan(string strHostUserName, string strHostPassword, string strOwnerName, string strPlanName, string strPlatform, XmlNode xResourceList)

{

         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 = "PlanDescription";

                   xParameter.Attributes.Append(xAttribute);

                   xParameter.InnerText = "This is my new plan";

                   xOptionalParam.AppendChild(xParameter);

                   .......

                   .......

                   .......

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

                   strPlatform, xResourceList, OptionalParam);

         }

         catch

         {

         }

         return oResponse;

}

Sample Response

<Response>

    <Method>AddPlan</ Method>

    <Status>true</Status>

    <ErrorCode>70100011</ErrorCode>

    <ErrorDescription>Plan created successfully.</ErrorDescription>

    <Result/>

</Response>