Vehicle Lifecycle

The Vehicle Lifecycle defines the states that a Vehicle can be in from when it is acquired to when it is retired. A Vehicle can move between different states on the basis of workflows set in the application using it.

A Vehicle has the following five lifecycle states:

  • Onboarding: The Vehicle data is being entered and/or verified.
  • Active:
    • Available: The Vehicle is operational and is available for use.
    • In-use: The Vehicle is operational and is already being assigned a task.
    • Unavailable: The Vehicle is operational but not available for use (to be used after repair, maintenance, etc. downtime).
  • Inactive: The Vehicle is not operational.
19201920

To transition a Vehicle from one state to another, call the PUT /vehicles/{vehicleId}/transition endpoint. Make sure all the state-transition rules are satisfied. Specify the following parameters in the request body:

Member

Description

toState

State to which you want to transition the Vehicle.

reasonCode (optional)

Reason code for transition.

data

Any data generated or associated with respect to event transition.

vehicleId (query parameter)

Participant ID of the Vehicle for which you are requesting the state transition.

The following example request body shows how to change the state of a Vehicle using the state transition endpoint:

{
  "toState": "active:available",
  "reasonCode": "R-123",
  "data": {}
}

State-transition rule

If a dispatch is added to a Vehicle it can't be moved to the inactive state.


Did this page help you?