IMS - PERMANENT WITHDRAWAL - INDIRECT

PERMANENT WITHDRAWAL - INDIRECT

Storage Location IMS system will accept JSON-encoded REST calls to mark retrieve items as permanently withdrawn from Storage Location. The required fields are the owner code (CustomerCode) and the item barcode (itemBarcode).

Request format for permanent retrieval indirect

{ "dsitem":
  { "ttitem": [
    {
      // required fields
      "CustomerCode": "string"
      "itemBarcode": "string"
    }
    , { "CustomerCode": "string" ... } ...
  ] } // end of ttitem array   
}

Response format for permanent retrieval indirect

{ "dsitem":
  { "ttitem": [
    {
      // required fields
      "CustomerCode": "string"
      "itemBarcode": "string"
      “errorCode”: “string”
      “errorNote”: “string”
    }
    , { "CustomerCode": "string" ... } ...
  ] } // end of ttitem array   
}

The CustomerCode field must either match the owner code in the Storage Location IMS system, or must be mappable to it. The current documentation assumes that the actual Storage Location IMS system codes will be used.
The owner code is uttsed only for verification purposes. It is compared to the code stored in the Storage Location IMS system.

Error codes for permanentlyRetrieveItemIndirect

errorCode	errorNote	Description
itemNotOnFile		Item barcode not found in Storage Location IMS system
wrongCustCode	CustomerCode: XX	The supplied customer code does not match the one stored in Storage Location IMS system. The correct code is returned in the errorNote.
itemWithdrawn	Item status, if available. Otherwise, the message "Status unknown - possible reaccession" is returned. (This should never happen).	The item has been permanently withdrawn from Storage Location IMS system.
missingReqData	Comma-delimited list of required fields that were not supplied. If requestor data is missing, the field “requestor” is reported.	One or more required fields were empty
itemNotOut	Item status	Item is not “OUT” according to Storage Location IMS system, and therefore cannot be indirectly withdrawn.
InternalErr	The nature of the error that occurred.	Storage Location IMS system consistency error. These should never occur – but best practice requires they be tested for

Sample permanent retrieval indirect call

curl -i -X POST -H "Content-Type:application/json" \
  http://$HOST/lasapi/rest/lasapiSvc/permanentlyRetrieveItemIndirect \
  $HOST/permanentlyRetrieveItem -d \
  '{ "dsitem":{ "ttitem": [ 
     { "CustomerCode":"AR", "itemBarcode":"AR00051608" }
] }'

Field Descriptions for permanentlyRetrieveItemIndirect

JSON field	Description / Typical usage	Data Type	Field width
CustomerCode	Owner code	alphanum	3
itemBarcode	Item barcode	alphanum	20
errorCode	Error code (output only)	alphanum	16
errorNote	Additional detail (output only)	String	60

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