API Docs

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

Cancel user request

This Web service cancels a specific user request.

Resource URL

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

API Description

URL Parameters

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

Querystring Parameters

reasonxs:stringRequiredCode of the cancel reason. Must be a value from the code table 'RequestCancellationReasons'
notexs:stringOptional.Note with additional information regarding the cancellation.
notify_userxs:booleanOptional. Default: trueBoolean flag for notifying the requester of the cancellation (when relevant). Defaults to 'true'.

Body Parameters



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

401890User with identifier X of type Y was not found.
401694Request Identifier not found.
401652General Error: An error has occurred while processing the request.
60340The request is API Restricted by library.
60258The API Restricted profile is not valid.