Last updated 3 months ago

Data Format - Actions

Example

Great that you made it so far already. In our previous pages, you saw the basic structure of a message, external attributes to a trip and vehicle and actor data we might send you. We have one object left, which is the most complicated with a lot of nested structures, the actions.

A single action describes that something is occurring at a specific time (whether in the past, present or future) and optionally at a specific location. Action events can typically be used in any lifecycle phase. This makes sense, since you can say an action can be planned, projected, actually happening or be realized. A single action object typically involves only one entity at a time.

{
  "id": "66b99f4c-b9d3-5af7-b2ca-9baa98fd50fc",
  "name": "DCT|2020|43-4-109",
  "externalAttributes": {},
  "vehicle": {},
  "actors": [],
  "actions": [
    {
      "entity": {
        "id": "9a8a1b09-69dc-5dd0-95ba-6269c2e62d50",
        "externalAttributes": {
          "exceptionLateThreshold": "2020-10-13T23:36Z",
          "stopType": "DC",
          "externalStopId": "1871",
          "label": "1",
          "returnFlowAllowed": "true",
          "cancelled": "false",
          "customer_data_taskNumber": "3556",
          "sequence": "1",
          "exceptionEarlyThreshold": "2020-10-13T22:21Z",
          "mutated": "false",
          "isOriginallyPlanned": "true",
          "administrative": "false"
        },
        "lifecycle": "planned",
        "location": {
          "entity": {
            "id": "8f14e45f-ceea-367a-9a36-dedd4bea8899",
            "name": "DCT",
            "externalAttributes": {
              "locationId": "7",
              "unloadingStreet": "Hoofdweg 1",
              "globalLocationNumber": "8710400000327",
              "customerLocationIdentifier": "NL1234AB0001"
            },
            "geoReference": {
              "lat": 51.578341131918414,
              "lon": 5.117661544209009,
              "type": "latLonPointGeoReference"
            },
            "administrativeReference": {
              "name": "DCT",
              "street": "Hoofdweg 1",
              "postalCode": "1234AB",
              "city": "Hoofddorp",
              "country": "NLD"
            },
            "contactDetails": [
              {
                "value": "035-497411",
                "type": "phone"
              },
              {
                "value": "operatiecentrum@supermercado.nl",
                "type": "email"
              }
            ]
          },
          "associationType": "inline"
        },
        "startTime": "2020-10-13T23:21:00Z",
        "endTime": "2020-10-13T23:53:00Z",
        "actions": [
          {
            "entity": {
              "id": "f4a24ddc-3d9e-3064-ad7b-732d474c583a",
              "transportEquipment": {
                "entity": {
                  "id": "7a64b236-a0a1-39d5-954b-809a398ac093",
                  "externalAttributes": {
                    "licensePlate": "AB-36-CD",
                    "trailerType": "EURO_13_60_KOEL"
                  },
                  "equipmentType": "trailer"
                },
                "associationType": "inline"
              },
              "actionType": "attachTransportEquipment"
            },
            "associationType": "inline"
          },
          {
            "entity": {
              "id": "6aba0be2-1373-3a03-9e53-dbe092d031aa",
              "lifecycle": "planned",
              "consignment": {
                "uuid": "3eeee837-45e4-5513-be76-47fb1bf63322",
                "entityType": "consignment",
                "associationType": "reference"
              },
              "actionType": "load"
            },
            "associationType": "inline"
          }
        ],
        "actionType": "stop"
      },
      "associationType": "inline"
    },
    {
      "entity": {
        "id": "758a44be-0e9f-3f3d-ac20-9e0549bfa0d8",
        "from": {
          "uuid": "8f14e45f-ceea-367a-9a36-dedd4bea8899",
          "entityType": "location",
          "associationType": "reference"
        },
        "to": {
          "entity": {
            "id": "e9b82e4d-55c9-3c6a-bbf9-dedf898172b3",
            "name": "8977",
            "externalAttributes": {
              "locationId": "8977",
              "unloadingStreet": "Industriestraat 15",
              "globalLocationNumber": "8710400089773",
              "customerLocationIdentifier": "NL4321DB015X"
            },
            "geoReference": {
              "lat": 51.46860736884603,
              "lon": 5.410192876182254,
              "type": "latLonPointGeoReference"
            },
            "administrativeReference": {
              "name": "8977",
              "street": "Industriestraat 15",
              "postalCode": "4321DB",
              "city": "Oss",
              "country": "NLD"
            },
            "contactDetails": [
              {
                "value": "085-2100227",
                "type": "phone"
              },
              {
                "value": "0",
                "type": "email"
              }
            ]
          },
          "associationType": "inline"
        },
        "actions": [

        ],
        "actionType": "move"
      },
      "associationType": "inline"
    },
    {
      "entity": {
        "id": "a2a2ee1a-b7c2-5dcf-ac4a-fad589e42687",
        "externalAttributes": {
          "exceptionLateThreshold": "2020-10-14T00:42Z",
          "timeWindowStart": "2020-10-13T23:45Z",
          "stopType": "WINKEL",
          "timeWindowEnd": "2020-10-14T01:15Z",
          "externalStopId": "897730315",
          "label": "2",
          "returnFlowAllowed": "true",
          "cancelled": "false",
          "customer_data_taskNumber": "2996",
          "sequence": "2",
          "exceptionEarlyThreshold": "2020-10-13T23:27Z",
          "mutated": "false",
          "isOriginallyPlanned": "true",
          "expectedTrafficDelay": "0",
          "administrative": "false"
        },
        "lifecycle": "planned",
        "location": {
          "uuid": "e9b82e4d-55c9-3c6a-bbf9-dedf898172b3",
          "entityType": "location",
          "associationType": "reference"
        },
        "startTime": "2020-10-14T00:27:00Z",
        "endTime": "2020-10-14T01:15:00Z",
        "actions": [
          {
            "entity": {
              "id": "46668558-0382-32a8-988a-895133a462bf",
              "lifecycle": "planned",
              "consignment": {
                "entity": {
                  "id": "d9e8619f-565b-336f-97a7-d509542b8fc4",
                  "externalAttributes": {
                    "externalShipmentId": "597730315AS-drop",
                    "externalOrderId": "ac9fcaea-ea91-36ee-8111-384524511399",
                    "shipmentNumber": "1",
                    "cancelled": "false"
                  },
                  "type": "HB",
                  "goods": [

                  ]
                },
                "associationType": "inline"
              },
              "actionType": "unload"
            },
            "associationType": "inline"
          },
          {
            "entity": {
              "id": "005f7c79-6dbc-37e2-974c-a4c2280e0a5f",
              "lifecycle": "planned",
              "consignment": {
                "uuid": "9d4a8e98-566b-5864-bcc1-84a3d0ae29ff",
                "entityType": "consignment",
                "associationType": "reference"
              },
              "actionType": "load"
            },
            "associationType": "inline"
          }
        ],
        "actionType": "stop"
      },
      "associationType": "inline"
    },
    {
      "entity": {
        "id": "91c70481-cd85-3129-b326-9476c97a0df6",
        "from": {
          "uuid": "e9b82e4d-55c9-3c6a-bbf9-dedf898172b3",
          "entityType": "location",
          "associationType": "reference"
        },
        "to": {
          "entity": {
            "id": "868a4b62-023a-3d9d-b827-6152d8c5b877",
            "name": "John's shop",
            "externalAttributes": {
              "locationId": "99907",
              "unloadingStreet": "Aurorastraat 7",
              "globalLocationNumber": "8710400000952",
              "customerLocationIdentifier": "NL5544BT07RH"
            },
            "geoReference": {
              "lat": 51.579218561914466,
              "lon": 5.1144329796437615,
              "type": "latLonPointGeoReference"
            },
            "administrativeReference": {
              "name": "John's shop",
              "street": "Aurorastraat 7",
              "postalCode": "5544BT",
              "city": "Eindhoven",
              "country": "NLD"
            },
            "contactDetails": [
              {
                "value": "0",
                "type": "phone"
              },
              {
                "value": "0",
                "type": "email"
              }
            ]
          },
          "associationType": "inline"
        },
        "actions": [

        ],
        "actionType": "move"
      },
      "associationType": "inline"
    },
    {
      "entity": {
        "id": "f8d15afa-c77b-5cad-91b0-6e7f32e7a665",
        "externalAttributes": {
          "exceptionLateThreshold": "2020-10-14T01:59Z",
          "stopType": "MC",
          "externalStopId": "DCT|2020|43-4-109|MC",
          "label": "3",
          "returnFlowAllowed": "true",
          "cancelled": "false",
          "customer_data_taskNumber": "2996",
          "sequence": "3",
          "mutated": "false",
          "isOriginallyPlanned": "true",
          "administrative": "false"
        },
        "lifecycle": "planned",
        "location": {
          "uuid": "868a4b62-023a-3d9d-b827-6152d8c5b877",
          "entityType": "location",
          "associationType": "reference"
        },
        "startTime": "2020-10-14T01:44:00Z",
        "endTime": "2020-10-14T02:02:00Z",
        "actions": [
          {
            "entity": {
              "id": "cb9d59fe-ef07-34cf-ae5e-8da602216e81",
              "lifecycle": "planned",
              "consignment": {
                "entity": {
                  "id": "f4f8d025-6c47-3f5b-98b6-6d6ae04b3488",
                  "externalAttributes": {
                    "externalShipmentId": "DCT|2020|43-4-109|MC|1",
                    "externalOrderId": "50483990-9809-3468-873a-46c06de14244",
                    "shipmentNumber": "1",
                    "cancelled": "false"
                  },
                  "type": "emballage",
                  "goods": [

                  ]
                },
                "associationType": "inline"
              },
              "actionType": "unload"
            },
            "associationType": "inline"
          }
        ],
        "actionType": "stop"
      },
      "associationType": "inline"
    }
  ]
}
object

Container object