API Docs

__METHOD= GET . __PATH= /almaws/v1/task-lists/rs/lending-requests .

Get Lending Requests

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

ParameterTypeRequiredDescription
libraryxs:stringOptional.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.
statusxs:stringOptional.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.
printedxs:stringOptional.The 'printed' value of lending requests to retrieve. Optional. Possible values: Y, N.
reportedxs:stringOptional.The 'reported' value of lending requests to retrieve. Optional. Possible values: Y, N.
partnerxs:stringOptional.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_formatxs:stringOptional.Requested format of the resource. Optional. List of possible formats can be retrieved using the GET almaws/v1/conf/code-tables/RequestFormats API.
supplied_formatxs:stringOptional.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

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