Difference between revisions of "Exchange Contact (Rest API)"
From Rackspace Email & Apps API
| Line 1: | Line 1: | ||
| − | == Contact == | + | == Exchange Contact == |
=== Index === | === Index === | ||
Revision as of 23:05, 29 August 2009
Exchange Contact
Index
URL:
[GET] /customers/(customer account number)/domains/(domain name)/ex/contacts
Description:
Returns a list of contacts under the domain.
Remarks:
For the text/xml format, refer to the following schema document: [Contacts.xsd]
Example:
get '/customers/12345678/domains/example.com/ex/contacts?size=100&page=1&contains=john', 'text/xml'
Errors:
| Description | HTTP Response Code | Sample Message |
|---|---|---|
| Format is invalid | 406 | Invalid format |
| Domain is not found | 404 | abc.com not found |
Show
URL:
[GET] /customers/(customer account number)/domains/(domain name)/ex/contacts/(contact name)
Description:
Returns the contact's details.
Remarks:
For the text/xml format, refer to the following schema document: [Contact.xsd]
Example:
get '/customers/12345678/domains/example.com/ex/contacts/alex.smith', 'text/xml'
Errors:
| Description | HTTP Response Code | Sample Message |
|---|---|---|
| Format is invalid | 406 | Invalid format |
| Domain is not found | 404 | abc.com not found |
| Contact is not found | 404 | Contact not found |
Add/Edit
URL:
Add: [POST] /customers/(customer account number)/domains/(domain name)/ex/contacts/(contact name)
Edit: [PUT] /customers/(customer account number)/domains/(domain name)/ex/contacts/(contact name)
Description:
Adds or edits the contact's details as specified. If the contact does not exist, use Add, if it does, use Edit.
| Field Name | Data Type | Description |
|---|---|---|
| displayName | string | Name of contact when displayed (Required for add) |
| externalEmail | string | Email address (Required for add) |
| isHidden | boolean | Whether the contact is hidden from the Global List |
| firstName | string | First name |
| lastName | string | Last name |
| jobTitle | string | Job title |
| company | string | Company |
| department | string | Department |
| businessnumber | string | Business phone number |
| homenumber | string | Home phone number |
| mobilenumber | string | Mobile phone number |
| faxnumber | string | Fax number |
| pagernumber | string | Pager number |
| addressLine1 | string | Street address |
| city | string | City |
| state | string | State |
| zip | string | Zip or postal code |
| country | string | Country |
| notes | string | Notes field |
Example:
post '/customers/12345678/domains/example.com/ex/contacts/alex.smith', 'text/xml',
{
'displayName' => 'Johnny Customer',
'externalEmail' => 'jonny@apple.com'
}
put '/customers/12345678/domains/example.com/ex/contacts/alex.smith', 'text/xml',
{
'externalEmail' => 'jonnysNewEmail@microsoft.com',
'company' => 'Microsoft',
'businessnumber' => '425 555 5555'
}
Errors:
| Description | HTTP Response Code | Sample Message |
|---|---|---|
| Format is invalid | 406 | Invalid format |
| Domain is not found | 404 | abc.com not found |
| Contact is not found | 404 | No user with the email address jane.doe@abc.com exists |
| New display name doesn't meet the naming requirements | 400 | Invalid display name |
| Boolean form field has non-boolean input | 400 | Invalid format for Enabled, input must be True or False |
| Form data has unrecognized field | 400 | Unrecognized field: size |
| Required form field is missing | 400 | Missing required field: displayName |
| Required form field has null or empty string input | 400 | Required field displayName cannot be empty |
| New display name doesn't meet the naming requirements | 400 | Invalid display name |
| New contact name (user name) already exists | 400 | The email address john.doe@abc.com is already in use |
| New contact name (user name) is reserved by Exchange | 400 | user name reserved |
Delete
URL:
[DELETE] /customers/(customer account number)/domains/(domain name)/ex/contacts/(contact name)
Description:
Deletes the contact.
Remarks:
Contact is deleted immediately without verification and data is lost permanently.
Example:
delete '/customers/12345678/domains/example.com/ex/contacts/alex.smith', 'text/xml'
Errors:
| Description | HTTP Response Code | Sample Message |
|---|---|---|
| Domain is not found | 404 | abc.com not found |
| Contact is not found | 404 | No user with the email address jane.doe@abc.com exists |
