Contents

  1. General
  2. API methods
  3. Vehicle management report

General

General principle for clients is that the schema files are documentation over the data rather than a strict schema e.g. the clients need to handle new properties and the fact that enums could have values not matching schema.

More information and event details can be found realtime external api

API methods

/v1/VehicleReportsByDate/{date}

Get vehicle management reports for all vehicles at a given day. Response is an array of type: ReportVmb

/v1/VehicleEventsByDate/{date}

Get vehicle events for all vehicles at a given day. Response is an array of type: MsgVehicleEvent

/v1/PassengerCountersByDate/{date}

Get vehicle passenger counter reports for all vehicles at a given day. Response is an array of type: PassengerCountData

Vehicle management report

Vehicle time aggregated reports of signals and states for a time period. This will show complete list of signals, not all signals are available for every bus or customer.

Simplified sample


    {
        "Header": {
        "SequenceNumber": 1,
        "StartTimestamp": "2000-01-01T01:00:00+00:00",
        "EndTimestamp": "2000-01-01T02:00:00+00:00"
        },
        "Status": {
        "StatusFlags": [
            "MissingTotalVehicleDistance",
            "MissingTotalEngineHours",
            "MissingTotalFuelUsed",
            "MissingVehicleSpeed",
            "MissingEngineSpeed"
        ]
        },
        "Vehicle": {
        "ExternalId": "Example"
        },
        "Company": {
        "ExternalId": "Example"
        },
        "ParametersRelative": [
        {
            "Name": "StopCount",
            "Value": "5"
        },
        {
            "Name": "BrakeCount",
            "Value": "10"
        }
        ],
        "ParametersAbsolute": [
        {
            "Timestamp": "2000-01-01T02:00:00+00:00",
            "Name": "StopCount",
            "Value": "5000"
        },
        {
            "Timestamp": "2000-01-01T02:00:00+00:00",
            "Name": "BrakeCount",
            "Value": "10000"
        }
        ],
        "ParametersStates": [
        {
            "State": "Driving",
            "Counters": [
            {
                "Name": "Time",
                "Value": "0"
            },
            {
                "Name": "Fuel",
                "Value": "0"
            },
            {
                "Name": "Distance",
                "Value": "0"
            }
            ]
        },
        {
            "State": "Idling",
            "Counters": [
            {
                "Name": "Time",
                "Value": "0"
            },
            {
                "Name": "Fuel",
                "Value": "0"
            },
            {
                "Name": "Distance",
                "Value": "0"
            }
            ]
        }
        ],
        "ParametersIntervals": [
        {
            "Name": "Rpm",
            "Intervals": [
            {
                "From": "0",
                "To": "100",
                "Counters": [
                {
                    "Name": "Time",
                    "Value": "0"
                },
                {
                    "Name": "Fuel",
                    "Value": "0"
                },
                {
                    "Name": "Distance",
                    "Value": "0"
                }
                ]
            },
            {
                "From": "100",
                "To": "200",
                "Counters": [
                {
                    "Name": "Time",
                    "Value": "0"
                },
                {
                    "Name": "Fuel",
                    "Value": "0"
                },
                {
                    "Name": "Distance",
                    "Value": "0"
                }
                ]
            },
            {
                "From": "200",
                "Counters": [
                {
                    "Name": "Time",
                    "Value": "0"
                },
                {
                    "Name": "Fuel",
                    "Value": "0"
                },
                {
                    "Name": "Distance",
                    "Value": "0"
                }
                ]
            }
            ]
        }
        ],
        "Debug": {}
    }

Parameters relative

Aggregated counters and values that is resetted between reports.
Name Unit Description
AbsActivationCount
AdBlueUsed Liters
AlcolockPositiveCount
BrakCount
DieselEngineRunTime Seconds
DoorBladeOpenCount_[door]_[blade] Number of opening per door blade
ElectricalEngineTime Seconds
EspActivationCount
ExcessiveIdlingCount
ExcessiveIdlingTime Seconds
HarshAccelerationCount
HarshBrakingCount
HarshTurningCount
OverRevCount
OverspeedCount
RadioModeTime Seconds
StopCount
StopsWithDoorOpenCount

Parameters absolute

