API Docs
Get Requested Resources
Contents
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
Parameter | Type | Required | Description |
---|---|---|---|
library | xs:string | Required | The library of the given circulation desk or department where the resources are located. Mandatory. |
circ_desk | xs:string | Required | The circulation desk where the action is being performed. Mandatory. |
location | xs:string | Optional. | The location code. Optional. |
order_by | xs:string | Optional. Default: call_number | The order in which to retrieve the results: location/call_number (default). |
direction | xs:string | Optional. Default: asc | The order direction in which to retrieve the results. Optional. |
pickup_inst | xs:string | Optional. | The pickup institution. Optional. |
reported | xs:string | Optional. | Show reported results: Y/N. Optional. |
printed | xs:string | Optional. | Show printed results: Y/N. Optional. |
limit | xs:int | Optional. Default: 10 | Limits the number of results. Optional. Valid values are 0-100. Default value: 10. |
offset | xs:int | Optional. Default: 0 | Offset 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
Code | Message |
---|---|
402119 | General error. |
401664 | Mandatory field is missing: X. |
40166414 | The parameter 'X' is mandatory. Valid options are: Y. |