API Docs
Retrieve user request
Contents
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
Parameter | Type | Description |
---|---|---|
user_id | xs:string | A unique identifier for the user |
request_id | xs:string | A unique identifier of the request that should be canceled. |
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. |
Body Parameters
None
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. |
401652 | General Error - An error has occurred while processing the request. |
60258 | The API Restricted profile is not valid. |