Domains-domainName-details:GET

From Hostway API Documentation
(Difference between revisions)
Jump to: navigation, search
m (1 revision: Release 87)
m (1 revision: Release 90)
 
(One intermediate revision by one user not shown)
Line 2: Line 2:
 
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.
 
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
 
 
__TOC__
 
__TOC__
 
== Request ==
 
== Request ==

Latest revision as of 12:25, 31 January 2014

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.

Contents

Request

GET /domains/{domainName}/details

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.

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",
   "expireDate":"2013-03-20T03:23:20-08:00",
   "nameservers":[
      "a.dns.hostway.net",
      "b.dns.hostway.net"
   ],
   "registrarLock":"true",
   "registrarHold":"false",
   "registryLock":"false",
   "registryHold":"false",
   "udrp": "false",
   "immutable":"false",
   "contactInfo":{
      "registrant": {
         "type":"registrant",
         "company":"DomainPeople, Inc.",         
         "lastName":"Domain",
         "firstName":"Admin",
         "city":"Vancouver",
         "countryCode":"CA",
         "street1":"Suite 200",
         "street2":"550 Burrard Street",
         "zipOrPostal":"V6C 2B5",
         "stateOrProvince":"BC",
         "phone1":"+1.6046888946",
         "email1":"support@domainpeople.com"
         },
      "administrative": {
         "type":"administrative",
         "company":"DomainPeople, Inc.",         
         "lastName":"Domain",
         "firstName":"Admin",
         "city":"Vancouver",
         "countryCode":"CA",
         "street1":"Suite 200",
         "street2":"550 Burrard Street",
         "zipOrPostal":"V6C 2B5",
         "stateOrProvince":"BC",
         "phone1":"+1.6046888946",
         "email1":"support@domainpeople.com"
         },
      "billing": {
         "type":"billing",
         "company":"DomainPeople, Inc.",         
         "lastName":"Domain",
         "firstName":"Admin",
         "city":"Vancouver",
         "countryCode":"CA",
         "street1":"Suite 200",
         "street2":"550 Burrard Street",
         "zipOrPostal":"V6C 2B5",
         "stateOrProvince":"BC",
         "phone1":"+1.6046888946",
         "email1":"support@domainpeople.com"
         },              
      "technical": {
         "type":"technical",
         "company":"DomainPeople, Inc.",         
         "lastName":"Domain",
         "firstName":"Admin",
         "city":"Vancouver",
         "countryCode":"CA",
         "street1":"Suite 200",
         "street2":"550 Burrard Street",
         "zipOrPostal":"V6C 2B5",
         "stateOrProvince":"BC",
         "phone2":"",
         "phone1":"+1.6046888946",
         "email1":"support@domainpeople.com"
         }
      }            
   }
}

Parameters

