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:stringOptional.The requested title. This parameter is mandatory if the request is in title level.
item_pidxs:stringOptional.The requested item ID. This parameter is mandatory if the request is in item level.
allow_same_requestxs:booleanOptional. Default: falseAllow 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


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.
401895Pickup circulation desk with code X and library code Y was not found.
401136Failed to save the request: Patron has active request for selected item.
60308Delivery to personal address is not supported.
60309User does not have address for personal delivery.
60310Delivery is not supported for this type of personal address.
60324Fulfillment network is not configured.
60325Fulfillment network institution is not valid.
60326Fulfillment network pickup library or pickup circulation desk is not valid.
60327Fulfillment network pickup library or pickup circulation desk is required.
401684Search for request physical item failed.
60328Item for request was not found.
60330Invalid partial digitization volume or issue.
60331Failed to create request.
401652General Error: An error has occurred while processing the request.
60340The request is API Restricted by library.
60258The API Restricted profile is not valid.