Expandable Web API - Lot, Query

Lot, Query

Queries existing Lots using the provided criteria and returns a list of found Lots.

URL

/api/lot-query

Request Method

POST

Expandable Program

Lot Master Editor (LTELM)

Required Fields

(at least one field to be used as query criteria)
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

{
  "PART_ID": "MOTOR003",
  "LOT_TYPE": "M",
  "LOT_STATUS": "IN 'A','C'",
  "AUTH_TOKEN": ""
}

Full Request JSON

{
  "PART_ID": "",
  "LOT_ID": "",
  "LOT_TYPE": "",
  "LOT_STATUS": "",
  "LOT_HOLD_CODE": "",
  "EXPIRE_DATE": "",
  "ORDER_ID": "",
  "LINE_NUMBER": "",
  "RETEST_DATE": "",
  "DWG_REV": "",
  "ECN": "",
  "MFG_VENDOR_ID": "",
  "MFG_ID": "",
  "MFG_NAME": "",
  "MFG_LOT_ID": "",
  "ORIGINAL_QTY": "",
  "DATE_LAST_ISSUE": "",
  "DATE_LAST_RECPT": "",
  "TXN_NOTE": "",
  "LTFLM_USER_1": "",
  "LTFLM_USER_2": "",
  "LTFLM_USER_3": "",
  "LTFLM_USER_4": "",
  "LTFLM_USER_5": "",
  "LTFLM_USER_6": "",
  "LTFLM_USER_7": "",
  "LTFLM_USER_8": "",
  "LTFLM_USER_9": "",
  "LTFLM_USER_10": "",
  "LTFLM_USER_11": "",
  "LTFLM_USER_12": "",
  "LTFLM_USER_13": "",
  "LTFLM_USER_14": "",
  "LTFLM_USER_15": "",
  "LTFLM_USER_16": "",
  "LTFLM_USER_17": "",
  "LTFLM_USER_18": "",
  "LTFLM_USER_19": "",
  "LTFLM_USER_20": "",
  "LTFLM_USER_21": "",
  "LTFLM_USER_22": "",
  "LTFLM_USER_23": "",
  "LTFLM_USER_24": "",
  "LTFLM_USER_25": "",
  "LTFLM_USER_26": "",
  "LTFLM_USER_27": "",
  "LTFLM_USER_28": "",
  "LTFLM_USER_29": "",
  "LTFLM_USER_30": "",
  "LTFLM_USER_31": "",
  "LTFLM_USER_32": "",
  "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:

"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 Lots which were found by the query:

[
  {
    "PART_ID": "",
    "LOT_ID": "",
    "LOT_TYPE": "",
    "LOT_STATUS": "",
    "LOT_HOLD_CODE": "",
    "EXPIRE_DATE": "",
    "ORDER_ID": "",
    "LINE_NUMBER": "",
    "RETEST_DATE": "",
    "DWG_REV": "",
    "ECN": "",
    "MFG_VENDOR_ID": "",
    "MFG_ID": "",
    "MFG_NAME": "",
    "MFG_LOT_ID": "",
    "ORIGINAL_QTY": "",
    "DATE_LAST_ISSUE": "",
    "DATE_LAST_RECPT": "",
    "TXN_NOTE": "",
    "LTFLM_USER_1": "",
    "LTFLM_USER_2": "",
    "LTFLM_USER_3": "",
    "LTFLM_USER_4": "",
    "LTFLM_USER_5": "",
    "LTFLM_USER_6": "",
    "LTFLM_USER_7": "",
    "LTFLM_USER_8": "",
    "LTFLM_USER_9": "",
    "LTFLM_USER_10": "",
    "LTFLM_USER_11": "",
    "LTFLM_USER_12": "",
    "LTFLM_USER_13": "",
    "LTFLM_USER_14": "",
    "LTFLM_USER_15": "",
    "LTFLM_USER_16": "",
    "LTFLM_USER_17": "",
    "LTFLM_USER_18": "",
    "LTFLM_USER_19": "",
    "LTFLM_USER_20": "",
    "LTFLM_USER_21": "",
    "LTFLM_USER_22": "",
    "LTFLM_USER_23": "",
    "LTFLM_USER_24": "",
    "LTFLM_USER_25": "",
    "LTFLM_USER_26": "",
    "LTFLM_USER_27": "",
    "LTFLM_USER_28": "",
    "LTFLM_USER_29": "",
    "LTFLM_USER_30": "",
    "LTFLM_USER_31": "",
    "LTFLM_USER_32": "",
    "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 Lot query:

{
  "MESSAGE": "",
  "MESSAGE_CODE": ""
}

Try the API