PersonContactHandler
This class provides RESTful services to get contact details, register a person as a member, and update a member.
Method Name | HTTP Method | URL | Query Parameters | Description | Authentication | Example |
---|---|---|---|---|---|---|
getAllPersonContact | GET | store/{storeId}/person/@self/contact/ | addressType={addressType}&responseFormat={responseFormat} | Gets the contacts in a person's address book. If the addressType optional query parameter is passed in, the returned contacts are filtered by addressType. | Yes, HTTPS | Sample |
findPersonContactById | GET | store/{storeId}/person/@self/contact/byAddressId/{addressId} | responseFormat={responseFormat} | Gets a person contact by address ID. | Yes, HTTPS | Sample |
findPersonContactByNickName | GET | store/{storeId}/person/@self/contact/{nickName} | responseFormat={responseFormat} | Gets a person contact by nick name. | Yes, HTTPS | Sample |
addPersonContact | POST | store/{storeId}/person/@self/contact/ | responseFormat={responseFormat} | Creates a new contact in a person's address book. | Yes, HTTPS | Sample |
updatePersonContact | PUT | store/{storeId}/person/@self/contact/{nickName} | responseFormat={responseFormat} | Updates the contact in the address book identified by nickName. | Yes, HTTPS | Sample |
deletePersonContact | DELETE | store/{storeId}/person/@self/contact/{nickName} | responseFormat={responseFormat} | Deletes the contact in the address book identified by nickName. | Yes, HTTPS | Sample |