cancelServiceRequest

post

cancelServiceRequest

Cancel the initial request for service. The rescue can only be cancelled before the status is APPROACHING and the ETA is greater than 15 minutes

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

{
1
{
2
    "sessionId": "",
3
    "reason": ""
4
}
 

reqId Request id produced from a successful response of the create service API. true

HTTP Basic

OAuth 2.0

API Key

Reset

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 Code
    Error Code
    Description
  • 400
    400

    Bad Request response

  • 401
    401

    Unauthorized response

  • 500
    500

    Service Error response

Resource Summary

Security

None

Category

Dispatch & Track Rescue

Name Type Description
sessionIdstring(Required) The session ID to be canceled
reasonstring(Optional) Reason for cancelling service (Service not needed, ETA to long etc
Name Type Description
statusstringThe status for the request is set to OK when when the cancel succeeds
messagestringMessage provide insight into the request (Service Cancelled Successfully)

Working...

© 2019 Arity, LLC. All rights reserved.  | Privacy Policy | Terms of Use | Legacy APIs