cancelServiceRequest
post
cancelServiceRequest
Resource URL
https://api-sandbox.arity.com/services/roadside/v1/rescue/reqId/{reqId}/cancel
Header Parameters
| Name | Values | Description |
|---|---|---|
| Content-Type |
|
|
|
Authorization
(required) |
Bearer Token generated from OAuth API (client_credentials grant) |
Request Body
{{"sessionId": "",
"reason": ""
}
reqId Request id produced from a successful response of the create service API. true
Make a request and see the response.
Make a request and see the response.
Make a request and see the response.
Response Error Details
-
HTTP CodeError CodeDescription
-
400400
Bad Request response
-
401401
Unauthorized response
-
500500
Service Error response
Resource Summary |
|
|
Security |
None |
|
Category |
Dispatch & Track Rescue |
| Name | Type | Description |
|---|---|---|
| sessionId | string | (Required) The session ID to be canceled |
| reason | string | (Optional) Reason for cancelling service (Service not needed, ETA to long etc |
| Name | Type | Description |
|---|---|---|
| status | string | The status for the request is set to OK when when the cancel succeeds |
| message | string | Message provide insight into the request (Service Cancelled Successfully) |
Working...