API Docs
Action on a request
Contents
This API performs an action on a request. Currently supported: moving digitization requests to their next step.
Resource URL
POST /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 |
|---|---|---|---|
op | xs:string | Optional. | The operation to be performed on the request. Mandatory. Currently only next_step is supported. |
release_item | xs:string | Optional. Default: false | Boolean flag for indicating whether to release the item from the request. |
Body Parameters
None
Output
This method returns a Request object. See doc
Possible Error Codes
| Code | Message |
|---|---|
| 401652 | General Error - An error has occurred while processing the request. |
| 401907 | Failed to find a request for the given request ID. |
| 402205 | Input parameter X (Y) is not numeric. |
| 401932 | Request X is not a Digitization request |
| 401933 | Cannot move forward in workflow. Request ID: X, Step: Y |
| 401934 | Move digitization request to next step in workflow has failed. Request ID: X |
| 401666 | X parameter is not valid. |