rhlinux

True if reseller signed up for any RH Linux Product (US or IN or UK)

Get Reseller Pricing

Description

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

Response

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

The response structure for the Reseller Linux Hosting product will be:


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

Example:

US Server


"resellerhosting":
{
"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


"resellerhostinglinuxuk":
{
"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


"resellerhostinglinuxin":
{
"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


"resellerhostinglinuxtr":
{
"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
}
}
}

Get Customer Pricing

Description

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

Response

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

The response structure for the Reseller Linux Hosting product will be:


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

Example:

US Server


"resellerhosting":
{
"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


"resellerhostinglinuxuk":
{
"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


"resellerhostinglinuxin":
{
"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


"resellerhostinglinuxtr":
{
"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
}
}
}

Get Modify/Upgrade Price

Description

Gets the applicable modify/upgrade price for a particular Reseller 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 Order ID 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 Server


https://test.httpapi.com/api/resellerhosting/linux/us/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/resellerhosting/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/resellerhosting/linux/in/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/resellerhosting/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 Reseller Linux 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 Reseller 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 Reseller 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 Reseller Linux Hosting Order.
creation-date-start String Optional UNIX TimeStamp for listing of the Reseller Linux Hosting Orders whose Creation Date is greater than creation-date-start.
creation-date-end String Optional UNIX TimeStamp for listing of the Reseller Linux Hosting Orders whose Creation Date is less than creation-date-end.
expiry-date-start String Optional UNIX TimeStamp for listing of the Reseller Linux Hosting Orders whose expiry date is greater than expiry-date-start.
expiry-date-end String Optional UNIX TimeStamp for listing of the Reseller 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 orderid; it will fetch the second batch of 30 Orders sorted by orderid.

HTTP Method

GET

Example Test URL Request

US Server


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

UK Server


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

India Server


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

Turkey Server


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

Response

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

Get Order Id

Description

Gets the associated Reseller 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 Server


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

UK Server


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

India Server


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

Turkey Server


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

Response

Returns the associated Reseller Linux Hosting Order ID (Integer) of the domain name.

Get Plan Details

Description

Use this method to get details of your plans.

Response

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

Example:

The response structure for the Reseller Linux Hosting product will be:

US Server


resellerhosting

{

"plan-id(value)"

{

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

}

}

UK Server


resellerhostinglinuxuk

{

"plan-id(value)"

{

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

}

}

India Server


resellerhostinglinuxin

{

"plan-id(value)"

{

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

}

}

Turkey Server


resellerhostinglinuxtr

{

"plan-id(value)"

{

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

}

}

Get Details

Description

Gets the details of an existing Reseller 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 Order ID for which the details to be fetched.

HTTP Method

GET

Example Test URL Request

US Server


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

UK Server


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

India Server


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

Turkey Server


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

Response

Returns the details of an existing Reseller Linux Hosting Order.

Delete

Description

Deletes an existing Reseller 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 Order ID which is to be deleted.

HTTP Method

POST

Example Test URL Request

US Server


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

UK Server


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

India Server


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

Turkey Server


https://test.httpapi.com/api/resellerhosting/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.

Add Dedicated IP

Description

Adds a dedicated IP for an existing Reseller 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 Order ID for which a dedicated IP to be added.
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 Server


https://test.httpapi.com/api/resellerhosting/linux/us/add-dedicated-ip.json?auth-userid=0&api-key=key&order-id=0&invoice-option=NoInvoice

UK Server


https://test.httpapi.com/api/resellerhosting/linux/uk/add-dedicated-ip.json?auth-userid=0&api-key=key&order-id=0&invoice-option=NoInvoice

India Server


https://test.httpapi.com/api/resellerhosting/linux/in/add-dedicated-ip.json?auth-userid=0&api-key=key&order-id=0&invoice-option=NoInvoice

Turkey Server


https://test.httpapi.com/api/resellerhosting/linux/tr/add-dedicated-ip.json?auth-userid=0&api-key=key&order-id=0&invoice-option=NoInvoice

Response

Returns a map of the execution details of the adding dedicated IP operation.

Modify/Upgrade

Description

Modifies/upgrades an existing Reseller Linux 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 Order ID 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 Server


https://test.httpapi.com/api/resellerhosting/linux/us/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/resellerhosting/linux/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/resellerhosting/linux/in/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/resellerhosting/linux/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.