reseller

is added when reseller has a customer specific business

Associating/Dissociating .XXX Membership Token/ID

Description

Allows associating/dissociating the Membership Token/ID provided by the .XXX Registry, to a Domain Registration Order.

Parameters

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 .XXX Domain Registration Order, to which you want to associate/dissociate a Membership
Token/ID. See details
association-id String Optional

A Membership Token/ID allocated by the .XXX Registry needs to be associated with the domain name, only if the Registrant wants it to resolve.

If a Membership Token/ID is already associated with a .XXX domain name, then sending this value as blank, dissociates it.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/domains/dotxxx/association-details.xml?auth-userid=0&api-key=key&order-id=123&association-id=123

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the Domain Registration Order (entityid)

  • Action ID of the Modification of Association/Dissociation Details Action (eaqid)

  • Description of the Modification of Association/Dissociation Details Action (actiontypedesc)

  • Modification of Association/Dissociation Details Action Status (actionstatus)

  • Description of the Modification of Association/Dissociation Details Action Status (actionstatusdesc)

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

Getting the DNS Records

Description

Gets the DNS records to manage the Domain Forwarding service.

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 whose DNS Records need to be fetched

HTTP Method

GET

Example Test URL Request

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

Response

Returns a list of maps containing the DNS Records.

Getting Reseller Pricing

Description

Use this method to get details of the pricing for the Multi Domain Linux Hosting plans for your Sub-Resellers.

Response

Returns a map with the prices of the Multi Domain Linux Hosting plans along with the prices of the other products.

The response structure for the Multi Domain Linux Hosting will be:


"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}

Example:

US, Texas Server


"multidomainhosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

US, California Server


"multidomainhostinglinuxusca":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

UK Server


"multidomainhostinglinuxuk":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

India Server


"multidomainhostinglinuxin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Hong Kong Server


"multidomainhostinglinuxhk":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Turkey Server


"multidomainhostinglinuxtr":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Getting Customer Pricing

Description

Use this method to get details of the pricing for the Multi Domain Linux Hosting plans.

Response

Returns a map with the prices of the Multi Domain Linux Hosting plans along with the prices of the other products.

The response structure for the Multi Domain Linux Hosting will be:


"productkey":
{
"planid":
{
"action":
{
"tenure-in-months":price
},
"ssl":price
}
}

Example:

US, Texas Server


"multidomainhosting":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

US, California Server


"multidomainhostinglinuxusca":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

UK Server


"multidomainhostinglinuxuk":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

India Server


"multidomainhostinglinuxin":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Hong Kong Server


"multidomainhostinglinuxhk":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Turkey Server


"multidomainhostinglinuxtr":
{
"1":
{
"renew":
{
"3":0.0,
"12":0.0
},
"ssl":0.0,
"add":
{
"3":0.0,
"12":0.0
}
},
"2":
{
"renew":
{
"3":0.0,
"12":0.0
},
"add":
{
"3":0.0,
"12":0.0
}
}
}

Search

Description

Gets details of the Customers that match the Search criteria.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
no-of-records Integer Required Number of records to be fetched. This should be a value between 10 to 500.
page-no Integer Required Page number for which details are to be fetched
customer-id Array of Integers Optional Customer Id(s)
reseller-id Array of Integers Optional Reseller Id of sub-reseller(s) for whom Customer accounts need to be searched
username String Optional Username of Customer. Username should be an email address.
name String Optional Name of Customer
company String Optional Company name of Customer
city String Optional City
state String Optional State
status String Optional Status of Customer. Values can be Active, Suspended and Deleted.
creation-date-start String Optional UNIX TimeStamp for listing of Customer accounts whose Creation Date is greater than creation-date-start
creation-date-end String Optional UNIX TimeStamp for listing of Customer accounts whose Creation Date is less than creation-date-end
total-receipt-start Float Optional Total receipts of Customer which is greater than total-receipt-start
total-receipt-end Float Optional Total receipts of Customer which is less than total-receipt-end

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/customers/search.json?auth-userid=0&api-key=key&no-of-records=10&page-no=1

Response

Returns a hash map containing the below details of the Customers that match the search criteria:

  • Number of Customers requested matching the search criteria (recsonpage)

    Following details of each Customer:

    • Customer Id (customer.customerid)

    • Customer Username (customer.username)

    • Reseller Id of the Parent Reseller (customer.resellerid)

    • Name (customer.name)

    • Company (customer.company)

    • City (customer.city)

    • State (customer.state)

    • Country Code (customer.country)

    • Current Status (customer.customerstatus)

    • Total Receipts (customer.totalreceipts)

  • Number of Customers in the System matching the search criteria (recsindb)

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

Getting Modify/Upgrade Price

Description

Gets the applicable modify/upgrade price for a particular Multi Domain Linux Hosting 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 OrderId for which the details are to be fetched.
new-plan-id Integer Required The new plan to which the Order is to be upgraded/downgraded. To fetch the plan details: plan-id etc., use this method.
months Integer Required The number of months (tenure) in the new plan for which the Order to be placed.

HTTP Method

GET

Example Test URL Request


US, Texas Server


https://test.httpapi.com/api/multidomainhosting/linux/us/modify-pricing.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0

US, California Server


https://test.httpapi.com/api/multidomainhosting/linux/us/ca/modify-pricing.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0

