API Docs

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

Retrieve user request

This Web service returns a request by a specific request id.

Resource URL

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

API Description

URL Parameters

ParameterTypeDescription
user_idxs:stringA unique identifier for the user
request_idxs:stringA unique identifier of the request that should be canceled.

Querystring Parameters

ParameterTypeRequiredDescription
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.

Body Parameters

None

Output

This method returns a User Request 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.