TLD_DeleteWatchlist


Definition

Delete a set of domains from a LIST or delete an entire LIST from the watchlist. Deleting all domains in a LIST does not delete the LIST

Usage

Use this command to delete a set of domains from a LIST or delete an entire LIST from the watchlist. Deleting all domains in a LIST does not delete the LIST

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
.....

 

Operational/Logic Table:

Action WatchlistItemID ListID Result
DeleteList - No Error: ListID must be supplied
DeleteList - Yes Delete the LIST and all domains in it
DeleteListItem No - Error: WatchlistItemID must be supplied
DeleteListItem Yes No Delete WatchlistItemID(s) in the default account (ListID=0)
DeleteListItem Yes Yes Delete WatchlistItemID(s) in the specified ListID

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 Delete button calls the TLD_DeleteWatchlist 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 Required Type of delete operation. Permitted values are:
DeleteList
DeleteListItem
8
ListID Required The ID for a specified LIST in the account. See Operational/Logic table for conditional information. Use the TLD_GetWatchlist with Action=GetListIDs command to retrieve the LIST
WatchlistItemID Conditional A comma-separated list of WatchlistItemID. Use the TLD_GetWatchlist command to retrieve these IDs
ResponseType Optional Format of response. Permitted values are Text (default), HTML, or XML 4

 

Returned parameters and values

Parameter Description
ID WatchlistItemID for each domain name
DomainName Domain name
Success Success status for deleting domain name from the Watchlist
ResultMessage Message returned from the processing system
Type Reserved for future implementation
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
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