UK Server


https://test.httpapi.com/api/multidomainhosting/linux/uk/modify-pricing.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0

India Server


https://test.httpapi.com/api/multidomainhosting/linux/in/modify-pricing.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0

Hong Kong Server


https://test.httpapi.com/api/multidomainhosting/linux/hk/modify-pricing.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0

Turkey Server


https://test.httpapi.com/api/multidomainhosting/linux/tr/modify-pricing.json?auth-userid=0&api-key=key&order-id=0&new-plan-id=0&months=0

Response

Returns the applicable modify/upgrade price for a particular Multi Domain Hosting Order.

Example:


{
"upgradecost":0.0,
"modifiedOrderPrice":0.0,
"endtime":"0000000000",
"remainingmonths":0,
"currentOrderPrice":0.0
}

where

  • currentOrderPrice: The current pricing of the Order for remaining months.

  • modifiedOrderPrice: New applicable pricing of the Order as per the new plan.

  • upgradecost: Actual price applicable i.e. modifiedOrderPrice - currentOrderPrice

Search Orders

Description

Gets a list and details of the Multi Domain Linux Hosting Orders matching the search criteria.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
no-of-records Integer Required Number of Orders to be fetched.
page-no Integer Required Page number for which details are to be fetched.
order-id Array of Integers Optional Order Id(s) of the Multi Domain Linux Hosting Order(s) whose details need to be fetched.
reseller-id Array of Integers Optional Reseller Id(s) whose Orders need to be fetched.
customer-id Array of Integers Optional Customer Id(s) whose Orders need to be fetched.
show-child-orders Boolean Optional Whether Sub-Reseller Orders need to be fetched or not.
status Array of Strings Optional Status of the Order: Active, InActive, Deleted, etc.
domain-name String Optional Name of the Domain of the Multi Linux Domain Hosting Order.
creation-date-start String Optional UNIX TimeStamp for listing of the Multi Domain Linux Hosting Orders whose Creation Date is greater than creation-date-start.
creation-date-end String Optional UNIX TimeStamp for listing of the Multi Domain Linux Hosting Orders whose Creation Date is less than creation-date-end.
expiry-date-start String Optional UNIX TimeStamp for listing of the Multi Domain Linux Hosting Orders whose expiry date is greater than expiry-date-start.
expiry-date-end String Optional UNIX TimeStamp for listing of the Multi Domain Linux Hosting Orders whose expiry date is less than expiry-date-end.
order-by Array of Strings Optional One or more parameters by which you want to sort the Orders. Default is orderid.

Example:

If page-no is 1, no-of-records is 30 and order-by is orderid; it will fetch the first 30 Orders which suit the search criteria sorted by orderid.
If page-no is 2, no-of-records is 30 and order-by is order id; it will fetch the second batch of 30 Orders sorted by orderid

HTTP Method

GET

Example Test URL Request


US, Texas Server


https://test.httpapi.com/api/multidomainhosting/linux/us/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1

US, California Server


https://test.httpapi.com/api/multidomainhosting/linux/us/ca/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1

UK Server


https://test.httpapi.com/api/multidomainhosting/linux/uk/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1

India Server


https://test.httpapi.com/api/multidomainhosting/linux/in/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1

Hong Kong Server


https://test.httpapi.com/api/multidomainhosting/linux/hk/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1

Turkey Server


https://test.httpapi.com/api/multidomainhosting/linux/tr/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1

Response

Returns the list of the Multi Domain Linux Hosting Orders which match the search criteria.

Getting Order Id

Description

Gets the associated Multi Domain Linux Hosting 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

US, Texas Server


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

US, California Server


https://test.httpapi.com/api/multidomainhosting/linux/us/ca/orderid.json?auth-userid=0&api-key=key&domain-name=domainname.asia

UK Server


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

India Server


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

Hong Kong Server


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

Turkey Server


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

Response

Returns the associated Multi Domain Linux Hosting Order Id (Integer) of the domain name.

Getting Plan Details

Description

Use this method to get details of your plans.

Response

Returns the details of the plans of Multi Domain Linux Hosting product along with the plan details of other Products of the reseller.

Example:

The response structure for the Multi Domain Linux Hosting will be:

US, Texas Server


multidomainhosting

{

"plan-id(value)"

{

"plan details keys" => "plan details values"

}

}

US, California Server


multidomainhostinglinuxusca

{

"plan-id(value)"

{

"plan details keys" => "plan details values"

}

}

UK Server


multidomainhostinglinuxuk

{

"plan-id(value)"

{

"plan details keys" => "plan details values"

}

}

India Server


multidomainhostinglinuxin

{

"plan-id(value)"

{

"plan details keys" => "plan details values"

}

}

Hong Kong Server


multidomainhostinglinuxhk

{

"plan-id(value)"

{

"plan details keys" => "plan details values"

}

}

Turkey Server


multidomainhostinglinuxtr

{

"plan-id(value)"

{

"plan details keys" => "plan details values"

}

}

Delete

Description

Deletes an existing Multi Domain Linux Hosting 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 OrderId which is to be deleted.

HTTP Method

POST

Example Test URL Request

US, Texas Server


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

US, California Server


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

UK Server


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

India Server


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

Hong Kong Server


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

Turkey Server


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

Response

Returns a map of the execution details of the delete operation.