is added when reseller has a customer specific business
Web Services Plans provide you with methods to add, renew, upgrade/modify, suspend, delete and get the details and the pricing for the Website Builder plans.
The Legacy Linux, Windows Hosting Products and Email only plans offered by have been deprecated w.e.f. April 16, 2013 and Feb 2, 2015 respectively. You may only renew, suspend, delete, get the details and the pricing for these Products Plans.
Gets the details of the all active product plans of the Reseller.
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| product-key | String | Optional | Product key of the product for which the details are to be fetched |
GET
https://test.httpapi.com/api/products/plan-details.json?auth-userid=0&api-key=key
Returns a map with the details of all the product plan of the Reseller.
Deletes the IP address associated with the specified Child Name Server of the particular Domain Registration Order.
| Name | Data Type | Required | Description |
|---|---|---|---|
| auth-userid | Integer | Yes | Authentication Parameter |
| api-key | String | Yes | Authentication Parameter |
| order-id | Integer | Yes | Order Id of the Domain Registration Order. |
| cns | String | Yes | Child Name Server's name for which the IP address needs to be deleted. |
| ip | Array of Strings | Yes | IP address that needs to be deleted. |
POST
https://test.httpapi.com/api/domains/delete-cns-ip.xml?auth-userid=0&api-key=key&order-id=0&cns=ns1.domain.asia&ip=1.2.3.4
Returns a hash map containing the below details:
Domain Name (description)
Order ID of the Domain Registration Order (entityid)
Action Type (actiontype)
Description of the Child Name Server IP Deletion Action (actiontypedesc)
Action ID of the Child Name Server IP Deletion Action (eaqid)
Child Name Server IP Deletion Action Status (actionstatus)
Description of the Child Name Server IP Deletion Action Status (actionstatusdesc)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
Searches the Archived Actions based on the criteria specified.
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| eaq-id | Array of Integers | Optional | The Entity Action Queue Ids of the corresponding actions |
| order-id | Array of Integers | Optional | The Order Ids for which you want to search actions |
| entity-type-id | Array of Integers | Optional | The Entity Type Ids for which you want to search actions |
| action-status | Array of Strings | Optional | The action statuses for which you want to search actions |
| action-type | Array of Strings | Optional | The action types for which you want to search actions |
| no-of-records | Integer | Required | Number of records to be returned |
| page-no | Integer | Required | Page number for which records are required |
GET
https://test.httpapi.com/api/actions/search-archived.json?auth-userid=0&api-key=key&order-id=0&order-id=1&no-of-records=10&page-no=1
Returns a hash map of the Archived Actions containing the below details:
Order Id (entityid)
Entity Type Id (entitytypeid)
Entity Action Queue Id (eaqid)
Action Type (actiontype)
Description of the Action (actiontypedesc)
Timestamp when the Action was added (actionadded)
Timestamp when the Action started (actionstarted)
Timestamp when the Action got completed (actioncompleted)
Action Status (actionstatus)
Description of the Action Status (actionstatusdesc)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
Gets the Current Actions based on the criteria specified.
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| eaq-id | Array of Integers | Optional | The Entity Action Queue Ids of the corresponding actions |
| order-id | Array of Integers | Optional | The Order Ids for which you want to search actions |
| entity-type-id | Array of Integers | Optional | The Entity Type Ids for which you want to search actions. |
| action-status | Array of Strings | Optional | The action statuses for which you want to search actions. |
| action-type | Array of Strings | Optional | The action types for which you want to search actions |
| no-of-records | Integer | Required | Number of records to be returned |
| page-no | Integer | Required | Page number for which records are required |
GET
https://test.httpapi.com/api/actions/search-current.json?auth-userid=0&api-key=key&order-id=0&order-id=1&no-of-records=10&page-no=1
Returns a hash map of the Current Actions containing the below details:
Order Id (entityid)
Entity Type Id (entitytypeid)
Entity Action Queue Id (eaqid)
Action Type (actiontype)
Description of the Action (actiontypedesc)
Timestamp when the Action was added (actionadded)
Timestamp when the Action started (actionstarted)
Timestamp when the Action got completed (actioncompleted)
Action Status (actionstatus)
Description of the Action Status (actionstatusdesc)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
Gets the list of Customers' Payment Gateway Transactions, matching the search criteria.
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| payment-type-id | Integer | Required | Payment Type Id |
| transaction-ids | Array of Integer | Optional | Transaction Ids |
| customer-ids | Array of Integer | Optional | Customer Id of the Customer(s) for whom the details are to be fetched |
| transaction-type | String | Required | Transaction type. Values can be addfund or payment. |
| start-date | String | Optional | Start date of the duration for which Transactions are to be fetched |
| end-date | String | Optional | End date of the duration for which Transactions are to be fetched |
| status | Array of Strings | Optional | Status of the Transaction. Values can be AuthCancelled, AuthFailed, AuthPending, AuthStarted, FailedByCron, Refunded or Settled. |
| no-of-records | Integer | Required | Number of records to be returned |
| page-no | Integer | Required | Page number for which records are required |
GET
https://test.httpapi.com/api/pg/customer-transactions.xml?auth-userid=0&api-key=key&payment-type-id=1&transaction-type=addfund&no-of-records=10&page-no=1
Returns a hash map of Customers' Payment Gateway Transactions containing the below details:
Transaction Id (transid)
Transaction Creation Date (creationdt)
Entity initiating the Transaction (role)
Customer Id (userid)
Transaction Status (status)
Transaction Amount in the Selling Currency of the Parent Reseller (sellingamount)
Amount Charged in the Selling Currency of the Parent Reseller (chargedamount)
Transaction Amount in the Accounting Currency of the Parent Reseller (accountingamount)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
Moves all products from one customer to other customer.
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| domain-name | String | Required | Domain name that needs to be moved |
| existing-customer-id | Integer | Required | Existing Customer ID from which the products are to be transferred |
| new-customer-id | Integer | Required | New Customer ID to which the products are to be transferred |
| default-contact | String | Required |
Attention
This API Parameter will be deprecated from 1st December 2016 due to IRTP changes in the system. This parameter will not be required post 1st December 2016 as by default only the old contact can be used. Value to indicate whether the old Contact has to be retained or to use the Default Contact of the new Customer. Valid entries are oldcontact or default. Note
In case of a .CN domain name, the Default Contact of the new Customer cannot be associated with the domain name and the old Contact has to be retained. Hence, oldcontact Note
In case of a .ES domain name, the Default Contact of the new Customer cannot be associated with the domain name and the old Contact has to be retained. Hence, oldcontact
|
POST
https://test.httpapi.com/api/products/move.json?auth-userid=0&api-key=key&domain-name=domain.com&existing-customer-id=0&new-customer-id=0&default-contact=oldcontact
Returns a hash map containing a status key with value as Success, if the move request is accepted by the system for processing.
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
Disables the Theft Protection Lock on the specified order.
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| order-id | Integer | Required | Order Id of the Domain Registration Order on which the Theft Protection Lock is to be removed. |
POST
https://test.httpapi.com/api/domains/disable-theft-protection.json?auth-userid=0&api-key=key&order-id=0
Returns a hash map containing the below details:
Domain Name (description)
Order ID of the Domain Registration Order (entityid)
Action Type (actiontype)
Description of the Disable Theft Protection Action (actiontypedesc)
Action ID of the Disable Theft Protection Action (eaqid)
Disable Theft Protection Action Status (actionstatus)
Description of the Disable Theft Protection Action Status (actionstatusdesc)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.
Applies the Theft Protection Lock on the specified Order.
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| order-id | Integer | Required | Order Id of the Domain Registration Order on which the Theft Protection Lock to be applied. |
POST
https://test.httpapi.com/api/domains/enable-theft-protection.json?auth-userid=0&api-key=key&order-id=0
Returns a hash map containing the below details:
Domain Name (description)
Order ID of the Domain Registration Order (entityid)
Action Type (actiontype)
Description of the Enable Theft Protection Action (actiontypedesc)
Action ID of the Enable Theft Protection Action (eaqid)
Enable Theft Protection Action Status (actionstatus)
Description of the Enable Theft Protection Action Status (actionstatusdesc)
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.