Dispatch Module
POST /ext/dispatch/{id}/status

cancel an existing dispatch

Path parameters

  • id string Required

    ID of the dispatch to use

application/json

Body

  • status string

    cancelled status input

    Value is cancelled.

  • ref_id string

    unique identifier of the user cancelling a dispatch

  • ref_type string

    Value is user.

Responses

  • 204

    successful operation

  • 401 application/json

    Unauthorized if incorrect api_key is given

    Hide response attributes Show response attributes object
    • error string

      generic information about the error

    • error_desc string

      error information for the developer
  • 404 application/json

    if the dispatch id is not found in the system

    Hide response attributes Show response attributes object
    • error string

      generic information about the error

    • error_desc string

      error information for the developer
  • 500 application/json

    any other errors from the server

    Hide response attributes Show response attributes object
    • error string

      generic information about the error

    • error_desc string

      error information for the developer
POST /ext/dispatch/{id}/status 
curl \
 --request POST 'https://dev.hubz.nyotek.com/ext/dispatch/{id}/status' \
 --header "Content-Type: application/json" \
 --data '{"status":"cancelled","ref_id":"15ed2668-f118-40c3-a52c-8ad90fe11ed7","ref_type":"user"}'
Request examples 
{
  "status": "cancelled",
  "ref_id": "15ed2668-f118-40c3-a52c-8ad90fe11ed7",
  "ref_type": "user"
}
Response examples (401) 
{
  "error": "generic error",
  "error_desc": "identifier 45 not found"
}
Response examples (404) 
{
  "error": "generic error",
  "error_desc": "identifier 45 not found"
}
Response examples (500) 
{
  "error": "generic error",
  "error_desc": "identifier 45 not found"
}