api/SerialNumber/Query (POST)
Queries existing Serial Numbers 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 Serial Numbers.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| RequestData | This is a JSON object containing Serial Number query data.
Query Single Serial Number Using Key Fields Example:
{
"PART_ID": "MOTOR003",
"SERIAL_NUMBER": "GC00004057"
}
Returns 1 Serial Number if successful.
This is like 'Find' in Expandable.
Query Multiple Serial Numbers Using Other Fields Example:
{
"STORES_CODE": "MS",
"STOCK_LOCATION": "ISLE 9/SHELF 3"
}
Returns 1 or more Serial Numbers if successful.
This is like 'QBE' in Expandable.
Query Multiple Serial Numbers Using QBE Conditional Notation Example:
{
"PART_ID": "MOTOR003",
"SERIAL_NUMBER": "BETWEEN GC00004050 AND GC00004060"
}
Returns 1 or more Serial Numbers if successful.
This is like 'QBE' in Expandable.
Accepted Serial Number Fields:
BATCH_NUMBER, BILL_TO_CUST, COMPANY_ID, CONTACT,
CREATED_BY, DATE_CONSIGNED, DATE_CREATED, DATE_LAST_UPDT,
DATE_MODIFIED, DATE_SCRAPPED, DWG_REV, ECN,
FROM_LOCATION, FROM_STORES, LAST_INVOICE, LAST_SERVICE,
LINE_NUMBER, LOCATION, LOT_ID, MODIFIED_BY,
NEXT_SERVICE, OFF_WARRANTY, ON_WARRANTY, OPERATOR_ID,
ORDER_ID, ORDER_REFERENCE, ORIG_SHIP_DATE, ORIG_SHIP_TO,
ORIG_SO_ID, PART_ID, PROGRAM_ID, RA_REASON,
REFERENCE, RETURNED_DATE, SERIAL_NUMBER, SERV_CONTRACT,
SHIP_TO_CUST, SHIP_TYPE, SHIPMENT_NO, SHIPPED_DATE,
SN_STATUS, SO_ID, SO_LINE_NO, SOFSN_USER_1,
SOFSN_USER_2, SOFSN_USER_3, SOFSN_USER_4, SOFSN_USER_5,
SOFSN_USER_6, SOFSN_USER_7, SOFSN_USER_8, SOFSN_USER_9,
SOFSN_USER_10, SOFSN_USER_11, SOFSN_USER_12, SOLD_TO_CUST,
STOCK_LOCATION, STORES_CODE, TIME_LAST_UPDT |
Define this parameter in the request body. |
Response Information
Success:200/OK
Body contains JSON array with found Serial Numbers.
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 Serial Number Fields:
ATTACHMENTS, BATCH_NUMBER, BILL_TO_CUST, COMPANY_ID, CONTACT, CREATED_BY, DATE_CONSIGNED, DATE_CREATED, DATE_LAST_UPDT, DATE_MODIFIED, DATE_SCRAPPED, DWG_REV, ECN, FROM_LOCATION, FROM_STORES, LAST_INVOICE, LAST_SERVICE, LINE_NUMBER, LOCATION, LOT_ID, MODIFIED_BY, NEXT_SERVICE, NOTES, OFF_WARRANTY, ON_WARRANTY, OPERATOR_ID, ORDER_ID, ORDER_REFERENCE, ORIG_SHIP_DATE, ORIG_SHIP_TO, ORIG_SO_ID, PART_ID, PROGRAM_ID, RA_REASON, REFERENCE, RETURNED_DATE, SERIAL_NUMBER, SERV_CONTRACT, SHIP_TO_CUST, SHIP_TYPE, SHIPMENT_NO, SHIPPED_DATE, SN_STATUS, SO_ID, SO_LINE_NO, SOFSN_USER_1, SOFSN_USER_2, SOFSN_USER_3, SOFSN_USER_4, SOFSN_USER_5, SOFSN_USER_6, SOFSN_USER_7, SOFSN_USER_8, SOFSN_USER_9, SOFSN_USER_10, SOFSN_USER_11, SOFSN_USER_12, SOLD_TO_CUST, STOCK_LOCATION, STORES_CODE, TIME_LAST_UPDT