Plan Manager - GetSoldPlanDetails

Version: 1

HCnix Build: 3.00 and later

API Build: 1.00 and later

Plan Manager - GetSoldPlanDetails gets details of a specified sold plan instance. This web service call can be made as http://your-domain.com/HCnixAPI/PlanManager.php?op=GetSoldPlanDetails.

Input Parameters

HostUserName
HostPassword
OwnerName - owner name of plan whose details you want to view
SoldPlanID - unique identification number against sold plan instance whose details you want to retrieve
OptionalParam

Language

Note : SoldPlanID the unique identification number, can be retrieved using GetSoldPlans.

Output Parameters

SoldPlanID - unique identification number given to each sold plan
PlanID - unique identification number of plan sold
PlanName - name of retrieved plan
PlanDescription - detailed description of retrieved plan
CancellationPolicy - detailed cancellation policy of retrieved plan
Status - plan status i.e. Available or Unavailable
Resources - (XML Node) details of resources related to retrieved plan i.e. ResourceID, ResourceName, Quantity.

Sample Optional Parameters

<Parameter Name = "Language">French</Parameter>

</Parameters>

Sample SOAP Request

POST /HCnixAPI/PlanManager.php HTTP/1.1

Host: your-domain.com

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://tempuri.org/GetSoldPlanDetails"

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

<OwnerName>david</OwnerName>

</GetSoldPlanDetails>

</soap:Body>

</soap:Envelope>

Sample HTTP Request

POST /HCnixAPI/PlanManager.php/GetSoldPlanDetails 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 PHP Code

function GetSoldPlanDetails($strHostUserName, $strHostPassword, $strOwnerName, $strSoldPlanID, $OptionalParam)

{

$response="";

$soapPacket = "<?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>

<HostUserName>$strHostUserName</HostUserName>

<HostPassword>$strHostPassword</HostPassword>

<OwnerName>$strOwnerName</OwnerName>

<SoldPlanID>$strSoldPlanID</SoldPlanID>

<OptionalParam>$OptionalParam</OptionalParam>

</GetSoldPlanDetails>

</soap:Body>

</soap:Envelope>";

// where $domain_name is where HCnix APIs are installed

$fp = fsockopen($domain_name, 80, $errNo, $errString, 90);

if($fp)

{

// where $name is the Virtual Directory name for HCnix APIs

$header = "POST /$name/UserManager.php HTTP/1.1\r\n";

$header .= "HOST: $domain_name\n";

$header .= "Content-Type: text/xml;charset=\"utf-8\"\r\n";

$header .= "Content-Length: ".strlen($soapPacket)."\r\n\r\n";

fwrite($fp, $header.$soapPacket);

while (true)

{

$buffer = fread($fp, 1000);

if( $buffer != "" )

$response .= $buffer;

if(strstr($response, '</SOAP-ENV:Envelope>') || $buffer == "" )

break;

$buffer = "";

}

fclose($fp);

$result = explode("<?xml",$response);

return "<?xml".$result[1];

}

Sample Response

<Method>GetSoldPlanDetails</Method>

<ErrorDescription>Operation completed successfully</ErrorDescription>

<PlanName>MyPlan</PlanName>

<CancellationPolicy>Canel it</CancellationPolicy>

<Status>Available</Status>

<ResourceName>User Accounts</ResourceName>

<ResourceName>Unlimited</ResourceName>

</RecordRow>

.......

</Resources>

<ResourceName>Domains</ResourceName>

</RecordRow>

</AddOns>

</SoldPlanDetails>

</Result>

</Response>