Domains-domainName-details:GET
From Hostway API Documentation
Revision as of 22:27, 17 February 2013 by Mike.robski (Talk | contribs)
GET /domains/{domainName}/details
Returns full details about a domain name such as registrant contact (whois) info, its creation, update and expiration dates, name servers, lock and hold status as well as product URIs.
- todo
- add json response bodies to examples
Contents |
Request
GET /domains/{domainName}/details
Parameters
- domainName - string
- The valid domain name to retrieve including only the labels that are appropriate for a valid 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.
URI Parameters
None.
Request Headers
None.
Response
Status Code
- 200 OK
- Domain info successfully retrieved.
- 202 Accepted
- Domain info successfully retrieved, however an action is still pending and the registration or transfer remains incomplete. Domain cannot be updated.
- 412 Precondition Failed
- Domain is not registered in this account and cannot be accessed.
- 404 Not Found
- No domain records found for the given domain name.
- 400 Bad Request
- The domain name is not valid.
Response Body
{
"domainName":"domainpeople.com",
"authInfo":"0f59fcc1c8bada1:",
"createDate":"2010-03-20T03:23:20-08:00", -----\
"updateDate":"2013-02-15T05:15:33-08:00", -------> datetime standard?
"expireDate":"2013-03-20T03:23:20-08:00", -----/
"nameservers":[
"a.dns.hostway.net",
"b.dns.hostway.net"
],
"registrarLock":"true", -------> domain status
"registrarHold":"false", ----/
"registryLock":"false", ---/
"registryHold":"false", --/
"immutable":"false" -/
"contactList":[
{
"contactType":"registrant", -------> contact structure
"company":"DomainPeople, Inc.", .
"name":{ .
"lastName":"Domain", .
"firstName":"Admin" .
}, .
"address":{
"city":"Vancouver",
"countryCode":"CA",
"street1":"Suite 200",
"street2":"550 Burrard Street",
"postalCode":"V6C 2B5",
"stateOrProvince":"BC"
}
"contactMedia":{
"fax":null,
"phone2":"",
"phone1":"+1.6046888946",
"email1Format":"text",
"email2Format":"",
"email2":"",
"email1":"support@domainpeople.com"
},
},
{
"contactType":"admin",
"company":"DomainPeople, Inc.",
"name":{
"lastName":"Domain",
"firstName":"Admin"
},
"address":{
"city":"Vancouver",
"countryCode":"CA",
"street1":"Suite 200",
"street2":"550 Burrard Street",
"postalCode":"V6C 2B5",
"stateOrProvince":"BC"
}
"contactMedia":{
"fax":null,
"phone2":"",
"phone1":"+1.6046888946",
"email1Format":"text",
"email2Format":"",
"email2":"",
"email1":"support@domainpeople.com"
},
},
{
"contactType":"billing",
"company":"DomainPeople, Inc.",
"name":{
"lastName":"Domain",
"firstName":"Admin"
},
"address":{
"city":"Vancouver",
"countryCode":"CA",
"street1":"Suite 200",
"street2":"550 Burrard Street",
"postalCode":"V6C 2B5",
"stateOrProvince":"BC"
}
"contactMedia":{
"fax":null,
"phone2":"",
"phone1":"+1.6046888946",
"email1Format":"text",
"email2Format":"",
"email2":"",
"email1":"support@domainpeople.com"
},
},
{
"contactType":"technical",
"company":"DomainPeople, Inc.",
"name":{
"lastName":"Domain",
"firstName":"Admin"
},
"address":{
"city":"Vancouver",
"countryCode":"CA",
"street1":"Suite 200",
"street2":"550 Burrard Street",
"postalCode":"V6C 2B5",
"stateOrProvince":"BC"
}
"contactMedia":{
"fax":null,
"phone2":"",
"phone1":"+1.6046888946",
"email1Format":"text",
"email2Format":"",
"email2":"",
"email1":"support@domainpeople.com"
},
}
],
}
Parameters
- contactList - list
- an array of contacts with a contactType of 'registrant', 'admin', 'billing', or 'technical'
- firstName - string
- Contact's first name.
- lastName - string
- Contact's last name.
- company - string
- Contact's company name (optional).
- street1 - string
- Contact's street address.
- street2 - string
- Contact's street address second line (optional).
- city - string
- Contact's city.
- stateOrProvince - string
- Contact's state or province string or two character code for US and CA.
- postalCode - string
- Contact's postal or ZIP code.
- countryCode - string
- Contact's 2 character country code per ISO 3166-1 alpha-2[1].
- fax - string
- Contact's fax number in ITU-T E.164[2] format (optional).
- email1 - string
- Contact's primary e-mail address.
- nameservers - list
- An array of 0 to 13 unique nameservers that are assigned to the domain in listed order of assignement
- status - list
- An array of status assigned to the domain including 'ok', 'active'
- links - list
- Hypermedia for this resource.
Examples
Details for a domain name that is locked
Request
GET /domains/example.org/details
Response
{JSON}
Details for a domain name that is newly registered and has no name servers
Request
GET /domains/example.com/details
Response
{JSON}
See also
