Domains-domainName-contactType:GET
From Hostway API Documentation
Revision as of 15:22, 15 November 2013 by Mike.robski (Talk | contribs)
GET /domains/{domainName}/{contactType}
Get domains contact information for the specified contact type (registrant, administrative, billing or technical). Each domain has all four contacts.
Contents |
Request
GET /domains/{domainName}/{contactType}
Request Parameters
None
URI Parameters
- domainName - string
- The domain name. IE: example.com is a valid domain name, whereas http://www.example.com or www.example.com are not. If the domain name is invalid, or is otherwise not registerable such as for a non-existent or non-supported TLD, an error will be returned. Domain names are case insensitive. The domain name must be an open or suspended product under the authenticated franchise.
- contactType - string
- The contact type must be one of: registrant, administrative, billing or technical.
Request Headers
- Content-Type
- Required. Set this header to
application/json; charset=UTF-8
- Cookie
- A cookie named OwnerId to identify the client (for most browser clients, the browser will do this automatically, depending on the browser configuration). The value of the cookie would come from the response to the create order request in the Set-Cookie response header.
Request Body
None
Request Parameters
None
Response
Status Code
- 200 OK
- The account was successfully set.
- 204 No Content
- The account was successfully set.
- 400 Bad Request
- The request body format is invalid or the language or currency is not supported by the franchise.
- 409 Conflict
- Attempt to set currency that is different from currencies of the products or that of the existing account.
Response Body
Response Body for getting contact information
{
"company": "{company}",
"firstName": "{firstName}",
"lastName": "{lastName}",
"street1": "{street1}",
"street2": "{street2}",
"city": "{city}",
"countryCode": "{countryCode}",
"stateOrProvince": "{stateOrProvince}",
"zipOrPostal": "{zipOrPostal}" ,
"email1": "{email}",
"phone1": "{phone1}"
}
Response parameters
- 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
- street1 - 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
Example of getting domain contact information.
Request
GET /domains/ng-test-fitnesse-20130202-0605.com/registrant
Response
200 OK
Content-Type: application/json; charset=UTF-8
{
"company": "Green Ltd.",
"firstName": "Barbara",
"lastName": "Phillips",
"street1": "Maple Str. 37",
"city": "San Jose",
"countryCode": "US",
"stateOrProvince": "CA",
"zipOrPostal": "95191" ,
"email1": "barbara.phillips@test.com",
"phone1": "+1.3209270625"
}
See also
