Item Status
SCSB uses the IMS Item Status API to check the status of item in the IMS and process accordingly for any requests, such as Retrieval, Recall or EDD. The API is also used in the Refile process and Status Reconciliation process. This API is called whenever there is a need to check the status of an item in the Storage Location IMS System.
The IMS will accept JSON-encoded REST GET calls to retrieve the status of an item. Given a barcode, the itemStatus API will return the item’s owner and a string describing the item’s status in the IMS system.
Request format for item status
{ "itemStatus": [ { "itemBarCode": "string" } , { "itemBarCode": "string" } ... ] }
Response format for item status
{ "dsitem": { "prods:hasChanges": boolean, # IGNORE "prods:before":{ JSON data } # IGNORE "ttitem": [ { "itemBarcode":"string", "itemStatus":"string", "CustomerCode":"string" } , { "itemBarcode":"string", "itemStatus":"string", "CustomerCode":"string" } ... ], } }
Sample items status call
curl -G -g -o - http://$HOST/lasapi/rest/lasapiSvc/itemStatus --data-urlencode \ 'filter={ "itemStatus": [ { "itemBarCode": "AR00035602" } ] }'
Field Descriptions for itemStatus api call
JSON field | Description / Typical usage | Data Type | Field width |
---|---|---|---|
itemBarcode | Item barcode | alphanum | 20 |
CustomerCode | Storage Location IMS System's Owner code | alphanum | 3 |
itemStatus | Item Status | String | 40 |