eelite

Reseller should be signed up for Enterprise Email US

Add or Delete a Business Email Account alisha.d@endur… Tue, 11/07/2017 - 12:16

You can buy more accounts or delete the existing email accounts from your Business Email package, from within the control panel.

Get DNS Records

Description

Gets the DNS records of an Business Email 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 Business Email Order

HTTP Method

GET

Example Test URL Request

US Server


https://test.httpapi.com/api/eelite/us/dns-record.json?auth-userid=0&api-key=key&order-id=0

Response

Returns an Array of hash map containing the below details of the DNS records associated with the Business Email Order:

  • Type of DNS Record (type)

  • Name or the Fully Qualified Domain Name associated with the DNS record (host)

  • Data of Type-specific relevance, such as the IP Address for Address Records or Hostname for MX records (value)

  • Class of the DNS Record (class)

Get Customer Pricing

Description

Use this method to get details of the Customer Pricing for the Business Email Plans.

Response

Returns a map with the prices of the Business Email Plans along with the prices of the other products.

The response structure for the Business Email will be:


"productkey":
{
"email_account_ranges":
{
"plan_specifications":
{
"action":
{
"tenure-in-months":price
}
}
}
}

Example:

US Server


"eeliteus":
{
"email_account_ranges":
{
"1-5":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
},
"6-25":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
}
"26-49":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
}
"50-200000":
{
"renew":
{
"6":100.0, "3":100.0, "12":100.0, "1":100.0
},
"add":
{
"6":100.0, "3":100.0, "1":100.0, "12":100.0
}
}
}
}

Search Orders

Description

Gets a list and details of the Business Email 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 Business Email Order(s) whose details need to be fetched
reseller-id Array of Integers Optional Reseller ID(s) of the Resellers whose Orders need to be fetched
customer-id Array of Integers Optional Customer ID(s) of the Customers 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 Domain name associated with the Business Email Order
creation-date-start String Optional UNIX TimeStamp for listing of the Business Email Orders whose Creation Date is greater than creation-date-start
creation-date-end String Optional UNIX TimeStamp for listing of the Business Email Orders whose Creation Date is less than creation-date-end
expiry-date-start String Optional UNIX TimeStamp for listing of the Business Email Orders whose expiry date is greater than expiry-date-start
expiry-date-end String Optional UNIX TimeStamp for listing of the Business Email 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/eelite/us/search.json?auth-userid=0&api-key=key&no-of-records=1&page-no=1

Response

Returns a hash map containing the below details of the Business Email Orders which match the search criteria:

  • Domain Name (entity.description)

  • Order Id (orders.orderid)

  • Customer Id (entity.customerid)

  • Order Addition Timestamp (orders.creationdt)

  • Order Creation Timestamp (orders.creationtime)

  • Expiry Timestamp (orders.endtime)

  • Current Order Status under the System (entity.currentstatus) - value will be InActive, Active, Suspended, Pending Delete Restorable, Deleted or Archived

  • Product Name (entitytype.entitytypename)

  • Product Key (entitytype.entitytypekey)

  • GEO Location (hosting_group_info.location)

Get Order Id cmu5 Mon, 05/12/2014 - 15:53

Description

Gets the associated Business Email 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/eelite/us/orderid.json?auth-userid=0&api-key=key&domain-name=domainname.com

Response

Returns the Order ID (Integer) associated with the specific domain name.

Get Details cmu5 Mon, 05/12/2014 - 15:52

Description

Gets the details of an existing Business Email 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 Order for which the details are to be fetched

HTTP Method

GET

Example Test URL Request

US Server


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

Response

Returns a hash map containing details of the Business Email Order as below:

  • Order Id (entityid)

  • Order Description (description)

  • Domain Name (domainname)

  • Current Order Status under the System (currentstatus) - value will be InActive, Active, Suspended, Pending Delete Restorable, Deleted or Archived

  • Product Category (productcategory)

  • Product Key (productkey)

  • Order Creation Date (creationtime)

  • Expiry Date (endtime)

  • Whether Order belongs to a Customer directly under the Reseller (isImmediateReseller)

  • Reseller Chain by Reseller Id (parentkey)

  • Customer Id Associated with the Order (customerid)

  • Number of Email Accounts (emailaccounts)

  • Whether Order Suspended due to Expiry (isOrderSuspendedUponExpiry)

  • Whether Order Suspended by Parent Reseller (orderSuspendedByParent)

  • Whether Order Deletion is Allowed (allowdeletion)

Delete cmu5 Mon, 05/12/2014 - 15:51

Description

Deletes an existing Business Email 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 Order which is to be deleted

HTTP Method

POST

Example Test URL Request

US Server


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

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order Id of the Business Email Order (entityid)

  • Action Id of the Order Unsuspension Action (eaqid)

  • Action Type (actiontype)

  • Description of the Order Deletion Action (actiontypedesc)

  • Order Deletion Action Status (actionstatus)

  • Description of the Order Deletion Action Status (actionstatusdesc)

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

Unsuspend cmu5 Mon, 05/12/2014 - 15:50

Please wait while you are redirected ....

Suspend cmu5 Mon, 05/12/2014 - 15:49

Please wait while you are redirected ....

Subscribe to eelite