API Docs
Create user loan
Contents
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
Parameter | Type | Description |
---|---|---|
user_id | xs:string | A unique identifier for the user |
Querystring Parameters
Parameter | Type | Required | Description |
---|---|---|---|
item_pid | xs:string | Optional. | The Item ID. This parameter or the item_barcode parameter must be supplied. |
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. |
item_barcode | xs:string | Optional. | The Item barcode. This parameter or the item_pid parameter must be supplied. |
generate_linked_user | xs:string | Optional. Default: false | Boolean 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
Code | Message |
---|---|
401890 | User with identifier X of type Y was not found. |
401153 | Item cannot be loaned from this circulation desk. |
401651 | Item is not loanable. |
401672 | PID field is empty. |
401652 | General Error: An error has occurred while processing the request. |
60340 | The loan is API Restricted by library. |
60258 | The API Restricted profile is not valid. |