Queue_GetDomains


Definition

Retrieve a list of domains currently in the specified queue for the account.

Usage

Use this command to retrieve a list of domains currently in the specified queue in the account.

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/tld-queue/pages/manage/preorders.aspx

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
DisplayMetrics Optional; dafault is true Display queue domain's metric. Permitted values are true and false 1
DisplayDomains Optional; dafault is false Display a list of domains. Permitted values are true and false 1
RecordStart 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
PagingSize Optional default is 25 Number of accounts to return in this response. Maximum permitted value is 500. 3
SortBy Optional Sorting parameter. Permitted values are: DomainName TLD Price 20
SortOrder Optional; default is Asc Sort order. Permitted values are Asc and Desc 4
FilterTLD Optional Filter by TLD 15
FilterQueue Optional Filter by Queue 15
FilterStatus Optional Filter by Status ID 3
FilterStatusDesc Optional Filter by Status Description 500
DomainNameFilter Optional Filter by domain name, contains specific word 500
ResponseType Optional Format of response. Permitted values are Text (default), HTML, or XML 4

 

Returned parameters and values

Parameter Description
WatchlistTotal Total items in Watchlist (not a distinct list). For example, domain.ninja and .ninja are counted as two (2) entries
WatchlistPreorder Total items in Watchlist available for Pre-Order
WathclistDomainWatched Total domains (SLD.TLD) watched
WatchlistTLDWatched Total TLD watched
NewTLDOrders Number of orders entered to the Queue
NewTLDValidated Number of orders have been Validated
NewTLDPending Number of orders in Pending status
NewTLDRejected Number of orders in Rejected status
QueuesDisabled Is Queue disabled for this account?
PreregDisabled Is PreRegistration disabled for this account?
OrderID Order ID
DomainName Domain name
TLDID TLD ID
TLDName TLD name
TLDDesc TLD description
DateStart Queue opening date
DateEnd Queue closing date
Price Price
QID Queue ID
QName Queue name
StatusID Status ID
StatusName Status name
ItemCount Total items return in this search (filter)
ItemTotal Total items in 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