GetDomains


Definition

Get a single page of domain names with the ability to load the next or previous page of names.

Usage

Use this command to list a single page of domains in an account. GetAllDomains is our older command for large accounts. GetAllDomains, a similar command, returns the complete list of domain names in an account but can time out for accounts with more than 200 domain names. AdvancedDomainSearch is the most up-to-date command for accounts of all sizes.

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/myaccount/

In the my enom section, the x domain names link calls the GetDomains 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
Tab Optional; default is IOwn The type of domains to return. Permitted values are:
IOwn current names in this account
Sub_IOwn names in retail subaccounts
WatchList names in this account’s watchlist
IHost DNS hosting names, this account
ExpiringNames names nearing expiration
ExpiredDomains expired but able to renew
RGP RGP and Extended RGP names
Promotion names on promotional basis
10
DaysToExpired Optional with Tab=ExpiringNames Return names that expire with in this number of days, whether they are set to auto-renew or not 4
RegStatus Optional with Tab=Sub_IOwn; default is Registered The type of domains to return for a subaccount. Permitted values are Registered and Expired. 10
Display Optional; default is 25 Number of domains to return in one response. Permitted values are 0 to 100. 4
Start Optional; default is 1 Return names that start with this number in the sorted list. For example, Display=25&Start=26 returns the 26th through 50th names from a numero-alphabetically sorted list. 4
OrderBy Optional The order to return the results. Permitted values are SLD, TLD, DNS, and ExpirationDate. 15
StartLetter Optional Return names that start with this letter 1
MultiLang Optional If MultiLang=On, display SLD in native character set in UI. 1
Domain Optional Return names that match this name. Use format SLD.TLD 60
ExtFormat Optional Returns XML tags without hyphens, to more rigorously adhere to XML standards and allow more trouble-free performance with automated parsers. Use ExtFormat=1 to return tags without hyphens. 1
ResponseType Optional Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
DomainNameIDX Domain name ID. Indexed X when ResponseType=Text or HTML.
SLDX Second-level domain name (for example, enom in enom.com). Indexed X when ResponseType=Text or HTML.
TLDX Top-level domain name (extension). Indexed X when ResponseType=Text or HTML.
NS-StatusX Name server status. YES indicates this domain uses our name servers. Indexed X when ResponseType=Text or HTML.
Expiration-DateX Expiration date of the domain registration. Indexed X when ResponseType=Text or HTML.
Auto-RenewX Auto-renew setting. Return values are Yes or No. Indexed X when ResponseType= Text or HTML.
WPPSStatusX WhoIs privacy protection setting. Return values are Enabled or Disabled. Indexed X when ResponseType=Text or HTML.
WPPSExpDate WhoIs privacy protection setting expiration date.
RRProcessor RR processor. Indexed X when ResponseType=Text or HTML.
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