API Docs

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

Retrieve user requests

This Web service returns list of requests for a specific user.

Resource URL

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

API Description

URL Parameters

ParameterTypeDescription
user_idxs:stringA unique identifier for the user

Querystring Parameters

ParameterTypeRequiredDescription
request_typexs:stringOptional.Filter results by request type. Optional. Possible values: HOLD, DIGITIZATION, BOOKING. If not supplied, all request types will be returned.
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.
limitxs:intOptional. Default: 10Limits the number of results. Optional. Valid values are 0-100. Default value: 10.
offsetxs:stringOptional. Default: 0Offset of the results returned. Optional.Default value: 0, which means that the first results will be returned.
statusxs:stringOptional. Default: activeActive or History request status. Default is active. The 'history' option is only available if the 'should_anonymize_requests' customer parameter is set to 'false' at the time the request was completed.

Body Parameters

None

Output

This method returns a User Requests object. See doc

Possible Error Codes

CodeMessage
401890User with identifier X of type Y was not found.
401652General Error - An error has occurred while processing the request.