DispatchOne Solution
...
Vehicle API
Integrate with Vehicles
How to: Change State of a Vehicle
1min
For information about prerequisites, see Creating Vehicle.
To change the state of a Vehicle, call the Transition Vehicle State endpoint and pass the following parameters in the request body:
Member | Description |
---|---|
toState | One of the valid state codes: onboarding, active, deboarding, or inactive. |
reasonCode (optional) | A valid reason code associated with the event. |
eventCode (optional) | Event Code of the transition event. |
Request bodies are specified in JSON format. The following example request body shows how to change the state of the Vehicle:
Updated 03 Aug 2023
Did this page help you?