API Docs

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

Create user loan

This web service loans an item to a user. The loan will be created according to the library's policy.

Resource URL

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

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
user_idxs:stringRequiredA unique identifier of the loaning user. Mandatory.
user_id_typexs:stringOptional. Default: all_uniqueThe type of identifier that is being searched. Optional. If this is not provided, all unique identifier types are used. The values that can be used are any of the values in the User Identifier Type code table.

Body Parameters

This method takes a Loan object. See doc

Output

This method returns a Item Loan object. See doc

Possible Error Codes

CodeMessage
401890User with identifier X of type Y was not found.
401153Item cannot be loaned from this circulation desk.
401651Item is not loanable.
401652General Error - An error has occurred while processing the request.