api/VendorContact/Query (POST)
Queries existing Vendors 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 Vendor Contacts.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| RequestData | This is a JSON object containing Vendor Contact query data.
Query Single Vendor Contact Using Key Fields Example:
{
"VENDOR_ID": "XYZCORP",
"VENDOR_CONTACT": "SGREEN"
}
Returns 1 Vendor Contact if successful.
This is like 'Find' in Expandable.
Query Multiple Vendor Contacts Using Other Fields Example:
{
"COUNTRY": "USA",
"STATE": "CA"
}
Returns 1 or more Vendor Contacts if successful.
This is like 'QBE' in Expandable.
Query Multiple Vendor Contacts Using QBE Conditional Notation Example:
{
"COUNTRY": "USA",
"STATE": "IN 'CA','NV'"
}
Returns 1 or more Vendor Contacts if successful.
This is like 'QBE' in Expandable.
Accepted Vendor Contact Fields:
ADDRESS_1, ADDRESS_2, ADDRESS_3, CELL_PHONE_NO,
CITY, CONTACT_STATUS, COUNTRY, CREATED_BY,
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, POFCT_USER_1, POFCT_USER_2,
POFCT_USER_3, POFCT_USER_4, POFCT_USER_5, POFCT_USER_6,
POFCT_USER_7, POFCT_USER_8, POFCT_USER_9, POFCT_USER_10,
POFCT_USER_11, POFCT_USER_12, POFCT_USER_13, POFCT_USER_14,
POFCT_USER_15, POFCT_USER_16, STATE, TIME_LAST_UPDT,
TITLE, VENDOR_CONTACT, VENDOR_ID, WEB_ADDRESS,
ZIP_CODE |
Define this parameter in the request body. |
Response Information
Success:200/OK
Body contains JSON array with found Vendor 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 Vendor Contact Fields:
ATTACHMENTS, ADDRESS_1, ADDRESS_2, ADDRESS_3, CELL_PHONE_NO, CITY, CONTACT_STATUS, COUNTRY, CREATED_BY, 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, POFCT_USER_1, POFCT_USER_2, POFCT_USER_3, POFCT_USER_4, POFCT_USER_5, POFCT_USER_6, POFCT_USER_7, POFCT_USER_8, POFCT_USER_9, POFCT_USER_10, POFCT_USER_11, POFCT_USER_12, POFCT_USER_13, POFCT_USER_14, POFCT_USER_15, POFCT_USER_16, STATE, TIME_LAST_UPDT, TITLE, VENDOR_CONTACT, VENDOR_ID, WEB_ADDRESS, ZIP_CODE