API Docs
Get Lending Requests
Contents
This API returns a list of lending requests in Alma
Resource URL
GET /almaws/v1/task-lists/rs/lending-requests
API Description
URL Parameters
None
Querystring Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
library | xs:string | Optional. | The resource sharing library for which lending requests should be retrieved. Mandatory. List of possible libraries can be retrieved using the GET /almaws/v1/conf/libraries API. |
status | xs:string | Optional. | The status of lending requests to retrieve. Optional. List of possible statuses can be retrieved using the GET almaws/v1/conf/code-tables/MandatoryLendingWorkflowSteps API and the GET almaws/v1/conf/code-tables/OptionalLendingWorkflowSteps API. |
printed | xs:string | Optional. | The 'printed' value of lending requests to retrieve. Optional. Possible values: Y, N. |
reported | xs:string | Optional. | The 'reported' value of lending requests to retrieve. Optional. Possible values: Y, N. |
partner | xs:string | Optional. | The partner value. Only lending requests from this partner should be retrieved. Optional. List of possible partners can be retrieved using the GET almaws/v1/partners API. |
requested_format | xs:string | Optional. | Requested format of the resource. Optional. List of possible formats can be retrieved using the GET almaws/v1/conf/code-tables/RequestFormats API. |
supplied_format | xs:string | Optional. | Supplied Format of the resource. Optional. List of possible formats can be retrieved using the GET almaws/v1/conf/code-tables/RequestFormats API. |
Body Parameters
None
Output
This method returns a Resource Sharing Requests 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. |