reseller

is added when reseller has a customer specific business

Search Orders

Description

Gets a list and details of the Multi Domain Windows 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 Windows 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 Domain Windows Hosting Order.
creation-date-start String Optional UNIX TimeStamp for listing of the Multi Domain Windows Hosting Orders whose Creation Date is greater than creation-date-start.
creation-date-end String Optional UNIX TimeStamp for listing of the Multi Domain Windows Hosting Orders whose Creation Date is less than creation-date-end.
expiry-date-start String Optional UNIX TimeStamp for listing of the Multi Domain Windows Hosting Orders whose expiry date is greater than expiry-date-start.
expiry-date-end String Optional UNIX TimeStamp for listing of the Multi Domain Windows 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/windows/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/windows/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/windows/uk/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1

India Server


https://test.httpapi.com/api/multidomainhosting/windows/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/windows/hk/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1

Turkey Server


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

Response

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

Getting Order Id

Description

Gets the associated Multi Domain Windows 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/windows/us/orderid.json?auth-userid=0&api-key=key&domain-name=domainname.asia

US, California Server


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

UK Server


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

India Server


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

Hong Kong Server


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

Turkey Server


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

Response

Returns the associated Multi Domain Windows 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 Windows Hosting product along with the plan details of other Products of the reseller.

Example:

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

US, Texas Server


multidomainhostingwindows

{

"plan-id(value)"

{

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

}

}

US, California Server


multidomainwindowshostingusca

{

"plan-id(value)"

{

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

}

}

UK Server


multidomainwindowshostinguk

{

"plan-id(value)"

{

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

}

}

India Server


multidomainwindowshostingin

{

"plan-id(value)"

{

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

}

}

Hong Kong Server


multidomainwindowshostinghk

{

"plan-id(value)"

{

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

}

}

Turkey Server


multidomainwindowshostingtr

{

"plan-id(value)"

{

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

}

}

Getting Details

Description

Gets the details of an existing Multi Domain Windows 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 to be fetched.

HTTP Method

GET

Example Test URL Request

US, Texas Server


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

US, California Server


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

UK Server


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

India Server


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

Hong Kong Server


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

Turkey Server


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

Response

Returns the details of an existing Multi Domain Windows Hosting order.

Delete

Description

Deletes an existing Multi Domain Windows 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/windows/us/delete.json?auth-userid=0&api-key=key&order-id=0

US, California Server


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

UK Server


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

India Server


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

Hong Kong Server


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

Turkey Server


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

Response

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

Enable SSL

Description

Enables SSL for an existing Multi Domain Windows Hosting Order. To learn more, click here.

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 SSL needs to be enabled.
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

US, Texas Server


https://test.httpapi.com/api/multidomainhosting/windows/us/enable-ssl.json?auth-userid=0&api-key=key&order-id=0&invoice-option=NoInvoice

US, California Server


https://test.httpapi.com/api/multidomainhosting/windows/us/ca/enable-ssl.json?auth-userid=0&api-key=key&order-id=0&invoice-option=NoInvoice

UK Server


https://test.httpapi.com/api/multidomainhosting/windows/uk/enable-ssl.json?auth-userid=0&api-key=key&order-id=0&invoice-option=NoInvoice

India Server


https://test.httpapi.com/api/multidomainhosting/windows/in/enable-ssl.json?auth-userid=0&api-key=key&order-id=0&invoice-option=NoInvoice

Hong Kong Server


https://test.httpapi.com/api/multidomainhosting/windows/hk/enable-ssl.json?auth-userid=0&api-key=key&order-id=0&invoice-option=NoInvoice

Turkey Server


https://test.httpapi.com/api/multidomainhosting/windows/tr/enable-ssl.json?auth-userid=0&api-key=key&order-id=0&invoice-option=NoInvoice

Response

Returns a map of the execution details of the enabling of SSL operation.

Modify/Upgrade

Description

Modifies/upgrades an existing Multi Domain Windows Hosting order.

Parameters

Name Data Type Required / Optional
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required The OrderId which is to be modified.
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 modified.
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

US, Texas Server


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

US, California Server


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

UK Server


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

India Server


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

Hong Kong Server


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

Turkey Server


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

Response

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

Renew

Description

Renews an existing Multi Domain Windows 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 renewed.
months Integer Required The number of months for which the Order is to be renewed.
enable-ssl Boolean Optional Values can be: true or false (default). To learn more, click here.
auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the Order.

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

US, Texas Server


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

US, California Server


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

UK Server


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

India Server


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

Hong Kong Server


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

Turkey Server


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

Response

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

Add

Description

Places a Multi Domain Windows Hosting 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 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 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.
enable-ssl Boolean Optional Values can be: true or false (default). To learn more, click here.
auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the Order.

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

US, Texas Server


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

US, California Server

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

UK Server


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

India Server


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

Hong Kong Server


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

Turkey Server


https://test.httpapi.com/api/multidomainhosting/windows/tr/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 map with the execution details of the Order addition.