API Docs

__METHOD= POST . __PATH= /almaws/v1/users/{user_id}/requests .

Create user request

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}/requests

API Description

URL Parameters

user_idxs:stringA unique identifier for the user

Querystring Parameters

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.
mms_idxs:stringRequiredThe requested title. This parameter is mandatory if the request is in title level.
item_pidxs:stringRequiredThe requested item ID. This parameter is mandatory if the request is in item level.

Body Parameters

This method takes a Request object. See doc


This method returns a User Request object. See doc

Possible Error Codes

401890User with identifier X of type Y was not found.
401129No items can fulfill the submitted request.
401136Failed to save the request: Patron has active request for selected item.
401652General Error: An error has occurred while processing the request.