Plan Manager - GetPurchasedPlanDetails

Version: 7C

HC7 Build: 7.00.0012 and later

API Build: 1.00.0001 and later

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

Input Parameters

• HostUserName

• HostPassword

• OwnerName -  name of the user who has purchased the plan

• PurchasedPlanID - unique identification number against purchased plan instance whose details you want to retrieve

• OptionalParam

• Language
   

Output Parameters

• PurchasedPlanID - unique identification number given to each purchased plan

• PlanID - unique identification number of plan instance purchased

• PlanName

• PlanDescription

• 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/GetPurchasedPlanDetails"

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

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

      <HostUserName>host</HostUserName>

      <HostPassword>host123</HostPassword>

      <OwnerName>john</OwnerName>

      <PurchasedPlanID>12</PurchasedPlanID>

      <OptionalParam>xml</OptionalParam>

    </GetPurchasedPlanDetails>

  </soap:Body>

</soap:Envelope>
 

Sample HTTP Request

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

Host: your-domain.com

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

Content-Length: length

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

Sample C# Code

public PlanManager.Response GetPurchasedPlanDetails(string strHostUserName, string strHostPassword, string strOwnerName, int nPurchasedPlanID)

{

         try

         {

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

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

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

                   nPurchasedPlanID, null);

         }

         catch

         {

         }

         return oResponse;

}
 

Sample Response

<Response>

    <Method>GetPurchasedPlanDetails</Method>

    <Status>true</Status>

    <ErrorCode>74900001</ErrorCode>

    <ErrorDescription>Operation completed successfully</ErrorDescription>

    <Result>

        <PurchasedPlanDetails xmlns="">

            <PurchasedPlanID>12</PurchasedPlanID>

            <PlanID>2</PlanID>

            <PlanName>MyPlan</PlanName>

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

            <CancellationPolicy>Canel it</CancellationPolicy>

            <Platform>Windows</Platform>

            <Status>Available</Status>

            <FinancialDetails>

                <SetupPrice>10.00</SetupPrice>

                <SetupDiscount>2%</SetupDiscount>

                <NetSetupPrice>8.00</NetSetupPrice>

                              .......

                              .......

                              .......

            </FinancialDetails>

            <PlanResources>

                <RecordRow>

                    <ResourceID>6</ResourceID>

                    <ResourceName>User Accounts</ResourceName>

                    <Quantity>Unlimited</Quantity>

                </RecordRow>

                         .......

                         .......

                         .......

            </PlanResources>

            <AddOns>

                <RecordRow>

                    <ResourceName>Domains</ResourceName>

                    <Quantity>1</Quantity>

                </RecordRow>

            </AddOns>

        </PurchasedPlanDetails>

    </Result>

</Response>