domainName - string
The domain name in lowercase.
authInfo - string
the authInfo for the domain. This is the password that is used to transfer the domain from one registrar to another. authInfo is a 6-16 character string that may contain characters a-zA-Z0-9`~-=_+!@#$%^&*()[]{}\|,.;: For example:
  • aD3glp-@bQl-7
createDate - datetime
Creation date of the domain at the registry.
Datetime formats follow the standard 'yyyy-mm-ddTHH:MM:ss+0:00'
updateDate - datetime
Last update date of the domain at the registry.
Datetime formats follow the standard 'yyyy-mm-ddTHH:MM:ss+0:00'
expireDate - datetime
The actual expiration date of the domain at the registry. Note that in some cases the expiration date of a domain that is displayed in the 'whois' record may indicate the date following a registry autorenewal. This whois expiration date may be inaccurate. The actual expiration date must be extended with an explicit renewal or the domain may be deleted. Do not rely on the whois expiration date.
Datetime formats follow the standard 'yyyy-mm-ddTHH:MM:ss+0:00'
nameservers - list
An array of 0 to 13 unique nameservers that are assigned to the domain in listed order of assignement.
registrarLock - boolean
Indicates if the domain is locked at the registry. The registrarLock corresponds to a whois status of 'clientTransferProhibited'. If a domain is locked, it cannot be transferred to another registrar.
A domain may be renewed in this state
registrarHold - boolean
Indicates if the domain is on hold at the registry. If a domain is on hold then it will not resolve as the name servers are withheld from the registry DNS zone files. A hold status corresponds to a 'clientHold' whois status. A domain bay be placed on hold if it has expired, or the customer has explicitley requested the product to be closed, or by court order.
A domain may be renewed in this state
registryLock - boolean
Indicates if the domain is locked at the registry. A registryLock status corresponds to 'registryTransferProhibited' whois status. A domain that is locked by the registry cannot be transferred to another registrar. A registryLock cannot be removed automatically. A domain may be on registryLock if that has been requested by the client for security reasons, or by court order to the registry.
A domain may be renewed in this state
registryHold - boolean
A rareley occuring state where the registry has placed the domain on hold by court order. The domain will not resolve while in this status. The court proceedings will determine the outcome of the domain.
A domain cannot be renewed in this state
udrp - boolean
If a domain has UDRP status set it cannot be unlocked, or modified in any way. A domain may be placed in this state in the case of a Uniform Dispute Resolution Proceeding (UDRP) filing.
A domain may be renewed in this state
immutable - boolean
A domain is immutable when it cannot be unlocked, or modified in any way. A domain may be placed in this state by client request for security purposes, or by court order in the case of a Uniform Dispute Resolution Proceeding (UDRP) filing.
A domain may be renewed in this state
contactInfo - set
an set of contact objects with a name and a type of 'registrant', 'administrative', 'billing', or 'technical'
  • company - string
Contact's company name (optional). In no company name is supplied, the contact is considered to be an individual.
  • firstName - string
Contact's first name.
  • lastName - string
Contact's last name.
  • 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.
  • zipOrPostal - string
Contact's postal or ZIP code.
  • countryCode - string
Contact's 2 character country code per ISO 3166-1 alpha-2[1].
  • phone1 - string
Contact's phone number in ITU-T E.164[2] format.
  • fax - string
Contact's fax number in ITU-T E.164[3] format (optional).
  • email1 - string
Contact's primary e-mail address.
links - list
Hypermedia for this resource.

Examples

Details for a domain name that is locked

Request 

GET /domains/example.org/details

Response 

{
   "domainName":"example.org",
   "authInfo":"0F59fcc1c8bada1:",
   "createDate":"1993-03-20T03:23:20-08:00",
   "updateDate":"2013-02-15T05:15:33-08:00",
   "expireDate":"2023-03-20T03:23:20-08:00",
   "nameservers":[
      "a.dns.hostway.net",
      "b.dns.hostway.net"
   ],
   "registrarLock":"true",
   "registrarHold":"false",
   "registryLock":"false",
   "registryHold":"false",
   "udrp": "false",
   "immutable":"false",
   "contactInfo":{
      "registrant": {
         "type":"registrant",
         "company":"DomainPeople, Inc.",         
         "lastName":"Domain",
         "firstName":"Admin",
         "city":"Vancouver",
         "countryCode":"CA",
         "street1":"Suite 200",
         "street2":"550 Burrard Street",
         "zipOrPostal":"V6C 2B5",
         "stateOrProvince":"BC",
         "phone1":"+1.6046888946",
         "email1":"support@domainpeople.com"
         },
      "administrative": {
         "type":"administrative",
         "company":"DomainPeople, Inc.",         
         "lastName":"Domain",
         "firstName":"Admin",
         "city":"Vancouver",
         "countryCode":"CA",
         "street1":"Suite 200",
         "street2":"550 Burrard Street",
         "zipOrPostal":"V6C 2B5",
         "stateOrProvince":"BC",
         "phone1":"+1.6046888946",
         "email1":"support@domainpeople.com"
         },
      "billing": {
         "type":"billing",
         "company":"DomainPeople, Inc.",         
         "lastName":"Domain",
         "firstName":"Admin",
         "city":"Vancouver",
         "countryCode":"CA",
         "street1":"Suite 200",
         "street2":"550 Burrard Street",
         "zipOrPostal":"V6C 2B5",
         "stateOrProvince":"BC",
         "phone1":"+1.6046888946",
         "email1":"support@domainpeople.com"
         },              
      "technical": {
         "type":"technical",
         "company":"DomainPeople, Inc.",         
         "lastName":"Domain",
         "firstName":"Admin",
         "city":"Vancouver",
         "countryCode":"CA",
         "street1":"Suite 200",
         "street2":"550 Burrard Street",
         "zipOrPostal":"V6C 2B5",
         "stateOrProvince":"BC",
         "phone2":"",
         "phone1":"+1.6046888946",
         "email1":"support@domainpeople.com"
         }
      }            
   }
}

Details for a domain name that is newly registered and has no name servers

Request 

GET /domains/example.com/details

Response 

{
   "domainName":"example.com",
   "authInfo":"0F59FCC1C8BADA1:",
   "createDate":"2013-03-20T23:39:20-08:00",
   "updateDate":"2013-03-21T05:15:33-08:00",
   "expireDate":"2014-03-20T23:39:20-08:00",
   "nameservers":[],
   "registrarLock":"false",
   "registrarHold":"false",
   "registryLock":"false",
   "registryHold":"false",
   "udrp": "false",
   "immutable":"false",
   "contactInfo":{
      "registrant": {
         "type":"registrant",
         "company":"DomainPeople, Inc.",         
         "lastName":"Domain",
         "firstName":"Admin",
         "city":"Vancouver",
         "countryCode":"CA",
         "street1":"Suite 200",
         "street2":"550 Burrard Street",
         "zipOrPostal":"V6C 2B5",
         "stateOrProvince":"BC",
         "phone1":"+1.6046888946",
         "email1":"support@domainpeople.com"
         },
      "administrative": {
         "type":"administrative",
         "company":"DomainPeople, Inc.",         
         "lastName":"Domain",
         "firstName":"Admin",
         "city":"Vancouver",
         "countryCode":"CA",
         "street1":"Suite 200",
         "street2":"550 Burrard Street",
         "zipOrPostal":"V6C 2B5",
         "stateOrProvince":"BC",
         "phone1":"+1.6046888946",
         "email1":"support@domainpeople.com"
         },
      "billing": {
         "type":"billing",
         "company":"DomainPeople, Inc.",         
         "lastName":"Domain",
         "firstName":"Admin",
         "city":"Vancouver",
         "countryCode":"CA",
         "street1":"Suite 200",
         "street2":"550 Burrard Street",
         "zipOrPostal":"V6C 2B5",
         "stateOrProvince":"BC",
         "phone1":"+1.6046888946",
         "email1":"support@domainpeople.com"
         },              
      "technical": {
         "type":"technical",
         "company":"DomainPeople, Inc.",         
         "lastName":"Domain",
         "firstName":"Admin",
         "city":"Vancouver",
         "countryCode":"CA",
         "street1":"Suite 200",
         "street2":"550 Burrard Street",
         "zipOrPostal":"V6C 2B5",
         "stateOrProvince":"BC",
         "phone2":"",
         "phone1":"+1.6046888946",
         "email1":"support@domainpeople.com"
         }
      }            
   }
}

See also


blog comments powered by Disqus

Retrieved from "http://docs.hostway.com/index.php?title=Domains-domainName-details:GET&oldid=1153"
Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox