API Docs
Cancel user request
Contents
This Web service cancels a specific user request.
Resource URL
DELETE /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 |
|---|---|---|---|
reason | xs:string | Required | Code of the cancel reason. Must be a value from the code table 'RequestCancellationReasons' |
note | xs:string | Optional. | Note with additional information regarding the cancellation. |
notify_user | xs:boolean | Optional. Default: true | Boolean flag for notifying the requester of the cancellation (when relevant). Defaults to 'true'. |
Body Parameters
None
Output
This method returns HTTP 204 (No Content) which means that the server successfully processed the request, but is not returning any content.
Possible Error Codes
| Code | Message |
|---|---|
| 401890 | User with identifier X of type Y was not found. |
| 401694 | Request Identifier not found. |
| 401652 | General Error: An error has occurred while processing the request. |
| 60340 | The request is API Restricted by library. |
| 60258 | The API Restricted profile is not valid. |