GetTLDDetails


Definition

Retrieve TLD characteristics in detail for a specified TLD.

Usage

Use this command to retrieve TLD characteristics in detail for a specified TLD.

Availability

All resellers have access to this command.

Implementation on eNom.com

Multiple pages to drive specific characteristic based on TLD.

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
TLD Optional Top Level Domain. If not declared, this command returns sumarized charateristics for all authorized TLD for this account. 16
ResponseType Optional Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
TLDID Top Level Domain identification number
TLD Top Level Domain name
AbleToLock Support domain lock to prevent transfer?
AllowWPPS Allow domain's contacts to use WHOIS Privacy Protection Service (WPPS)?
AutoRenewOnly Allow user to renew domain manually at any time?
ExtAttributes Require user to add extended attributes on domain registration?
AllowWBL Allow domain to use WHOIS Business Listing (WBL)?
TransRequiresNewContact Require a new registrant contact for transfer
EncodingType Support Internationalized Domain Name (IDN)? If not empty, the TLD supports IDN
LangCode IDN natural character encoding type
NativeDisplay Native characters for the IDN TLD
ClearPhoneNumber Clear phone number as part of contact creation
ClearFax Clear fax number as part of contact creation
ValidateDNSHosting Perform check to the Registry if this TLD can be hosted
HasPremiumNames Support premium domain name category?
Registration - Realtime Support realtime registration?
Registration - Unit Registration quantity unit
Registration - Minimum Registration minimum unit
Registration - Maximum Registration maximum unit
Registration - HasPremiumNames Support premium domain name registration?
Registration - ExtAttributes Require extended attributes for registration?
Registration - DomainLevel Support domain level extended attributes?
Registration - DNSRequired Require DNS for registration?
Registration - DNSMinimum Minimum number of DNS
Registration - DNSMaximum Maximum number of DNS
Registration - GeneralAvailabilityStartDate Date and time the TLD enters General Availability
Renewal - AutoRenewOnly Allow user to renew domain manually at any time?
Renewal - AutoRenewed Does Registry renew the domain automatically on day of expiration?
Renewal - RenewBeforeExpMonths How many months does the registry allow user to renew the domain prior to the expiration date?
Renewal - DeleteType Deletion type. Legacy parameter
Renewal - DeleteDay Number of days from the expiration date, that we delete a domain name. If negative, we delete the domain name prior to the expiration date
Renewal - GracePeriod How many days after registration/renewal can the domain be deleted and a full refund issued?
Renewal - Reactivate Can the domain be renewed after the expiration date? Flag used by order processing
Renewal - Restorable Can the domain be renewed after the expiration date? Flag used by user interface
Renewal - RGP Can domain be restored after deletion. Flag used by auto renewals
Renewal - RGPDays After domain is deleted, how long does the Registry allow for redemption period
Renewal - ExtendedRGP Support Extended RGP?
Renewal - TransferPeriod The number of years the expiration date will be extended when a domain transfers.
Transfer - Transferable Support transfer?
Transfer - AuthInfo Support Authorization Info or Extensible Provisioning Protocol (EPP) Key
Transfer - Realtime Support realtime transfer request?
Transfer - AutoVerification Support auto verification transfer?
Transfer - AutoFax Support auto fax transfer?
Transfer - TransferByFOA Support transfer approval using an FOA email to the losing registrant
Transfer - RequiresNewContact Require a new registrant contact for transfer
PremiumNames - HasPremiumNames Support premium domain name registration?
PremiumNames - MaxPremiumRegYears Maximum number of years a premium domain can be registered
PremiumNames - TrademarkStartDate The date when the registry will support TM claims check. If null, the Registry does not support TM claims check
NameServers - RequiresDNS Require DNS for registration?
NameServers - MinNameServers Minimum number of DNS
NameServers - MaxNameServers Maximum number of DNS
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 parameterErr(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.

Example