Cancel Request
The Cancel Request is the API that will be used by both partners and ReCAP users to cancel a request placed through SCSB. Partners will incorporate the API into their discovery systems to provide the patrons a way to cancel requests that have been raised by them. ReCAP users would use it through the SCSB UI to cancel requests that are difficult to process (an EDD request for a 1000 pages) and replace it with a physical delivery.
Parameters
Parameter | Data Type | Description |
|---|---|---|
| requestId | Integer | The request id is an unique id to identify the request data inside SCSB. This request id is returned after every successfully placed request through the SCSB request API. The end users (Partners/ReCAP) would persist this data at their end and use it to call this API if the need to cancel arises. |
Response - Cancel Request
{
"screenMessage": "Request cancellation succcessfully processed",
"success": true
}
Alternate Response - Cancel Request
{
"screenMessage": "RequestId is not active status to be canceled", // When Request Id is not active and has already been cancelled.
"success": false
}
Alternate Response - Cancel Request
{
"screenMessage": "RequestId does not exist", // When the Request Id does not exist.
"success": false
}