Customer Contact, Query
Queries existing Customer Contacts using the provided criteria and returns a list of found Customer Contacts.
URL
/api/customer-contact-query
Request Method
POST
Expandable Program
Customer Contact Editor (SOECT)
Required Fields
(at least one field to be used as query criteria)
AUTH_TOKEN
AUTH_TOKEN
Auth Token
This API call requires an Authentication Token ("Auth Token") for the required field AUTH_TOKEN. Auth Tokens are obtained from Auth Token, Get.
Example Request JSON
{
"COUNTRY": "US",
"STATE": "IN 'CA','NV'",
"AUTH_TOKEN": ""
}Full Request JSON
{
"CUSTOMER_ID": "",
"CUST_CONTACT": "",
"CONTACT_STATUS": "",
"FIRST_NAME": "",
"LAST_NAME": "",
"INITIAL": "",
"TITLE": "",
"MAIL_STOP": "",
"ADDRESS_1": "",
"ADDRESS_2": "",
"ADDRESS_3": "",
"CITY": "",
"STATE": "",
"ZIP_CODE": "",
"COUNTRY": "",
"PHONE_NO": "",
"FAX_NO": "",
"CELL_PHONE_NO": "",
"PAGER_NO": "",
"E_MAIL": "",
"E_MAIL_2": "",
"WEB_ADDRESS": "",
"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": "",
"CREATED_BY": "",
"DATE_CREATED": "",
"MODIFIED_BY": "",
"DATE_MODIFIED": "",
"OPERATOR_ID": "",
"DATE_LAST_UPDT": "",
"TIME_LAST_UPDT": "",
"AUTH_TOKEN": ""
}QBE Notation
This query uses Expandable Query By Example (QBE) Notation. QBE Notation allows for conditional query criteria.
Not Equal To:
Greater Than:
Greater Than Or Equal To:
Less Than:
Less Than Or Equal To:
Between:
In:
Wildcard (any length):
Wildcard (single character):
Not Equal To:
"SO_STATUS": "<>X"Greater Than:
"ON_HAND_QTY": ">0"Greater Than Or Equal To:
"EFFECTIVE_DATE": ">=2016-01-01"Less Than:
"AMOUNT": "<100"Less Than Or Equal To:
"DATE_APPROVED": "<=2019-05-30"Between:
"ORDER_QTY": "BETWEEN 10 AND 100"In:
"LOT_STATUS": "IN A,C"Wildcard (any length):
"PART_ID": "MOTOR%"Wildcard (single character):
"SERIAL_NUMBER": "GC0000406_"Success Response
Returned HTTP status indicates success:
200/OK
Returned JSON contains the Customer Contacts which were found by the query:
200/OK
Returned JSON contains the Customer Contacts which were found by the query:
[
{
"CUSTOMER_ID": "",
"CUST_CONTACT": "",
"CONTACT_STATUS": "",
"FIRST_NAME": "",
"LAST_NAME": "",
"INITIAL": "",
"TITLE": "",
"MAIL_STOP": "",
"ADDRESS_1": "",
"ADDRESS_2": "",
"ADDRESS_3": "",
"CITY": "",
"STATE": "",
"ZIP_CODE": "",
"COUNTRY": "",
"PHONE_NO": "",
"FAX_NO": "",
"CELL_PHONE_NO": "",
"PAGER_NO": "",
"E_MAIL": "",
"E_MAIL_2": "",
"WEB_ADDRESS": "",
"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": "",
"CREATED_BY": "",
"DATE_CREATED": "",
"MODIFIED_BY": "",
"DATE_MODIFIED": "",
"OPERATOR_ID": "",
"DATE_LAST_UPDT": "",
"TIME_LAST_UPDT": "",
"NOTES": "",
"ATTACHMENTS": ""
}
]Failure Response
Returned HTTP status indicates failure:
400/Request JSON is invalid.
401/Auth Token was not provided.
401/Auth Token is malformed.
401/Auth Token login failure.
405/Request method must be POST.
500/(Error Message)
Returned JSON contains error information for the failed Customer Contact query:
400/Request JSON is invalid.
401/Auth Token was not provided.
401/Auth Token is malformed.
401/Auth Token login failure.
405/Request method must be POST.
500/(Error Message)
Returned JSON contains error information for the failed Customer Contact query:
{
"MESSAGE": "",
"MESSAGE_CODE": ""
}