Total counter or value e.g. only reset when recomissioning.
Name Unit Description
AbsActicationCount
AlcolockPositiveCount
BrakeCount
DieselEngineRunTime Seconds
DoorOpenCount
DieselEngineStartCount
ElectricalEngineRunTime Seconds
EspActivationCount
IdleTime Seconds
TotalAdblueUsed Liters
TotalFuelUsed Liters Can contain up to two values. Initial value and final value and can be distinguished by timestamp.
TotalEngineHours Hours
TotalVehicleDistance Meters Can contain up to two values. Initial value and final value and can be distinguished by timestamp.
StopCount
StopsWithDoorOpenCount

Extensions/Customization

Name Unit Description
AntifreezeLevel Percentage
BikeRackCount
BrakeWearLeft0Mm Millimeters
BrakeWearLeft0Percent Percentage
BrakeWearRight0Mm Millimeters
BrakeWearRight0Percent Percentage
BrakeWearLeft1Mm Millimeters
BrakeWearLeft1Percent Percentage
BrakeWearRight1Mm Millimeters
BrakeWearRight1Percent Percentage
BrakeWearLeft2Mm Millimeters
BrakeWearLeft2Percent Percentage
BrakeWearRight2Mm Millimeters
BrakeWearRight2Percent Percentage
TimeInRun Seconds Time in run mode
TimeInLight Seconds Time in lightm ode
TimeInAccessory Seconds Time in accessory
TimeCentralHeat Seconds Time with central heater on
TimeInAuxiliary Seconds Time in auxiliary
TimeInDRT Seconds Time in daylight running time
TimeDestinationUse Seconds Destination sign use time
TimeFloorHeaterBlower Seconds
TimeCompressorUse Seconds
TimeInAC Seconds Air conditioner use time
TimeWiperOn Seconds
TotalDieselExhaustFluid Liters
EngineUseDistance Meters
TransmissionUseTime Seconds
DoorCycleFront
DoorCycleMiddle
DoorCycleRear
HighBeamHeadLightTime Seconds
LowBeamHeadLightTime Seconds
CompressorDutyCycle
WheelchairRampCycles
DieselExhaustFluidLevel Percentage
FrontLeftTirePsi Psi Pressure
FrontLeftTireDeg Degree Angle
FrontLeftTirePercent Percentage
FrontRightTirePsi Psi Pressure
FrontRightTireDeg Degree Angle
FrontRightTirePercent Percentage
MiddleLeftTirePsi Psi Pressure
MiddleLeftTireDeg Degree Angle
MiddleLeftTirePercent Percentage
MiddleRightTirePsi Psi Pressure
MiddleRightTireDeg Degree Angle
MiddleRightTirePercent Percentage
MiddleLeftTirePercent Percentage
RearLeftOutsideTirePsi Psi Pressure
RearLeftOutsideTireDeg Degree Angle
RearLeftOutsideTirePercent Percentage
RearRightOutsideTirePsi Psi Pressure
RearRightOutsideTireDeg Degree Angle
RearRightOutsideTirePercent Percentage
RearLeftInsideTirePsi Psi Pressure
RearLeftInsideTireDeg Degree Angle
RearLeftInsideTirePercent Percentage
RearRightInsideTirePsi Psi Pressure
RearRightInsideTireDeg Degree Angle
RearLeftInsideTirePercent Percentage
TimeInACCompressorStatus Seconds
TimeInACOperationStatus Seconds
TimePassengerZoneEvapBlowers Seconds
DoorCycles
FogMakerCycles
EmergencySwitchFrontDoorCycles
EmergencySwitchRearDoorCycles
DeactiveOfFireExtSystemCycles
ACFailureStatusCycles
DriverSwitchOverdriveFailureCycles
LockStatusDoor1Cycles
OpenStatusDoor1Cycles
EnableStatusDoor1Cycles
LockStatusDoor2Cycles
OpenStatusDoor2Cycles
EnableStatusDoor2Cycles

Parameter states

Relative parameters/counters when vehicle is within a certain logical state. Parameters/counters
Name Unit Description
Time Seconds
Fuel Liters
Distance Meters

Parameters intervals

Relative parameters/counters per interval slots. Parameters/counters
Name Unit Description
Time Seconds
Fuel Liters
Distance Meters