Search for Customer Contacts by Contact Name
Returns a list of contacts for the provided query parameters.
Method Type | URI |
---|---|
GET | v90/ws/contact.ws?firstName={firstName}&lastName={lastName} |
Example URL: http://hostname:8080/ems/v90/ws/contact.ws?firstName=Walter&lastName=White
URI Parameters
Parameter | Description | Type |
---|---|---|
firstName | First name of the contact. | String |
lastName | Last name of the contact. | String |
Sample Response
HTTP Status Code: 200
Success
Response Header:
X-Total-Count: The total number of entries. You can use X-Total-Count to calculate the total number of pages by dividing X-Total-Count by pageSize (X-Total-Count÷pageSize=number of pages). For example, suppose your application returns an X-Total-Count of 17 and the pageSize is 15. 17÷15=1.333 or 2 pages in total because each page includes a maximum of 15 entries. Similarly, suppose your application returns an X-Total-Count of 1103 and the pageSize is 15. 1103÷15=73.533 or 74 pages in total.
Response Body:
<listResponse type="contact" count="1"> <instance contactId="16" emailId="heisenberg@gmail.com" customerId="23" name="Walter Hartwell White" enabled="true" default="true" firstName="Walter" middleName="Hartwell" lastName="White" locale="en"/> </listResponse>
Failure
Response Body:
<listResponse type="contact" count="0"/>