API Docs

__METHOD= GET . __PATH= /almaws/v1/users/{user_id}/loans .

Retrieve user loans

This Web service retrieves a list of active loans for a user.

Resource URL

GET /almaws/v1/users/{user_id}/loans

API Description

URL Parameters

ParameterTypeDescription
user_idxs:stringA unique identifier for the user

Querystring Parameters

ParameterTypeRequiredDescription
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.
limitxs:intOptional. Default: 10Limits the number of results. Optional. Valid values are 0-100. Default value: 10.
offsetxs:intOptional. Default: 0Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned.
order_byxs:stringOptional. Default: idA few sort options are available (only one can be sent): loan_date, due_date, barcode, title, author and return_date (relevant only for historical loans). A secondary sort key, id, is added to the single sort option chosen. Default sorting is by id.
directionxs:stringOptional. Default: ASCSorting direction: ASC/DESC. Default: ASC.
expandxs:stringOptional.Comma separated list of values for expansion of results. Possible values: 'renewable'
loan_statusxs:stringOptional. Default: ActiveActive or Completeloan status. Default: Active. The Complete loan status is only relevant if historic loans haven't been anonymized.

Body Parameters

None

Output

This method returns a User Loans object. See doc

Possible Error Codes

CodeMessage
401861User with identifier X was not found.
401890User with identifier X of type Y was not found.
401652General Error: An error has occurred while processing the request.
60258The API Restricted profile is not valid.