API Docs

__METHOD= POST . __PATH= /almaws/v1/users/{user_id}/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/users/{user_id}/loans

API Description

URL Parameters

ParameterTypeDescription
user_idxs:stringA unique identifier for the user

Querystring Parameters

ParameterTypeRequiredDescription
item_pidxs:stringOptional.The Item ID. This parameter or the item_barcode parameter must be supplied.
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.
item_barcodexs:stringOptional.The Item barcode. This parameter or the item_pid parameter must be supplied.
generate_linked_userxs:stringOptional. Default: falseBoolean flag to indicate whether to search the user in the network and create a linked user. This is only supported for networks that have fully unique patron identifiers. To enable this parameter, please contact Ex Libris customer support.

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.
401672PID field is empty.
401652General Error: An error has occurred while processing the request.
60340The loan is API Restricted by library.
60258The API Restricted profile is not valid.