TLD_AddWatchlist


Definition

Add a list of domain(s) to an existing the watchlist or create new watchlist with these domains. An empty watchlist cannot be created.

Usage

Use this command to add a list of domain(s) to an existing the watchlist or create new watchlist with these domains. An empty watchlist cannot be created.

LIST

You can create LIST(s) for organizing or managing watchlist domain names. Each LIST consist 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
.....

 

Operational/Logic Table:

ListID ListName ListEmail Result
No No - Error: ListID or ListName are required
No Yes No Error: Email Address is required if ListName is sent
No Yes Yes Create a new LIST and add domain(s). ListID will be automatically created and returned in the output
Yes - No Add domain(s) to specified LIST
Yes - Yes Add domain(s) to specified LIST and update email address

Note:

  • No = input parameter is not declared
  • Yes = input parameter is declared and has value
  • - = input parameter could be declared or not declared. Does not affect the end result

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 Watch Domains button calls the TLD_AddWatchlist 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
DomainList Required A comma-separated list of domains

Format:
blogging.ninja
*.ninja
blogging.*

International Domain Name (IDN) allows more web users to navigate the Internet in their preferred native language. Most domain names are registered in ASCII characters. The non-Latin scripts such as Chinese, Russian, Korean or other languages cannot be rendered in ASCII. IDN is fully supported in PUNY Code and URL Encoded format.

To get more information and conversion tool for PUNY Code, check the sites below:
- Verisign's IDN Tool: http://mct.verisign-grs.com
- RFC 3492: http://tools.ietf.org/html/rfc3492
4096
ListID Conditional; default is 0 List ID. See Operational/Logic table for conditional information Use the TLD_GetWatchlist with Action=GetListID command to retrieve LIST
ListName Conditional Name of the LIST (must be unique) 50
ListEmail Conditional Email address for the List 128
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
DomainName Domain name
Success Domain add status
ResultMessage Domain add message
FailCount Number of domain(s) failed to add to the Watchlist
SuccessCount Number of domain(s) successfully added to the Watchlist
TotalRecords Total number of domain(s) processed
Type Reserved for future implementation
ListID List ID. New number will be created whenever a new LIST is created
ListName List Name
ListEmail List Email Address
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