API Docs
Retrieve user loans
Contents
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
Parameter | Type | Description |
---|---|---|
user_id | xs:string | A unique identifier for the user |
Querystring Parameters
Parameter | Type | Required | Description |
---|---|---|---|
user_id_type | xs:string | Optional. Default: all_unique | The 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. |
limit | xs:int | Optional. Default: 10 | Limits the number of results. Optional. Valid values are 0-100. Default value: 10. |
offset | xs:int | Optional. Default: 0 | Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned. |
order_by | xs:string | Optional. Default: id | A 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. |
direction | xs:string | Optional. Default: ASC | Sorting direction: ASC/DESC. Default: ASC. |
expand | xs:string | Optional. | Comma separated list of values for expansion of results. Possible values: 'renewable' |
loan_status | xs:string | Optional. Default: Active | Active 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
Code | Message |
---|---|
401861 | User with identifier X was not found. |
401890 | User with identifier X of type Y was not found. |
401652 | General Error: An error has occurred while processing the request. |
60258 | The API Restricted profile is not valid. |