ServiceAttributes-core.dnr
From Hostway API Documentation
(Difference between revisions)
Mike.robski (Talk | contribs) |
Mike.robski (Talk | contribs) m (1 revision: Release 100) |
||
(4 intermediate revisions by 2 users not shown) | |||
Line 6: | Line 6: | ||
<nowiki> | <nowiki> | ||
{ | { | ||
− | "domainName": " | + | "domainName": "mydomain.com", |
"operation": "register", | "operation": "register", | ||
"term": 1, | "term": 1, | ||
"authInfo" : "mysecret", | "authInfo" : "mysecret", | ||
− | "nameservers" : [ "ns1. | + | "nameservers" : [ "ns1.myprovider.com", "ns2.myprovider.com" ], |
+ | "extraParams": [{"name": "us_nexus", "value": "C11"}, {"name": "us_purpose", "value": "P1"}], | ||
"contactInfo" : { | "contactInfo" : { | ||
"registrant": { | "registrant": { | ||
Line 19: | Line 20: | ||
"street1": "123 First Str.", | "street1": "123 First Str.", | ||
"city": "Chicago", | "city": "Chicago", | ||
− | "zipOrPostal": " | + | "zipOrPostal": "60000", |
"stateOrProvince": "IL", | "stateOrProvince": "IL", | ||
"countryCode": "US", | "countryCode": "US", | ||
"email1": "john.doe@test.com", | "email1": "john.doe@test.com", | ||
− | "phone1": "+1. | + | "phone1": "+1.123.5555555" }, |
"administrative": { | "administrative": { | ||
"type": "administrative", | "type": "administrative", | ||
Line 49: | Line 50: | ||
: the registration term (period) in years | : the registration term (period) in years | ||
; authInfo - ''string'' | ; authInfo - ''string'' | ||
− | : authentication info, | + | : authentication info, required for transfer operation |
; nameservers - ''list of strings'' | ; nameservers - ''list of strings'' | ||
: domain name servers (DNS) for the domain | : domain name servers (DNS) for the domain | ||
− | + | {{ExtraParam}} | |
− | + | ||
− | + | ||
− | + | ||
; company - ''string'' (optional) | ; company - ''string'' (optional) | ||
: The company or organization name | : The company or organization name |
Latest revision as of 00:07, 19 November 2014
[edit] Domain Name Registration Service Attributes
Attributes used when configuring the Domain Name Registration service.
Contents |
[edit] 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", ... } } }
[edit] 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
[edit] See also