Domains-tlds-extparams:GET

Latest revision as of 11:22, 6 February 2015

Some TLDs require additional parameters for registration. This request returns the extra parameters (if any) for the specified TLD, e.g. for .it (Italy) it would return the ofllowing data structure:

{
   "attributes":[
      {
         "description":"Tax ID. If the requester is ...",
         "userDefined":true,
         "required":1,
         "isChild":0,
         "application":2,
         "options":{
            "option":[
               {
                  "description":"If the requester is ...",
                  "requires":null,
                  "id":972,
                  "value":"1",
                  "title":"Codice Fiscale"
               }
            ]
         },
         "id":151,
         "name":"it_pin"
      },
      ...
   ]
}
 

This data can be used by the client application to display a form with the required fields, along with descriptions and values. It is also used by the Public API to validate domain orders. For example, from the above data you can see that the "it_pin" parameter is required when registering .it domains, so you need to include it in your order as "extraParams" (either as a service attribute if using the standard ordering process - see Ordering Domain, or in the domain shortcut registration request - see PUT /accounts/{accountId}/domains/{domainName}):

{
   "domainName": "testname.it",
   "extraParams": [{"name": "ip_pin", "value": "1"}, ...]
   ...
}
 

As a common example, the .us domain registration requires the "us_nexus" and "us_purpose" parameters:

{
   "domainName": "ng-test-20141020.us",
   "extraParams": [{ "name": "us_nexus", "value": "C11"}, { "name": "us_purpose", "value": "P1"}],
   ...
}
 

Another example would be the .pro registration, which requires "pro_profession" parameter:

{
   "domainName": "ng-test-20141020.pro",
   "extraParams": [{"name": "pro_profession", "value": "engineer"}],
   ...
}