API Docs
Create user request
Contents
This Web service creates a user's request for a library resource. The request can be for a physical item (request types: hold, booking), or a request for digitizing a file (request type: digitization). The request can be placed on title level or on item level.
Resource URL
POST /almaws/v1/users/{user_id}/requestsAPI 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. |
mms_id | xs:string | Optional. | The requested title. This parameter is mandatory if the request is in title level. |
item_pid | xs:string | Optional. | The requested item ID. This parameter is mandatory if the request is in item level. |
allow_same_request | xs:boolean | Optional. Default: false | Allow placing requests for items of the same title by the same user. Optional. Default and recommended: false |
Body Parameters
This method takes a Request object. See doc
Output
This method returns a User Request object. See doc
Possible Error Codes
| Code | Message |
|---|---|
| 401890 | User with identifier X of type Y was not found. |
| 401129 | No items can fulfill the submitted request. |
| 401895 | Pickup circulation desk with code X and library code Y was not found. |
| 401136 | Failed to save the request: Patron has active request for selected item. |
| 60308 | Delivery to personal address is not supported. |
| 60309 | User does not have address for personal delivery. |
| 60310 | Delivery is not supported for this type of personal address. |
| 60324 | Fulfillment network is not configured. |
| 60325 | Fulfillment network institution is not valid. |
| 60326 | Fulfillment network pickup library or pickup circulation desk is not valid. |
| 60327 | Fulfillment network pickup library or pickup circulation desk is required. |
| 401684 | Search for request physical item failed. |
| 60328 | Item for request was not found. |
| 60330 | Invalid partial digitization volume or issue. |
| 60331 | Failed to create request. |
| 401652 | General Error: An error has occurred while processing the request. |
| 60340 | The request is API Restricted by library. |
| 60258 | The API Restricted profile is not valid. |