Realization data

Messages generated by the app are called "realization data" messages.

There are different types of realization data messages each generated in a different scenario. The different types of realization data messages are discribed in this chapter.

Types

There are different types of realization data messages. Each message is generated in a different scenario.

EntityReceived Message - This message is generated upon successfully receiving a trip message with action update in the app.
EntityDeleted Message - This message is generated upon successfully receiving a trip message with action delete in the app.
Location Message - This message is generated periodically for track-and-trace purposes.
Entity Message - This message is generated when the state of an Entity changes.
EntityAttachment Message - This message is generated to send pictures/signatures.
Activity Message - This message is generated when the current activity of the driver changes.
Chat Message - This message is generated when the driver sends a message using the messaging feature in the Drivers App
ETA Message - This message is generated when the ETA for a stop has been calculated
TachoTimes Message - This message can be generated when the state of an Entity changes.

Message structure

Each realization data messages always contains the fields described in the table below. Only the structure of the data field differs depending on the type of realization data message.

Field	Type	Description
type	string	The type of realization data message. Possible values are: `EntityReceived` for an EntityReceived Message `EntityDeleted` for an EntityDeleted Message `Location` for a Location Message `Entity` for an Entity Message `EntityAttachment` for an EntityAttachment Message `Activity` for an Activity Message `Chat` for a Chat Message `ETA` for a ETA Message `TachoTimes` for a TachoTimes Message
data	JSON object	The content of this field depends on the `type` of realization message. Please refer to the documentation for the different types of realization data messages for more details.
location	LocationObject	Contains information about the location where the message was generated. See LocationObject for more details.
origin	OriginObject	Contains information about where the message originated (device and driver). See OriginObject for more details.
vehicle	VehicleObject	Contains information about the vehicle. See VehicleObject for more details.
messageTime	string	ISO 8601 formatted timestamp of when the message was generated by the app.

LocationObject

The LocationObject contains information about where the message was generated.

The LocationObject consists of the fields described below.

Field	Nullable	Type	Description
latitude	false	double	The latitude coordinate of where the message was generated.
longitude	false	double	The longitude coordinate of where the message was generated.
speedMs	false	double	The speed of the vehicle in meters per second when the message was generated.
bearing	false	double	The bearing of the vehicle in degrees when the message was generated. The range of this value is [0, 360]. This field is present in Drivers App version 25.2.19 and higher

The example below contains a possible LocationObject

{
  "latitude": 52.2531361,
  "longitude": 5.4890928,
  "speedMs": 23.5,
  "bearing": 75.0
}

OriginObject

The OriginObject contains information about where the message originated (device and driver).

The OriginObject consists of the fields described below.

Field	Nullable	Type	Description
appId	false	integer	A unique identifier for an instance of the Drivers App running on a device
deviceId	false	string	The unique identifier of the device. Depending on the Android version the value of this field differs. Android 9 and below - The IMEI number of the device Android 10 and above - The Android ID of the device
driverNumber	false	string	The driver number as configured in the FleetControl backoffice.
coDriverNumber	true	string	The driver number of the co-driver as configured in the FleetControl backoffice.

The example below contains a possible OriginObject

{
  "appId": 60000153,
  "deviceId": "358240051111110",
  "driverNumber": "110",
  "coDriverNumber": "111"
}

VehicleObject

The VehicleObject contains information about the vehicle at the time of generating the message.

The VehicleObject consists of the fields described below.

Field	Nullable	Type	Description
licensePlate	true	string	The license plate of the vehicle. This field might me `null` when the vehicle is unknown.
odometer	true	integer	The odometer of the vehicle in kilometers. This field might be `0` if the odometer is unknown.

The example below contains a possible VehicleObject

{
  "licensePlate": "TE-ST-12",
  "odometer": 250000
}

Last modified: 22 July 2025