Data Format - Vehicle

Example

On the previous pages, you saw the basic structure of a message and all external attributes we might send you. In the following example we expanded all keys in the vehicle object. In general a vehicle is any entity which can move in between locations. It can be for instance a truck, a trailer, an airplane, a drone, or even something which has not been invented yet.

The vehicle object is optional; if present it contains data of the currently linked vehicle to the planning. At the moment of sending the data, this is the vehicle we have monitored for the realization data. In the table underneath we give a short description of every key.

Copy
Copied
{
  "id": "2a8af6c6-e4d5-5dfb-9532-e8b17c3ffd88",
  "name": "DCX|2020|32-2-888",
  "externalAttributes": {},
  "vehicle": {
    "entity": {
      "id": "8e410040-1b36-4179-a216-63fcd2e9c888",
      "externalAttributes": {
        "licensePlate": "31-ABC-3",
        "customerDeviceIdentifier": "TEST01",
        "externalDeviceIdentifier": "TEST01",
        "deviceName": "TEST01"
      },
      "vehicleType": "Tractor",
      "fuel": "EURO_5_DIESEL",
      "actors": [
        {
          "entity": {
            "id": "861355f1-24ec-3fe3-bd0e-9ddfb2fc6d3d",
            "name": "Hendricus Gillis"
          },
          "associationType": "inline"
        }
      ]
    },
    "associationType": "inline"
  },
  "actors": [],
  "actions": []
}

Vehicle entity scheme

associationType
string

See the basics for an explanation

object

Container object

id
string

Universally Unique Identifier to the vehicle

object
licensePlate
string

Licenseplate of the linked vehicle

deviceName
string

Reference to the device name as known in a source system (like an FMS)

customerDeviceIdentifier
string

The device identifier as known in a source system to the systems customer (typically the name displayed in the FMS)

externalDeviceIdentifier
string

The device identifier as known in a source system to uniquely identify in that source system (typically a less readable identifier unique in the involved FMS)

externalSystemIdentifier
string

Identifier for the source system where the vehicle information originates from

vehicleType
string

Vehicle type (typically type of the combination of tractor and trailer) as requested by the shipper to the carrier. So seperate types for fresh, frozen, inner city deliveries, and so on

fuel
string

Fuel type of the vehicle

Enum: "EURO_5_DIESEL" "EURO_5_DIESEL_EEV" "EURO_6_DIESEL" "HYBRIDE_DIESEL_EURO_5" "HYBRIDE_DIESEL_EURO_6" "CNG" "LNG" "LBM" "CBG" "EV" "DUAL_FUEL_LNG_DIESEL" "DUAL_FUEL_CNG_DIESEL" "DUAL_FUEL_LBM_DIESEL"
actors
object

A nested actors object