AuthorizeTLD


Definition

Create or add to a list of TLDs that you offer to your resellers and retail customers.

Usage

Use this command to specify the TLDs that you offer to your resellers and retail customers. This command controls which TLDs your Web site can offer for registrations, renewals, and transfers.

The first time you use this command, the list of TLDs we return to you switches from the list of all TLDs we offer, which is the default, to your own list that contains only the TLDs you authorize.

You can also use this command to add to your list of authorized TLDs. When you want to add one TLD, run AuthorizeTLD with that single TLD.

To revert from the authorized TLD mode back to the default mode (all TLDs that we support), or to remove TLDs from your list, use the RemoveTLD command.

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/Settings.asp

Clicking the TLD Pricing tab shows either the complete set of TLDs we offer, or the TLDs you have authorized.

Constraints

The query must meet the following requirements:

  • The login ID and password must be valid.
  • You can only authorize TLDs that we offer.

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 Either TLD or DomainList is Required One top-level domain (TLD) to add to your list of authorized TLDs. For example, if you want to add .biz, use TLD=biz 15
DomainList Either TLD or DomainList is Required Comma-separated list of TLDs to add to your list of authorized TLDs. For example, if you want to add .com, .net, and .org, use DomainList=com,net,org 100
ResponseType Optional Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
AuthorizeTLDX TLD to add to authorized list. 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, sendResponseType=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