For Developers

Vehicles Overview

A vehicle is a piece of equipment that is used to transport people or goods.

Properties

PropertyTypeDescription
idstringThe UUID for the vehicle.
$filter operators: equals in not in
created_dateDateWhen the vehicle was first seen by Edlink.
updated_dateDateWhen the vehicle was last changed in Edlink.
$filter operators: equals gt lt gte lte
propertiesobjectNon-standard properties that may be of interest to the developer.
namestringThe name of the vehicle.
typeVehicleTypeThe type of the vehicle.
stateVehicleStateThe operational state of the vehicle.
capacitynumberThe maximum number of passengers the vehicle can hold.
fuelTypeFuelTypeThe type of fuel used by the vehicle.
vehicleCodestringA code assigned to the vehicle for identification purposes.
flagsVehicleFlag[]The flags for the vehicle. All, some, or none of the possible flags may be included.
commentsstringUseful comments about the vehicle.
vehicle_identification_numberstringThe unique identification number assigned to the vehicle.
license_numberstringThe license number assigned to the vehicle.
last_operation_dateDateThe date of the last operation of the vehicle.
last_safety_inspection_dateDateThe date of the last safety inspection of the vehicle.
safety_inpsection_stateVehicleSafteyInspectionStateThe safety inspection state of the vehicle.
identifiersIdentifier[]Additional IDs associated with the object.
asset_idstringThe 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"
}