api/CustomerContact/Query (POST)

Queries existing Customers Contacts using the provided query data.
HTTP Method: POST
Required Fields: At least one field as search criteria
Requires an Authentication Token in the AuthToken HTTP header. Authentication Tokens are obtained from api/Security/Login (POST).
Returns all found Customer Contacts.

Request Information

Parameters

NameDescriptionAdditional information
RequestData 
This is a JSON object containing Customer Contact query data.

Query Single Customer Contact Using Key Fields Example:
{
  "CUSTOMER_ID": "ABCCORP",
  "CUST_CONTACT": "JHERNANDEZ"
}
Returns 1 Customer Contact if successful.
This is like 'Find' in Expandable.

Query Multiple Customer Contacts Using Other Fields Example:
{
  "COUNTRY": "USA",
  "STATE": "CA"
}
Returns 1 or more Customer Contacts if successful.
This is like 'QBE' in Expandable.

Query Multiple Customer Contacts Using QBE Conditional Notation Example:
{
  "COUNTRY": "USA",
  "STATE": "IN 'CA','NV'"
}
Returns 1 or more Customer Contacts if successful.
This is like 'QBE' in Expandable.

Accepted Customer Contact Fields:
ADDRESS_1, ADDRESS_2, ADDRESS_3, CELL_PHONE_NO, 
CITY, CONTACT_STATUS, COUNTRY, CREATED_BY, 
CUST_CONTACT, CUSTOMER_ID, DATE_CREATED, DATE_LAST_UPDT, 
DATE_MODIFIED, E_MAIL, E_MAIL_2, FAX_NO, 
FIRST_NAME, INITIAL, LAST_NAME, MAIL_STOP, 
MODIFIED_BY, OPERATOR_ID, PAGER_NO, PHONE_NO, 
SLX_ID, SOFCT_USER_1, SOFCT_USER_2, SOFCT_USER_3, 
SOFCT_USER_4, SOFCT_USER_5, SOFCT_USER_6, SOFCT_USER_7, 
SOFCT_USER_8, SOFCT_USER_9, SOFCT_USER_10, SOFCT_USER_11, 
SOFCT_USER_12, SOFCT_USER_13, SOFCT_USER_14, SOFCT_USER_15, 
SOFCT_USER_16, STATE, TIME_LAST_UPDT, TITLE, 
WEB_ADDRESS, ZIP_CODE

Define this parameter in the request body.

Response Information

Success:
200/OK
Body contains JSON array with found Customer Contacts.

Error:
400/Request JSON is invalid.
401/AuthToken was not provided.
401/AuthToken is malformed.
401/AuthToken is expired.
401/AuthToken login failure.
500/(Message)
Body contains JSON object with Message and MessageCode.

Returned Customer Contact Fields:
ATTACHMENTS, ADDRESS_1, ADDRESS_2, ADDRESS_3, CELL_PHONE_NO, CITY, CONTACT_STATUS, COUNTRY, CREATED_BY, CUST_CONTACT, CUSTOMER_ID, DATE_CREATED, DATE_LAST_UPDT, DATE_MODIFIED, E_MAIL, E_MAIL_2, FAX_NO, FIRST_NAME, INITIAL, LAST_NAME, MAIL_STOP, MODIFIED_BY, NOTES, OPERATOR_ID, PAGER_NO, PHONE_NO, SLX_ID, SOFCT_USER_1, SOFCT_USER_2, SOFCT_USER_3, SOFCT_USER_4, SOFCT_USER_5, SOFCT_USER_6, SOFCT_USER_7, SOFCT_USER_8, SOFCT_USER_9, SOFCT_USER_10, SOFCT_USER_11, SOFCT_USER_12, SOFCT_USER_13, SOFCT_USER_14, SOFCT_USER_15, SOFCT_USER_16, STATE, TIME_LAST_UPDT, TITLE, WEB_ADDRESS, ZIP_CODE