API Docs

Ex Libris Developer Network Alma Documentation REST APIs API Docs

Create user request

Resource URL
API Description
URL Parameters
Query string Parameters
Body Parameters
Output
Possible Error Codes

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.

TRY IT NOW

Resource URL

POST /almaws/v1/users/{user_id}/requests

API Description

WADL documentation: Download
Swagger (OpenAPI) documentation: Download

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	Required	The requested title. This parameter is mandatory if the request is in title level.
`item_pid`	xs:string	Required	The requested item ID. This parameter is mandatory if the request is in item level.

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.
401136	Failed to save the request: Patron has active request for selected item.
401652	General Error: An error has occurred while processing the request.