sitelock

Reseller should be signed up for the SiteLock product

Search Orders

Description

Gets a list and details of the SiteLock 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 SiteLock Order(s) whose details need to be fetched
reseller-id Array of Integers Optional Reseller ID(s) whose SiteLock Orders need to be fetched
customer-id Array of Integers Optional Customer ID(s) whose SiteLock 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, Suspended or Deleted
domain-name String Optional Name of the Domain of the SiteLock Order
creation-date-start String Optional UNIX TimeStamp for listing of the SiteLock Orders whose Creation Date is greater than creation-date-start
creation-date-end String Optional UNIX TimeStamp for listing of the SiteLock Orders whose Creation Date is less than creation-date-end
expiry-date-start String Optional UNIX TimeStamp for listing of the SiteLock Orders whose expiry date is greater than expiry-date-start
expiry-date-end String Optional UNIX TimeStamp for listing of the SiteLock 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


https://test.httpapi.com/api/sitelock/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 SiteLock Orders which match the search criteria:

  • Domain Name (entity.description)

  • Order Id (orders.orderid)

  • Customer Id (entity.customerid)

  • Order Creation Timestamp (orders.creationtime)

  • Order Expiry Timestamp (orders.endtime)

  • Current Order Status (entity.currentstatus) - value will be InActive, Active, Suspended or Deleted

  • Product Name (entitytype.entitytypename)

  • Product Key (entitytype.entitytypekey)

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

Get Order Id

Description

Gets the associated SiteLock 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


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

Response

Returns the associated SiteLock Order ID (Integer) of the domain name.

Get Plan Details

Description

Use this method to get details of your plans.

Response

Returns details of the plans of the SiteLock product, along with the plan details of other Products of the Reseller.

Example:

The response structure for the SiteLock product will be:

"sitelock":
	{
		"plan-id":
			{
				"plan_features":
					[
						"feature1",
						"feature2",
						"feature3",
						"feature4"
					],
				"plan_name":"Plan Name",
				"plan_status":"(Active or Paused)"
			},
	},

Get Details

Description

Gets the details of an existing SiteLock 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


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

Response

Returns a hash map containing the below details:

  • Order ID (entityid)

  • Order Description (description)

  • Domain Name (domainname)

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

  • Product key (productkey)

  • Product Category (productcategory)

  • Order Creation Date (creationtime)

  • Expiry Date (endtime)

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

  • Reseller Chain by RID (parentkey)

  • Customer ID Associated with the Order (customerid)

  • Whether Order Suspended due to Expiry (isOrderSuspendedUponExpiry)

  • Whether Order Suspended by Parent Reseller (orderSuspendedByParent)

  • Whether Order Deletion is Allowed (allowdeletion)

  • Plan ID of the SiteLock Plan (planid)

  • Status of the SiteLock Plan (paused)

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

Delete

Description

Deletes an existing SiteLock 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


https://test.httpapi.com/api/sitelock/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 SiteLock Order (entityid)

  • Action Type (actiontype)

  • Description of the SiteLock Order Delete Action (actiontypedesc)

  • Action ID of the SiteLock Order Delete Action (eaqid)

  • SiteLock Order Delete Action Status (actionstatus)

  • Description of the SiteLock Order Delete Action Status (actionstatusdesc)

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

Renew

Description

Renews an existing SiteLock 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 renewed
auto-renew Boolean Required

Enables / Disables the Auto Renewal setting for the Order

Note

Auto-Renewal
invoice-option String Required This parameter will decide how the Customer's Invoice will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice or OnlyAdd.

HTTP Method

POST

Example Test URL Request


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

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the SiteLock Order (entityid)

  • Action Type (actiontype)

  • Description of the SiteLock Order Renew Action (actiontypedesc)

  • Action ID of the SiteLock Order Renew Action (eaqid)

  • SiteLock Order Renew Action Status (actionstatus)

  • Description of the SiteLock Order Renew Action Status (actionstatusdesc)

  • Invoice ID of the SiteLock Order Renew Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Customer ID associated with the SiteLock Order (customerid)

Note

invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

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

Add

Description

Places a SiteLock 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 to be placed
customer-id Integer Required The Customer under whom the Order should be added
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.
auto-renew Boolean Optional

Enables / Disables the Auto Renewal setting for the Order

Note

Auto-Renewal
invoice-option String Required This parameter will decide how the Customer's Invoice will be handled. Values can be: NoInvoice, PayInvoice, KeepInvoice or OnlyAdd.

HTTP Method

POST

Example Test URL Request


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

Response

Returns a hash map containing the below details:

  • Domain Name (description)

  • Order ID of the SiteLock Order (entityid)

  • Action Type (actiontype)

  • Description of the SiteLock Order Add Action (actiontypedesc)

  • Action ID of the SiteLock Order Add Action (eaqid)

  • SiteLock Order Add Action Status (actionstatus)

  • Description of the SiteLock Order Add Action Status (actionstatusdesc)

  • Invoice ID of the SiteLock Order Add Invoice (invoiceid)

  • Selling Currency of the Reseller (sellingcurrencysymbol)

  • Transaction Amount in the Selling Currency (sellingamount)

  • Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)

  • Customer ID associated with the SiteLock Order (customerid)

Note

invoiceid, sellingcurrencysymbol, sellingamount, unutilisedsellingamount and customerid will not be returned if invoice-option is set to NoInvoice.

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

Subscribe to sitelock