Accounts-accountId-Contacts:GET

(Difference between revisions)
Jump to: navigation, search
m (1 revision)
Line 40: Line 40:
 
     "phone2": "",
 
     "phone2": "",
 
     "postalCode": "60001",
 
     "postalCode": "60001",
 +
    "salutation": "Mr.",
 
     "stateOrProvince": "IL",
 
     "stateOrProvince": "IL",
 
     "street1": "100 Main St.",
 
     "street1": "100 Main St.",
Line 56: Line 57:
 
     "phone2": "",
 
     "phone2": "",
 
     "postalCode": "60001",
 
     "postalCode": "60001",
 +
    "salutation": "Mr.",
 
     "stateOrProvince": "IL",
 
     "stateOrProvince": "IL",
 
     "street1": "100 Main St.",
 
     "street1": "100 Main St.",
Line 72: Line 74:
 
     "phone2": "",
 
     "phone2": "",
 
     "postalCode": "60001",
 
     "postalCode": "60001",
 +
    "salutation": "Mr.",
 
     "stateOrProvince": "IL",
 
     "stateOrProvince": "IL",
 
     "street1": "100 Main St.",
 
     "street1": "100 Main St.",
Line 88: Line 91:
 
     "phone2": "",
 
     "phone2": "",
 
     "postalCode": "60001",
 
     "postalCode": "60001",
 +
    "salutation": "Mr.",
 
     "stateOrProvince": "IL",
 
     "stateOrProvince": "IL",
 
     "street1": "100 Main St.",
 
     "street1": "100 Main St.",
Line 108: Line 112:
 
200 OK
 
200 OK
  
−
[
+
{
−
  {
+
  "regular": {
−
      "City": "Chicago",
+
    "city": "Chicago",
−
      "FirstName": "John",  
+
    "countryCode": "US",
−
      "LastName": "Smith",  
+
    "email1": "test@test.com",
−
      "State": "IL",
+
    "email2": "",
−
      "Email": "test@test.com",  
+
    "fax": "",
−
      "Fax": "",  
+
    "firstName": "John",
−
      "Zip": "60001",  
+
    "lastName": "Smith",
−
      "Deleted": 0,
+
    "middleName": "",
−
      "Company": "Hostway co",  
+
    "phone1": "555-555-5501",
−
      "Phone": "555-555-5501",  
+
    "phone2": "",
−
      "ContactType": "billing",  
+
    "postalCode": "60001",
−
      "AccountId": 100144677,
+
    "salutation": "Mr.",
−
      "Phone2Clean": "",  
+
    "stateOrProvince": "IL",
−
      "MiddleName": "",  
+
    "street1": "100 Main St.",
−
      "Country": "US",  
+
    "street2": ""
−
      "AccountNumber": "test-account11111",  
+
  },
−
      "PhoneClean": "5555555501",  
+
  "billing": {
−
      "Agent": "n/a",
+
    "city": "Chicago",
−
      "Id": 100429415,
+
    "countryCode": "US",
−
      "Phone2": "",
+
    "email1": "test@test.com",
−
      "Street": "100 Main St.",  
+
    "email2": "",
−
      "Email2": "",  
+
    "fax": "",
−
      "Street2": ""
+
    "firstName": "John",
−
  },
+
    "lastName": "Smith",
−
  {
+
    "middleName": "",
−
      "City": "Chicago",  
+
    "phone1": "555-555-5501",
−
      "FirstName": "John",  
+
    "phone2": "",
−
      "LastName": "Smith",  
+
    "postalCode": "60001",
−
      "State": "IL",  
+
    "salutation": "Mr.",
−
      "Email": "test@test.com",  
+
    "stateOrProvince": "IL",
−
      "Fax": "",  
+
    "street1": "100 Main St.",
−
      "Zip": "60001",  
+
    "street2": ""
−
      "Deleted": 0,
+
  },
−
      "Company": "Hostway co",  
+
  "administrator": {
−
      "Phone": "555-555-5501",  
+
    "city": "Chicago",
−
      "ContactType": "regular",  
+
    "countryCode": "US",
−
      "AccountId": 100144677,
+
    "email1": "test@test.com",
−
      "Phone2Clean": "",  
+
    "email2": "",
−
      "MiddleName": "",  
+
    "fax": "",
−
      "Country": "US",  
+
    "firstName": "John",
−
      "AccountNumber": "test-account11111",
+
    "lastName": "Smith",
−
      "PhoneClean": "5555555501",
+
    "middleName": "",
−
      "Agent": "n/a",
+
    "phone1": "555-555-5501",
−
      "Id": 100429416,
+
    "phone2": "",
−
      "Phone2": "",
+
    "postalCode": "60001",
−
      "Street": "100 Main St.",  
+
    "salutation": "Mr.",
−
      "Email2": "",  
+
    "stateOrProvince": "IL",
−
      "Street2": ""
+
    "street1": "100 Main St.",
−
  },
+
    "street2": ""
−
  {
+
  },
−
      "City": "Chicago",  
+
  "technical": {
−
      "FirstName": "John",  
+
    "city": "Chicago",
−
      "LastName": "Smith",  
+
    "countryCode": "US",
−
      "State": "IL",  
+
    "email1": "test@test.com",
−
      "Email": "test@test.com",  
+
    "email2": "",
−
      "Fax": "",  
+
    "fax": "",
−
      "Zip": "60001",  
+
    "firstName": "John",
−
      "Deleted": 0,
+
    "lastName": "Smith",
−
      "Company": "Hostway co",  
+
    "middleName": "",
−
      "Phone": "555-555-5501",  
+
    "phone1": "555-555-5501",
−
      "ContactType": "administrator",  
+
    "phone2": "",
−
      "AccountId": 100144677,
+
    "postalCode": "60001",
−
      "Phone2Clean": "",  
+
    "salutation": "Mr.",
−
      "MiddleName": "",  
+
    "stateOrProvince": "IL",
−
      "Country": "US",  
+
    "street1": "100 Main St.",
−
      "AccountNumber": "test-account11111",
+
    "street2": ""
−
      "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": ""
+
−
  }
+
−
]
+
 
  </nowiki>
 
  </nowiki>
  

Revision as of 08:11, 4 December 2013

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",
    "salutation": "Mr.",
    "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",
    "salutation": "Mr.",
    "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",
    "salutation": "Mr.",
    "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",
    "salutation": "Mr.",
    "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

{
  "regular": {
    "city": "Chicago",
    "countryCode": "US",
    "email1": "test@test.com",
    "email2": "",
    "fax": "",
    "firstName": "John",
    "lastName": "Smith",
    "middleName": "",
    "phone1": "555-555-5501",
    "phone2": "",
    "postalCode": "60001",
    "salutation": "Mr.",
    "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",
    "salutation": "Mr.",
    "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",
    "salutation": "Mr.",
    "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",
    "salutation": "Mr.",
    "stateOrProvince": "IL",
    "street1": "100 Main St.",
    "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


blog comments powered by Disqus

Retrieved from "http://docs.hostway.com/index.php?title=Accounts-accountId-Contacts:GET&oldid=1118"
Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox