reseller

is added when reseller has a customer specific business

Get Order Id

Description

Gets the associated CodeGuard Order ID from the domain name.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
domain-name String Required The domain name for which the Order ID is to be fetched

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/codeguard/orderid.json?auth-userid=0&api-key=key&domain-name=domainname.com

Response

Returns the associated CodeGuard Order ID (Integer) for the specified domain name.

Get Plan Details

Description

Use this method to get details of your plans.

Response

Returns details of the plans of the CodeGuard product, along with the plan details of other Products of the Reseller.

Example:

The response structure for the CodeGuard product will be:


"codeguard":
{
"plan-id":
{
"plan_name":"Plan Name",
"plan_status":"(Active or Paused)"
},
},

Get Details

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)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Delete

Description

Deletes 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 which is to be deleted

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/codeguard/delete.json?auth-userid=0&api-key=key&order-id=0

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the CodeGuard Order (entityid)

  • Action Type (actiontype)

  • Description of the CodeGuard Order Delete Action (actiontypedesc)

  • Action ID of the CodeGuard Order Delete Action (eaqid)

  • CodeGuard Order Delete Action Status (actionstatus)

  • Description of the CodeGuard Order Delete Action Status (actionstatusdesc)

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Upgrade/Downgrade

Description

Upgrades/Downgrades an existing CodeGuard order.

Parameters

Name Data Type Required / Optional
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The Order ID of the Order which is to be upgraded/downgraded
new-plan-id Integer Required The new plan to which the Order is to be upgraded/downgraded. To fetch the plan details i.e. plan-id etc, use this method.
months Integer Required The number of months in the new plan for which the Order is to be upgraded/downgraded
invoice-option String Required This parameter will decide how the Customer Invoices will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice, OnlyAdd

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/codeguard/modify.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the CodeGuard Order (entityid)

  • Action Type (actiontype)

  • Description of the CodeGuard Order Upgrade/Downgrade Action (actiontypedesc)

  • Action ID of the CodeGuard Order Upgrade/Downgrade Action (eaqid)

  • CodeGuard Order Upgrade/Downgrade Action Status (actionstatus)

  • Description of the CodeGuard Order Upgrade/Downgrade Action Status (actionstatusdesc)

  • Invoice ID of the CodeGuard Order Upgrade/Downgrade Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Customer ID associated with the CodeGuard Order (customerid)

Note

invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Renew

Description

Renews 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 which is to be renewed
months Integer Required The number of months for which the Order is to be renewed
auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the Order

invoice-option String Required This parameter will decide how the Customer's Invoice will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice or OnlyAdd.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/codeguard/renew.json?auth-userid=0&api-key=key&order-id=0&months=0&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the CodeGuard Order (entityid)

  • Action Type (actiontype)

  • Description of the CodeGuard Order Renew Action (actiontypedesc)

  • Action ID of the CodeGuard Order Renew Action (eaqid)

  • CodeGuard Order Renew Action Status (actionstatus)

  • Description of the CodeGuard Order Renew Action Status (actionstatusdesc)

  • Invoice ID of the CodeGuard Order Renew Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Customer ID associated with the CodeGuard Order (customerid)

Note

invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.

Add

Description

Places a CodeGuard Order for the specified domain name.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
domain-name String Required The domain name for which the Order is to be placed
customer-id Integer Required The Customer under whom the Order should be added
months Integer Required The number of months for which the Order is to be placed
plan-id Integer Required The plan under which the Order should be added. To fetch the plan details i.e. plan-id etc., use this method.
auto-renew Boolean Optional

Enables / Disables the Auto Renewal setting for the Order

invoice-option String Required This parameter will decide how the Customer's Invoice will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice or OnlyAdd.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/codeguard/add.json?auth-userid=0&api-key=key&domain-name=name&customer-id=0&months=0&plan-id=0&invoice-option=NoInvoice

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the CodeGuard Order (entityid)

  • Action Type (actiontype)

  • Description of the CodeGuard Order Add Action (actiontypedesc)

  • Action ID of the CodeGuard Order Add Action (eaqid)

  • CodeGuard Order Add Action Status (actionstatus)

  • Description of the CodeGuard Order Add Action Status (actionstatusdesc)

  • Invoice ID of the CodeGuard Order Add Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Customer ID associated with the CodeGuard Order (customerid)

Note

invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.