For Developers
Vehicles Overview
A vehicle is a piece of equipment that is used to transport people or goods.
Properties
Property | Type | Description |
---|---|---|
id | string | The UUID for the vehicle. $filter operators: equals in not in |
created_date | Date | When the vehicle was first seen by Edlink. |
updated_date | Date | When the vehicle was last changed in Edlink. $filter operators: equals gt lt gte lte |
properties | object | Non-standard properties that may be of interest to the developer. |
name | string | The name of the vehicle. |
type | VehicleType | The type of the vehicle. |
state | VehicleState | The operational state of the vehicle. |
capacity | number | The maximum number of passengers the vehicle can hold. |
fuelType | FuelType | The type of fuel used by the vehicle. |
vehicleCode | string | A code assigned to the vehicle for identification purposes. |
flags | VehicleFlag[] | The flags for the vehicle. All, some, or none of the possible flags may be included. |
comments | string | Useful comments about the vehicle. |
vehicle_identification_number | string | The unique identification number assigned to the vehicle. |
license_number | string | The license number assigned to the vehicle. |
last_operation_date | Date | The date of the last operation of the vehicle. |
last_safety_inspection_date | Date | The date of the last safety inspection of the vehicle. |
safety_inpsection_state | VehicleSafteyInspectionState | The safety inspection state of the vehicle. |
identifiers | Identifier[] | Additional IDs associated with the object. |
asset_id | string | The UUID of the associated Asset. |
JSON Example
{
"id": "123e4567-e89b-12d3-a456-426655440000",
"created_date": "2022-04-14T12:30:00.000Z",
"updated_date": "2022-04-14T12:30:00.000Z",
"properties": {},
"name": "Bus 1",
"type": "bus",
"state": "operational",
"capacity": 50,
"fuelType": "diesel",
"vehicleCode": "X1",
"flags": ["wheelchair-lift"],
"comments": "This bus is used for field trips and sports events.",
"vehicle_identification_number": "1HGBH41JXMN109186",
"license_number": "ABC1234",
"last_operation_date": "2022-04-01T08:00:00.000Z",
"last_safety_inspection_date": "2022-03-01T12:00:00.000Z",
"safety_inpsection_state": "current",
"asset_id": "00000000-0000-0000-0000-000000000000"
}