Queue_GetInfo


Definition

Retrieve a list of all queues, which can be filtered as appropriate.

Usage

Use this command to retrieve a list of all queues, which can be filtered as appropriate.

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

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
Category Optional Filter by category 500
FilterTLD Optional Filter by TLD 500
FilterTLDStatusDesc Optional Filter by TLD status description 100
FilterQStatusName Optional Filter by queue status name 100
FilterExtAttributes Optional Filter by extended attributes requirement 1
FilterStartDate Optional Filter by queue start date -
FilterEndDate Optional Filter by queue end date -
DisplayComingSoon Optional Filter by queue availability -
ResponseType Optional Format of response. Permitted values are Text (default), HTML, or XML 4

 

Returned parameters and values

Parameter Description
TLD Top level domain
NativeIDN IDN TLD in native characters
CategoryName TLD category
CategoryDesc TLD category description
QID Queue indetifier
QName Queue name
QStatusID Queue status identifier
QStatusName Queue status name
ExtAttributes Does this Queue require extended attributes?
StartDate Start date
EndDate End date
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

  • If you submit this command without filter parameters, the server will return every TLD and queue for which you have a watchlist item. If you want to only receive the watchlist items for active queues, you must include the DisplayComingSoon=False parameter.
  • 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