Latest revision as of 15:24, 15 November 2013

GET /accounts/{account}/email/{domain}/contacts/{contact}

Gets domain's global address book contact information

Request

GET /accounts/{account}/email/{domain}/contacts/{contact}

URI Parameters

account - string

domain - string

contact - string

Request Headers

Authorization - HTTP Authorization header [1]

The Authentication credentials of the client application.

Content-Type

Required. Set this header to application/json; charset=UTF-8

Status Code

200 Ok

Success

400 Bad Request

The format of the request body is invalid or the parameters don't meet the requirements.

404 Not Found

The domain name or contact does not exist.

Response Body

{
    "name": "{name}", 
    "email": "{email}", 
    "firstName": "{firstName}", 
    "lastName": "{lastName}", 
    "displayName": "{displayName}"
    "title": "{title}",
    "homePhone": "{homePhone}",
    "mobilePhone": "{mobilePhone}",
    "businessPhone": "{businessPhone}",
    "businessFax": "{businessFax}",
    "isdnNumber": "{isdnNumber}",
    "pager": "{pager}",
    "telexNumber": "{telexNumber}",
    "company": "{company}",
    "department": "{department}",
    "roomNumber": "{roomNumber}",
    "streetAddress": "{streetAddress}",
    "postalCode": "{postalCode}",
    "city": "{city}",
    "state": "{state}",
    "country": "{country}",
    "links": [{"href": "{APIBaseURL}/accounts/{account}/email/{domain}/contacts/{name}", "rel": "self"}]

}
 

Parameters

name - string

The name of global address book contact.

email - string

The email of global address book contact.

firstName - string

The first name of global address book contact.

lastName - string

The last name of global address book contact.

displayName - string

The display name of global address book contact.

title - string

The title of global address book contact person.

homePhone - string

The home phone of global address book contact.

mobilePhone - string

The home phone of global address book contact.

businessPhone - string

The business phone of global address book contact.

businessFax - string

The business fax of global address book contact.

isdnNumber - string

The isdn number of global address book contact.

pager - string

The pager of global address book contact.

telexNumber - string

The telex number of global address book contact.

company - string

The company name of global address book contact.

department - string

The department name of global address book contact.

roomNumber - string

The room number of global address book contact.

streetAddress - string

The street address of global address book contact.

postalCode - string

The postal code of global address book contact.

city - string

The city name of global address book contact.

state - string

The state name of global address book contact.

country - string

The country name of global address book contact.

Examples

Error getting global address book contact info

Request

GET https://api.hostway.com/accounts/account007/email/test-domain.com/contacts/non-existent-contact

 

Response

404 Not Found

 

Success getting global address book contact info

Request

GET https://api.hostway.com/accounts/account007/email/test-domain.com/contacts/test-contact

 

Response

200 Ok

{
    "city": "", 
    "businessPhone": "", 
    "displayName": "Display Name", 
    "mobilePhone": "", 
    "firstName": "First", 
    "title": "", 
    "roomNumber": "", 
    "lastName": "Last", 
    "company": "", 
    "pager": "", 
    "state": "", 
    "department": "", 
    "streetAddress": "", 
    "isdnNumber": "", 
    "postalCode": "", 
    "country": "", 
    "telexNumber": "", 
    "businessFax": "", 
    "email": "test@test.com", 
    "homePhone": "",
    "links": [{"href": "https://api.hostway.com/accounts/account007/email/test-domain.com/contacts/test-contact", "rel": "self"}]
}
 

See also

• Global Address Book Public API