TLD_GetWatchlist


Definition

Retrieve a list of domains currently in a Watchlist LIST in this account.

Usage

Use this command to retrieve a list of domains currently in a Watchlist LIST in this account.

LIST

You can create LIST(s) for organizing or managing watchlist domain names. Each LIST consists of a ListID, ListName and ListEmail.

Each account has a default LIST (ListID=0 ), containing domains to watch. Domains can appear in multiple LISTS. The default LIST cannot be deleted and email address cannot be changed.

Example:

ListID=0 ListID=1 ListID=2
*.ninja
.art
.education
one.ceo
one.ninja
two.ceo
two.ninja .....
one.ceo
one.ninja
one.fun
.....
two.ceo
two.ninja
two.fun
.....

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/tlds/watchlist.aspx

The My Watchlist tab calls the TLD_GetWatchlist command.

Constraints

The query must meet the following requirements:

  • The login ID and password must be valid.

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
Action Optional
default is Empty
This parameter determines which result set will be provided. If this parameter is not declared, or has no value, the API will return a list of all of the domains in the specified LIST. Set the parameter to GetListIDs to retreive a list of all of the LISTs for this account. Check the example section see the differences. Permitted values are: Empty (not declared) GetListIDs
ListID Optional Return only those domain(s) belonging to a specific LIST. Not declaring this parameter will result in the domains returned from the default LIST (ListID=0).
SortBy Optional
default is DomainName
Sorting parameter. Permitted values are:
WatchID
DomainName
SLD
TLD
TLDCategory
20
SortByDirection Optional
default is Asc
Sorting order. Permitted values are: Asc Desc 4
StartPosition Optional
default is 1
Return results beginning with this position in the sorted list For example, StartPosition=26&PagingPageSize=25 returns results 26 through 50 in the sorted list
PagingPageSize Optional default is 25 Number of results to return in this response
SLD Optional Filter by SLD 275
TLD Optional Filter by TLD 15
Category Optional Filter by Category 500
DomainNameFilter Optional Filter by Domain Name. When present, this will filter the result set according to the text supplied. This parameter is similar to using the LIKE clause in SQL to generate a result set based on the input string. For example, if the string is ion, the results may include mydomain.auction, *.auction, ion-drive.ceo, ion-drive.*, etc. 300
ResponseType Optional Format of response. Permitted values are Text (default), HTML, or XML 4

 

Returned parameters and values

Parameter Description
ID Watchlist Item ID for each domain name
DomainName Domain name
SLD SLD value
TLD TLD value
NativeIDN Domain name in Native IDN format
StatusID Status ID for this specific domain
StatusDesc Status description for this specific domain
SubStatusID Sub-Status ID for this specific domain
SubStatusDesc Sub-Status description for this specific domain
TLDCategory TLD Primary Category
TLDCategoryDesc TLD Category description
TLDStatusID Status ID for this specific TLD
TLDStatusDesc Status description for this specific TLD
ListID List ID
ListName List Name
ListEmail List Email Address
SortBy Sort By value
SortByDirection Sort By Direction type
StartPosition Start Position value
PagingPageSize Paging Page Size value
FilterByDomainName Filter by Domain Name value
FilterBySLD Filter by SLD value
FilterByTLD Filter by TLD value
FilterByTLDCategory Filter by TLD Category value
RecordsCount Records return in one page for this request
TotalRecords Total records for this type of request
AllRecords All records for this account
Command Name of command executed
ErrCount The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
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 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