GetPlanInfo API

Here you can request account information about a specific user, such as storage space, used space, registration end date and last activity.

 

 

  • Authentication token:
    The reseller’s authentication token to authorize use of the APIs this must be passed as type string.

 

  • Plan ID:
    Registration email for the account you wish to get user information for as type string.

 

CodeMessageComments
1000Plan ID: Plan ID
Plan Name: The plan name
Users: Number of users assigned to the plan
Servers: Number of servers assigned to the plan
Capacity: Instant Storage Space
ColdCapacity: Cold Storage space
UsedSpace: Used Instant Storage Space
Plan Type: Home or business plan type
Plan Frequency: The Frequency of the plan (ex.
Monthly, yearly…)
The user information will return
in the message; json format
1002Invalid Authentication TokenThe authentication token is
incorrect, please check it and try
again
1006Plan Error, Plan does not existMake sure you have supplied the
valid plan ID
1006Plan Error, Plan does not belong to youThe plan ID specified is not a plan
under your reseller account
1007General ExceptionIf you receive this error, please
contact support

 

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /Services/Reseller/Service.asmx HTTP/1.1
Host: zoolz.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version=”1.0″ encoding=”utf-8″?>
<soap12:Envelope xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”
xmlns:xsd=”http://www.w3.org/2001/XMLSchema”
xmlns:soap12=”http://www.w3.org/2003/05/soap-envelope”>
<soap12:Body>
<GetPlanInfo xmlns=”Zoolz”>
<authToken>string</authToken>
<planID>int</planID>
</GetPlanInfo>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version=”1.0″ encoding=”utf-8″?>
<soap12:Envelope xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”
xmlns:xsd=”http://www.w3.org/2001/XMLSchema”
xmlns:soap12=”http://www.w3.org/2003/05/soap-envelope”>
<soap12:Body>
<GetPlanInfoResponse xmlns=”Zoolz”>
<GetPlanInfoResult>
<Code>Success or MissingParameters or InvalidAuth or InvalidPlanID or
GeneralError </Code>
<Message>string</Message>
<Joson>string</Joson>
</GetPlanInfoResult>
</GetPlanInfoResponse>
</soap12:Body>
</soap12:Envelope>

Tagged: