API Docs

__METHOD= GET . __PATH= /almaws/v1/task-lists/requested-resources .

Get Requested Resources

This API returns a list of requested resources to be picked from the shelf in Alma

Resource URL

GET /almaws/v1/task-lists/requested-resources

API Description

URL Parameters

None

Querystring Parameters

ParameterTypeRequiredDescription
libraryxs:stringRequiredThe library of the given circulation desk or department where the resources are located. Mandatory.
circ_deskxs:stringRequiredThe circulation desk where the action is being performed. Mandatory.
locationxs:stringOptional.The location code. Optional.
order_byxs:stringOptional. Default: call_numberThe order in which to retrieve the results: location/call_number (default).
directionxs:stringOptional. Default: ascThe order direction in which to retrieve the results. Optional.
pickup_instxs:stringOptional.The pickup institution. Optional.
reportedxs:stringOptional.Show reported results: Y/N. Optional.
printedxs:stringOptional.Show printed results: Y/N. Optional.
limitxs:intOptional. Default: 10Limits the number of results. Optional. Valid values are 0-100. Default value: 10.
offsetxs:intOptional. Default: 0Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned.

Body Parameters

None

Output

This method returns a Requested Resources object. See doc

Possible Error Codes

CodeMessage
402119General error.
401664Mandatory field is missing: X.
40166414The parameter 'X' is mandatory. Valid options are: Y.