Accounts-accountId-Contacts:GET
From Hostway API Documentation
Revision as of 16:56, 27 September 2013 by Mike.robski (Talk | contribs)
GET /accounts/{accountId}/contacts
Get contact details for an account.
Contents |
Request
GET /accounts/{accountId}/contacts
Request Parameters
- accountId - string
- The unique account Id.
URI Parameters
None.
Request Headers
- Authorization - HTTP Authorization header [1]
- The Authentication credentials of the client application.
Response
Status Code
- 200 OK
- Success
- 404 Not Found
- The specified account Id does not exist or is purged.
Response Body
{
"regular": {
"city": "Chicago",
"countryCode": "US",
"email1": "test@test.com",
"email2": "",
"fax": "",
"firstName": "John",
"lastName": "Smith",
"middleName": "",
"phone1": "555-555-5501",
"phone2": "",
"postalCode": "60001",
"stateOrProvince": "IL",
"street1": "100 Main St.",
"street2": ""
},
"billing": {
"city": "Chicago",
"countryCode": "US",
"email1": "test@test.com",
"email2": "",
"fax": "",
"firstName": "John",
"lastName": "Smith",
"middleName": "",
"phone1": "555-555-5501",
"phone2": "",
"postalCode": "60001",
"stateOrProvince": "IL",
"street1": "100 Main St.",
"street2": ""
},
"administrator": {
"city": "Chicago",
"countryCode": "US",
"email1": "test@test.com",
"email2": "",
"fax": "",
"firstName": "John",
"lastName": "Smith",
"middleName": "",
"phone1": "555-555-5501",
"phone2": "",
"postalCode": "60001",
"stateOrProvince": "IL",
"street1": "100 Main St.",
"street2": ""
},
"technical": {
"city": "Chicago",
"countryCode": "US",
"email1": "test@test.com",
"email2": "",
"fax": "",
"firstName": "John",
"lastName": "Smith",
"middleName": "",
"phone1": "555-555-5501",
"phone2": "",
"postalCode": "60001",
"stateOrProvince": "IL",
"street1": "100 Main St.",
"street2": ""
}
}
Examples
Successful Request
Request
GET /accounts/{accountId}/contacts
Authorization: Basic {Base64-encoded username & password string}
Response
200 OK
[
{
"City": "Chicago",
"FirstName": "John",
"LastName": "Smith",
"State": "IL",
"Email": "test@test.com",
"Fax": "",
"Zip": "60001",
"Deleted": 0,
"Company": "Hostway co",
"Phone": "555-555-5501",
"ContactType": "billing",
"AccountId": 100144677,
"Phone2Clean": "",
"MiddleName": "",
"Country": "US",
"AccountNumber": "test-account11111",
"PhoneClean": "5555555501",
"Agent": "n/a",
"Id": 100429415,
"Phone2": "",
"Street": "100 Main St.",
"Email2": "",
"Street2": ""
},
{
"City": "Chicago",
"FirstName": "John",
"LastName": "Smith",
"State": "IL",
"Email": "test@test.com",
"Fax": "",
"Zip": "60001",
"Deleted": 0,
"Company": "Hostway co",
"Phone": "555-555-5501",
"ContactType": "regular",
"AccountId": 100144677,
"Phone2Clean": "",
"MiddleName": "",
"Country": "US",
"AccountNumber": "test-account11111",
"PhoneClean": "5555555501",
"Agent": "n/a",
"Id": 100429416,
"Phone2": "",
"Street": "100 Main St.",
"Email2": "",
"Street2": ""
},
{
"City": "Chicago",
"FirstName": "John",
"LastName": "Smith",
"State": "IL",
"Email": "test@test.com",
"Fax": "",
"Zip": "60001",
"Deleted": 0,
"Company": "Hostway co",
"Phone": "555-555-5501",
"ContactType": "administrator",
"AccountId": 100144677,
"Phone2Clean": "",
"MiddleName": "",
"Country": "US",
"AccountNumber": "test-account11111",
"PhoneClean": "5555555501",
"Agent": "n/a",
"Id": 100429417,
"Phone2": "",
"Street": "100 Main St.",
"Email2": "",
"Street2": ""
},
{
"City": "Chicago",
"FirstName": "John",
"LastName": "Smith",
"State": "IL",
"Email": "test@test.com",
"Fax": "",
"Zip": "60001",
"Deleted": 0,
"Company": "Hostway co",
"Phone": "555-555-5501",
"ContactType": "technical",
"AccountId": 100144677,
"Phone2Clean": "",
"MiddleName": "",
"Country": "US",
"AccountNumber": "test-account11111",
"PhoneClean": "5555555501",
"Agent": "n/a",
"Id": 100429418,
"Phone2": "",
"Street": "100 Main St.",
"Email2": "",
"Street2": ""
}
]
Request for non-existent account Id
Request
GET /accounts/{fake_account_number}/contacts
Authorization: Basic {Base64-encoded username & password string}
Response
404 Not Found
{
"itemNotFound": {
"message": "/accounts/fake-account-id/contacts",
"code": 404,
"details": ""
}
}
See also
