API Docs

__METHOD= POST . __PATH= /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid} .

Scan-in operation on item.

This web service allows to perform a Scan-in operation on an item.

Resource URL

POST /almaws/v1/bibs/{mms_id}/holdings/{holding_id}/items/{item_pid}

API Description

URL Parameters

ParameterTypeDescription
mms_idxs:stringThe Bib Record ID.
holding_idxs:stringThe Holding Record ID.
item_pidxs:stringThe Item ID.

Querystring Parameters

ParameterTypeRequiredDescription
opxs:stringRequiredThe operation that is to be performed. Currently, only option is: scan.
external_idxs:stringOptional. Default: falseExternal ID. Options: true or false.
request_idxs:stringRequiredThe request ID. Needed when item is not yet bound to a single request and there are multiple requests which scanned item can fulfill.
libraryxs:stringRequiredThe library code of the given circulation desk or department where the action is being performed.
circ_deskxs:stringRequiredThe circulation desk where the action is being performed.
departmentxs:stringRequiredThe department where the action is being performed.
work_order_typexs:stringRequiredThe work order type which is to be performed, or is being performed on the scanned in item.
statusxs:stringRequiredThe work order status to which we want to move the item. Optional input is defined by the work order type.
donexs:stringOptional. Default: falseWork order processing is completed on the item. Options: true or false.
auto_print_slipxs:stringOptional. Default: falseAutomatically print a slip. Options: true or false.
place_on_hold_shelfxs:stringOptional. Default: falsePlace on hold shelf. Options: true or false.
confirmxs:stringOptional. Default: falseConfirm the action on the item. Options: true or false.
register_in_house_usexs:stringOptional. Default: trueRegister in house uses. Options: true or false.

Body Parameters

None

Output

This method returns a Item object. See doc

Possible Error Codes

CodeMessage
401652General Error - An error has occurred while processing the request.