Description
Gets the details of an existing CodeGuard Order.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| order-id | Integer | Required | The Order ID of the Order for which the details are to be fetched |
HTTP Method
GET
Example Test URL Request
https://test.httpapi.com/api/codeguard/details.json?auth-userid=0&api-key=key&order-id=0
Response
Returns a hash map containing the below details:
-
Order ID (entityid)
-
Order Description (description)
-
Domain Name (domainname)
-
Current Order Status under the System (currentstatus) - value will be InActive, Active, Suspended or Deleted
-
Product key (productkey)
-
Product Category (productcategory)
-
Plan ID of the CodeGuard Plan (planid)
-
Status of the CodeGuard Plan (paused)
-
Order Creation Date (creationtime)
-
Expiry Date (endtime)
-
Whether Order belongs to a Customer directly under the Reseller (isImmediateReseller)
-
Reseller Chain by RID (parentkey)
-
Customer ID Associated with the Order (customerid)
-
Whether Order Suspended due to Expiry (isOrderSuspendedUponExpiry)
-
Whether Order Suspended by Parent Reseller (orderSuspendedByParent)
-
Whether Order Deletion is Allowed (allowdeletion)
-
Whether Auto-Renewal is enabled (recurring)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.