Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Item Status

...


SCSB uses the IMS Item Status Check 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 - Item Status
     API End Point : /sharedCollection/itemAvailabilityStatus



Code Block
languagejs
titleRequest format for item status
{ "itemStatus":
 [ 
   { "itemBarCode": "string" } 
   , { "itemBarCode": "string" }  ...
  ] 
}

...

Code Block
languagejs
titleSample 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


NOTES:  Use of Color

In field description tables, three colors are used:

JSON field

Description / Typical usage

Data Type

Field width

Green

Required input fields

alphanum

3

White

Optional input fields

alphanum

20

Blue

Output only

alphanum

16

  • Unless otherwise indicated, input fields are also output fields.
  • Some fields (such as the requestor first, middle and last name) are only conditionally required.  The notes associated with each call explains any such exceptional conditions