Serial Number Cross Reference, Query
Queries existing Serial Number Cross References using the provided criteria and returns a list of found Serial Number Cross References.
URL
/api/serial-number-cross-reference-query
Request Method
POST
Expandable Program
SN Cross Reference Editor (JCESX)
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
{
"ASSEMBLY_ID": "PUMP002",
"COMPONENT_ID": "MOTOR003",
"AUTH_TOKEN": ""
}Full Request JSON
{
"ASSEMBLY_ID": "",
"ASSEMBLY_SN": "",
"COMPONENT_ID": "",
"COMPONENT_SN": "",
"START_DATE": "",
"END_DATE": "",
"ORDER_ID": "",
"LINE_NUMBER": "",
"REFERENCE": "",
"RA_REASON": "",
"COMMENT": "",
"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 Serial Number Cross References which were found by the query:
200/OK
Returned JSON contains the Serial Number Cross References which were found by the query:
[
{
"ASSEMBLY_ID": "",
"ASSEMBLY_SN": "",
"COMPONENT_ID": "",
"COMPONENT_SN": "",
"START_DATE": "",
"END_DATE": "",
"ORDER_ID": "",
"LINE_NUMBER": "",
"REFERENCE": "",
"RA_REASON": "",
"COMMENT": "",
"CREATED_BY": "",
"DATE_CREATED": "",
"MODIFIED_BY": "",
"DATE_MODIFIED": "",
"OPERATOR_ID": "",
"DATE_LAST_UPDT": "",
"TIME_LAST_UPDT": ""
}
]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 Serial Number Cross Reference 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 Serial Number Cross Reference query:
{
"MESSAGE": "",
"MESSAGE_CODE": ""
}