ServiceAttributes-core.dnr

From Hostway API Documentation
Jump to: navigation, search

Domain Name Registration Service Attributes

Attributes used when configuring the Domain Name Registration service.

Contents


Attributes Body

{
   "domainName": "mydomain.com",
   "operation": "register",
   "term": 1,
   "authInfo" : "mysecret",
   "nameservers" : [ "ns1.myprovider.com", "ns2.myprovider.com" ],
   "extraParams": [{"name": "us_nexus", "value": "C11"}, {"name": "us_purpose", "value": "P1"}],
   "contactInfo" : {
      "registrant": {
         "type": "registrant",
         "firstName": "John",
         "lastName": "Doe",
         "company": "ACME Inc.",
         "street1": "123 First Str.",
         "city": "Chicago",
         "zipOrPostal": "60000",
         "stateOrProvince": "IL",
         "countryCode": "US",
         "email1": "john.doe@test.com",
         "phone1": "+1.123.5555555" },
      "administrative": {
         "type": "administrative",
         ...
      },
      "billing": {
         "type": "billing",
         ...
      },
      "technical": {
         "type": "technical",
         ...
      }
   }
}
 

Parameters

domainName - string
The domain name
operation - string
"register" to register a domain
"transfer" to transfer a domain
term - integer
the registration term (period) in years
authInfo - string
authentication info, required for transfer operation
nameservers - list of strings
domain name servers (DNS) for the domain
extraParams - list of extra params (optional)
List of additional parameters required for some TLDs. Each parameter is an object with "name" and "value" fields. For example, .us registration requires the fields "us_nexus" which can be one of the following [C11, C12, C21, C31, C32] - see What are Domain Name Application Purpose Codes? and "us_purpose" which can be one of [P1, P2, P3, P4, P5] - see What do the Nexus Codes mean? You can find more information on extra parameters in the GET /domains/tlds/{tld}/extparams documentation.
company - string (optional)
The company or organization name
firstName - string
The first name of the contact person
lastName - string
The last name of the contact person
street1 - string
The street address
street2 - string (optional)
The second line of the street address (if any)
city - string
The city
countryCode - string
The international 2-letter country code
stateOrProvince - string
The state or province. For US states use the 2-letter state code
zipOrPostal - string
The postal code
email1 - string
The e-mail address of the contact person
phone1 - string
The phone number of the contact person in valid E.164 format, e.g. +1.3209270625

See also


blog comments powered by Disqus

Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox