Update Vehicle State

Path Params
string
required
integer
required
Body Params
enum
Defaults to removed

https://github.com/openmobilityfoundation/mobility-data-specification/blob/main/general-information.md#vehicle-states This table describes the list of vehicle conditions that may be used by regulators to assess the disposition of individual vehicles and fleets of vehicles. Some of these states describe vehicles in the Public Right-of-Way (PROW), and others represent vehicles that are not. One state (unknown) implies that PROW status is unknown.

In a multi-jurisdiction environment, the status of a vehicle is per-jurisdiction. For example, a vehicle may be in the on_trip status for a county that contains five cities, and also in the on_trip status for one of those cities, but elsewhere for the other four cities. In such a condition, generally a Provider would send the device data to the over-arching jurisdiction (the county) and the vehicle state with respect to each city would be determined by the Agency managing the jurisdictions.

vehicle_stateIn PROW?Description
removednoExamples include: at the Provider's warehouse, in a Provider's truck, or destroyed and in a landfill.
availableyesAvailable for rental via the Provider's app. In PROW.
non_operationalyesNot available for rent. Examples include: vehicle has low battery, or currently outside legal operating hours.
reservedyesReserved via Provider's app, waiting to be picked up by a rider.
on_tripyesIn possession of renter. May or may not be in motion.
elsewherenoOutside of regulator's jurisdiction, and thus not subject to cap-counts or other regulations. Example: a vehicle that started a trip in L.A. has transitioned to Santa Monica.
unknownunknownProvider has lost contact with the vehicle and its disposition is unknown. Examples include: taken into a private residence, thrown in river.
Allowed:
Responses

Language
Credentials
OAuth2
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json