Last updated 3 months ago

Data Format - External Attributes

Example

On the previous page, you saw the basic structure of a message we will send you. In the following example we expanded all keys in the externalAttributes object. In the table underneath we give a short description on every key

{
  "id": "66b99f4c-b9d3-5af7-b2ca-9baa98fd50fc",
  "name": "DCT|2020|43-4-109",
  "externalAttributes": {
    "displayName": "DCT|43-4-109",
    "plannedStart": "2020-10-13T23:19Z",
    "groupingAddressIdentifier": "46553",
    "oneWay": "false",
    "requestedTractorType": "EURO_13_60",
    "insertDate": "2020-10-13T14:27:53.977Z",
    "administrativeKm": "62",
    "requestedVehicleType": "EURO_13_60",
    "plannedEnd": "2020-10-14T02:02Z",
    "cancelled": "false",
    "department": "DCT-PJ",
    "customer_data_taskNumber": "3556",
    "mutated": "false",
    "plannedDeparture": "2020-10-13T23:59Z",
    "requestedFuelType": "EURO_6_DIESEL",
    "planningLastModified": "2020-10-14T00:22:29.315Z",
    "activity": "NOT_EXECUTED",
    "routeNumber": "43-4-109",
    "superLorry": "false",
    "requestedTrailerType": "EURO_13_60",
    "administrativeTime": "02:43",
    "realizedLicensePlate": "47-ABC-3",
    "totalVolume": "0.0",
    "requestedVehicleCapacity": "54.0"
  },
  "vehicle": {},
  "actors": [],
  "actions": []
}
routeNumber
string

Number of route.

department
string

Categorisation, typically the location from where trip is driven / managed. The name of the GroupingAdress

displayName
string

Trip name as shown in the triplist of the Control Tower

tripAlternativeId
string

Space for an additional id for the trip. Often needed for trips that have been combined from the source (like superlorry's)

plannedStart
timestamp

Planned start time of the trip, can differ from the start time of the first stop due for administrative purposes

plannedDeparture
timestamp

Planned start time of the trip as the moment were driving starts. Is a fixed expected time for the ETA-calculations when vehicle is still on the first stop

plannedEnd
timestamp

Planned end time of the trip, can differ from the start time of the first stop due for administrative purposes

groupingAddressIdentifier
number

locationId of the startinglocation, as used in general notifications to arrivaldisplay for stores

oneWay
boolean

Indicates if trip has a return center and thus, if an error should be thrown if individual stops want to return items

plannedLicensePlate
string

License plate of the originally planned tracking device (typically of the tractor)

plannedLicensePlateTrailer
string

License plate of the originally planned trailer

requestedTractorType
string

Tractor type as requested by the shipper to the carrier

requestedTrailerType
string

Trailer type as requested by the shipper to the carrier

requestedFuelType
string

Fuel type of the tractor / combination as requested by the shipper to the carrier

requestedVehicleCapacity
string

Trailer capacity (typically volume) as requested by the shipper to the carrier

insertDate
timestamp

Original insertion date of the trip in the control tower

administrativeTime
string

For administration only, we don't do any interpretation here

administrativeKm
number

For administration only, we don't do any interpretation here

cancelled
boolean

Indicates if trip as a whole has been cancelled. If true, individual stops don't need the indicator, but should be considered cancelled

customer_data_taskNumber
string

Background information typically used to connect trips together when they have been suggested to be driven by the same vehicle by the shipper to the carrier, whilst not binding.

mutated
boolean

Indicates if some planning fields have been overwritten

planningLastModified
timestamp

Date and time of the last planning modification

activity
string

Current activity of the vehicle based on our interpretation, changes during execution. We use a fixed set of options here, including 'unknown' when we are not certain (yet)

superlorry
boolean

Indicates if executed with multiple trailers behind one tractor. In Dutch this would be: LZV

remark
string

Remark on the trip level. Is typically filled when loading the planning. Is always shared with the planning, so to all parties

totalVolume
number

For administration only, we don't do any interpretation here

tripTags
array

Defines what's special (too early / too late) and whether or not certain user actions have been done / managed (mutated / snoozed)