Vehicle statuses

Vehicle statuses describe the acceptable status values for a Vehicle.

Supported Vehicle statuses are available via the following API request:

GET /api/beta/vehicle-statuses

Example response:

{
	"vehicle_statuses": [
		{
			"key": "unavailable",
			"description": "Vehicle is not available"
		},
		{
			"key": "available",
			"description": "Vehicle is available"
		}
	]
}
  • vehicle_statuses - (array) List of supported vehicle status values
  • vehicle_statuses[].key - (string) The Vehicle status key that should be used in other APIs
  • vehicle_statuses[].description - (string) Short human readable description of the Vehicle status

It is recommended that your application periodically refresh any local caches of this information from this API, to ensure you are working with the most up-to-date data.

See also