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

Copy

Copied

{
  "id": "2a8af6c6-e4d5-5dfb-9532-e8b17c3ffd88",
  "name": "DCX|2020|32-2-888",
  "externalAttributes": {
    "displayName": "DCX|32-2-888",
    "plannedStart": "2020-10-14T08:54Z",
    "groupingAddressIdentifier": "7",
    "oneWay": "false",
    "plannedLicensePlate": "31-ABC-3",
    "requestedTractorType": "CITY_11_20",
    "insertDate": "2020-10-13T14:27:57.885Z",
    "administrativeKm": "73",
    "plannedEnd": "2020-10-14T11:31Z",
    "cancelled": "false",
    "department": "DCX-VW",
    "customer_data_taskNumber": "2284",
    "mutated": "false",
    "plannedDeparture": "2020-10-14T09:24Z",
    "requestedFuelType": "EURO_6_DIESEL",
    "planningLastModified": "2020-10-14T08:45:17.761Z",
    "activity": "APPROACHING_START",
    "routeNumber": "32-2-888",
    "superLorry": "false",
    "administrativeTime": "02:37",
    "totalVolume": "0.0",
    "requestedVehicleCapacity": "45.0",
    "customer_<some_field>": "<some-customer-value>"
  },
  "vehicle": {},
  "actors": [],
  "actions": []
}

routeNumber	string Number of route.
department	string Categorisation, typically the location from where trip is driven / managed. The name of the GroupingAddress
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	string <date-time> Planned start time of the trip, can differ from the start time of the first stop due for administrative purposes
plannedDeparture	string <date-time> 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	string <date-time> Planned end time of the trip, can differ from the start time of the first stop due for administrative purposes
groupingAddressIdentifier	string 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
plannedFleetNumberTractor	string Planned vehicle customer identifier
requestedTractorType	string Tractor type as requested by the shipper to the carrier
requestedTractorNumber	string Tractor number as requested by the shipper to the carrier
requestedTrailerType	string Trailer type as requested by the shipper to the carrier Enum: "BAKWAGEN" "BAKWAGEN_KOEL" "BAKWAGEN_KOEL_COMBI" "BAKWAGEN_KLEIN" "BAKWAGEN_KLEIN_KOEL" "BAKWAGEN_KLEIN_KOEL_COMBI" "CITY_8_00" "CITY_8_00_KOEL" "CITY_8_00_KOEL_COMBI" "CITY_9_80" "CITY_9_80_KOEL" "CITY_9_80_KOEL_COMBI" "CITY_10_50" "CITY_10_50_KOEL" "CITY_10_50_KOEL_COMBI" "CITY_11_20" "CITY_11_20_KOEL" "CITY_11_20_KOEL_COMBI" "CITY_11_60" "CITY_11_60_KOEL" "CITY_11_60_KOEL_COMBI" "EURO_13_60" "EURO_13_60_KOEL" "EURO_13_60_KOEL_COMBI" "KORTE_CITY_8_85" "KORTE_CITY_8_85_KOEL" "KORTE_CITY_8_85_KOEL_COMBI" "TREKKER"
requestedTrailerNumber	string Trailer number as requested by the shipper to the carrier
requestedFuelType	string Fuel type of the tractor / combination as requested by the shipper to the carrier 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"
requestedVehicleType	string Vehicle type as requested by the shipper to the carrier
requestedVehicleCapacity	string Vehicle capacity (typically volume) as requested by the shipper to the carrier
superlorry	boolean Indicates if executed with multiple trailers behind one tractor. In Dutch this would be: LZV
insertDate	string <date-time> 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`, no stops and no actions should be realized.
mutated	boolean Indicates if some planning fields have been overwritten
planningLastModified	string <date-time> Date and time of the last planning modification
shift	string Customer defined name for a planning-shift
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
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.
activity	string Deprecated 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)
customerData	string Note that this field is not literally called customerData, but can be anything prefixed by customer_. This is data that comes out of the planning and Simacan simply sends through as is