![]() |
mdhlinux
True if reseller signed up for any MDH Linux Product (US or IN or UK)
Getting Details
Description
Gets the details of 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 for which the details to be fetched. |
HTTP Method
GET
Example Test URL Request
US, Texas Server
https://test.httpapi.com/api/multidomainhosting/linux/us/details.json?auth-userid=0&api-key=key&order-id=0
India Server
https://test.httpapi.com/api/multidomainhosting/linux/in/details.json?auth-userid=0&api-key=key&order-id=0
Response
Returns the details of an existing Multi Domain Linux Hosting order.
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
}
}
}
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
}
}
}
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
}
}
}
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
}
}
}
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
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
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. |
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
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
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
India Server
https://test.httpapi.com/api/multidomainhosting/linux/in/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"
}
}
India Server
multidomainhostinglinuxin
{
"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
India Server
https://test.httpapi.com/api/multidomainhosting/linux/in/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 Linux 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/linux/us/enable-ssl.json?auth-userid=0&api-key=key&order-id=0&invoice-option=NoInvoice
India Server
https://test.httpapi.com/api/multidomainhosting/linux/in/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.
