SL_GetAccounts


Definition

Retrieve a list of SiteLock subscriptions for this login ID.

Usage

Use this command to retrieve a list of SiteLock subscriptions for this login ID.

Availability

All resellers have access to this command

Implementation on eNom.com

Log on to resellertest.enom.com with Login ID resellid, password resellpw.

https://resellertest.enom.com/web-site-lock/manage.aspx

Constraints

The query must meet the following requirements:

  • The login ID and password must be valid.
  • The SiteLock subscription must belong to this account.

Input parameters

Build the query string using this syntax:

https://resellertest.enom.com/interface.asp?
command=nameofcommand&uid=yourloginid&pw=yourpassword &paramname=paramvalue&nextparamname=nextparamvalue

 

Parameter Status Description Max Size
UID Required Account login ID. 20
PW Required Account password. 20
ProdType Optional Product identification number. Permitted values are:
260: SiteLock Basic
262: SiteLock Premium
264: SiteLock Enterprise
3
StartPosition Optional;
default is 1
Return results beginning with this position in the sorted list. For example, StartPosition=26&PagingPageSize=25 returns accounts 26 through 50 in the sorted list. 8
PagingPageSize Optional;
default is 25
Number of accounts to return in this response. Maximum permitted value is 250. 3
SortBy Optional;
default is DomainName
Sorting parameter. Permitted values are:
DomainName
StatusID
StatusDesc
SubStatusID
SubStatusDesc
AutoRenew
SLID
ProdType
ProdDesc
OrderDate
ExpirationDate
255
SortByDirection Optional;
default is Asc
Sort order. Permitted values are:
Asc
Desc
128
StatusID, StatusDesc, SubStatusID or SubStatusDesc Optional To retrieve information about all possible statuses for this product, use the GetProductSelectionlist command.

StatusID/StatusDesc. Permitted values are:
1: Awaiting Configuration
2: Service Active
7: Pending Expiration
8: Service Expired

SubStatusID/SubStatusDesc. Permitted values are:
1: Auto Renew Off
2: Billing Failed CC
3: Billing Failed Balance
4/50
AutoRenew Optional Auto Renew. Permitted values are:
True: subscriptions with automatic renewal
False: subscriptions without automatic renewal
4
DomainNameContains Optional Specific word in domain names. 300
OrderDateStart Optional Order date start filter. Use format MM/DD/YYYY.
OrderDateEnd Optional Order date end filter. Use format MM/DD/YYYY.
ExpirationDateStart Optional Expiration date start filter. Use format MM/DD/YYYY.
ExpirationDateEnd Optional Expiration date end filter. Use format MM/DD/YYYY.
ResponseType Optional Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
Command Name of command executed
ErrCount The number of errors if any occurred. If greater than 0, check the Err(1 to ErrCount)
ErrX Error messages explaining the failure. These can be presented as-is back to the client.
Done True indicates this entire response has reached you successfully.

 

Notes

  • The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
  • Check the return parameter rameter ErrCount If greater than 0, the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise, process the returned parameters as defined above.

Example