Last updated 1 month ago

Message example

Below you will find an example message, with further underneath a description of all keys.

Action

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.

Lifecycle

Each action has a lifecycle stage; for the ETA Push messages, they are defined as followed:

  • planned: ETA and ETD defined as in delivered planning (or after trip edits)
  • projected: Calculated ETA's for the stops todo. This is the value for startTime
  • realized: the ATA and ATD detected by Simacan by changes in GPS position or Geofence. NB. When only an ATA is present, the vehicle is still at the stop. (e.g. unloading)

Example

{
    "id": "dc255869-9999-8888-7777-6695963d4535",
    "name": "14165903",
    "externalAttributes": {
        "tripId": "14165903"
    },
    "context": [
        {
            "entity": {
                "id": "c6d0695e-9999-8888-7777-45ea169f2fd4",
                "creationDate": "2020-12-11T15:52:24Z",
                "lifecycle": "realized",
                "geoReference": {
                    "lat": 52.32362087,
                    "lon": 4.92776779,
                    "type": "latLonPointGeoReference",
                    "heading": {
                        "value": 315,
                        "unit": "°"
                    }
                },
                "entityType": "locationUpdateEvent"
            },
            "associationType": "inline"
        }
    ],
    "actions": [
        {
            "entity": {
                "id": "aaa842fe-9999-8888-7777-01f989b18d7a",
                "externalAttributes": {
                    "shipmentId": "83644099",
                    "orderNumber": "83644099"
                },
                "lifecycle": "planned",
                "stop": {
                    "entity": {
                        "id": "f4086723-9999-8888-7777-34586f45e205",
                        "externalAttributes": {
                            "stopNumber": "0",
                            "stopId": "1234-0",
                            "projectedStopsTodo": "0",
                            "cancelled": "false",
                            "isActive": "false"
                        },
                        "actionType": "stop"
                    },
                    "associationType": "inline"
                },
                "location": {
                    "entity": {
                        "id": "f81cec67-9999-8888-7777-76f21eef82f0",
                        "geoReference": {
                            "lat": 52.362671,
                            "lon": 5.173401,
                            "type": "latLonPointGeoReference"
                        },
                        "administrativeReference": {
                            "name": "Startpoint",
                            "street": "Kerkstraat",
                            "houseNumber": "1",
                            "postalCode": "1234AB",
                            "city": "ALMERE",
                            "country": "NL"
                        }
                    },
                    "associationType": "inline"
                },
                "startTime": "2020-12-11T14:38:42Z",
                "endTime": "2020-12-11T14:53:42Z",
                "actionType": "load"
            },
            "associationType": "inline"
        },
        {
            "entity": {
                "id": "aaa842fe-9999-8888-7777-01f989b18d7a",
                "externalAttributes": {
                    "shipmentId": "83644099",
                    "orderNumber": "83644099"
                },
                "lifecycle": "realized",
                "stop": {
                    "entity": {
                        "id": "f4086723-9999-8888-7777-34586f45e205",
                        "externalAttributes": {
                            "stopNumber": "0",
                            "stopId": "1234-0",
                            "projectedStopsTodo": "0",
                            "cancelled": "false",
                            "isActive": "false"
                        },
                        "actionType": "stop"
                    },
                    "associationType": "inline"
                },
                "location": {
                    "entity": {
                        "id": "f81cec67-9999-8888-7777-76f21eef82f0",
                        "geoReference": {
                            "lat": 52.362671,
                            "lon": 5.173401,
                            "type": "latLonPointGeoReference"
                        },
                        "administrativeReference": {
                            "name": "Startpoint",
                            "street": "Kerkstraat",
                            "houseNumber": "1",
                            "postalCode": "1234AB",
                            "city": "ALMERE",
                            "country": "NL"
                        }
                    },
                    "associationType": "inline"
                },
                "startTime": "2020-12-11T14:41:42Z",
                "endTime": "2020-12-11T14:52:57Z",
                "actionType": "load"
            },
            "associationType": "inline"
        },
        {
            "entity": {
                "id": "aaa842fe-9999-8888-7777-01f989b18d7a",
                "externalAttributes": {
                    "shipmentId": "83644099",
                    "orderNumber": "83644099"
                },
                "lifecycle": "planned",
                "stop": {
                    "entity": {
                        "id": "e5e5010e-9999-8888-7777-8a2c65437ea7",
                        "externalAttributes": {
                            "stopNumber": "1",
                            "stopId": "1234-1",
                            "projectedStopsTodo": "1",
                            "cancelled": "false",
                            "isActive": "false"
                        },
                        "actionType": "stop"
                    },
                    "associationType": "inline"
                },
                "location": {
                    "entity": {
                        "id": "f81cec67-9999-8888-7777-76f21eef82f0",
                        "geoReference": {
                            "lat": 52.331604,
                            "lon": 5.257721,
                            "type": "latLonPointGeoReference"
                        },
                        "administrativeReference": {
                            "name": "Customer 1",
                            "street": "Industriestraat",
                            "houseNumber": "2",
                            "postalCode": "1222AB",
                            "city": "ALMERE",
                            "country": "NL"
                        }
                    },
                    "associationType": "inline"
                },
                "startTime": "2020-12-11T15:11:00Z",
                "endTime": "2020-12-11T15:22:00Z",
                "actionType": "unload"
            },
            "associationType": "inline"
        },
        {
            "entity": {
                "id": "aaa842fe-9999-8888-7777-01f989b18d7a",
                "externalAttributes": {
                    "shipmentId": "83644099",
                    "orderNumber": "83644099"
                },
                "lifecycle": "projected",
                "stop": {
                    "entity": {
                        "id": "e5e5010e-9999-8888-7777-8a2c65437ea7",
                        "externalAttributes": {
                            "stopNumber": "1",
                            "stopId": "1234-1",
                            "projectedStopsTodo": "1",
                            "cancelled": "false",
                            "isActive": "false"
                        },
                        "actionType": "stop"
                    },
                    "associationType": "inline"
                },
                "location": {
                    "entity": {
                        "id": "f81cec67-9999-8888-7777-76f21eef82f0",
                        "geoReference": {
                            "lat": 52.331604,
                            "lon": 5.257721,
                            "type": "latLonPointGeoReference"
                        },
                        "administrativeReference": {
                            "name": "Customer 1",
                            "street": "Industriestraat",
                            "houseNumber": "2",
                            "postalCode": "1222AB",
                            "city": "ALMERE",
                            "country": "NL"
                        }
                    },
                    "associationType": "inline"
                },
                "startTime": "2020-12-11T15:06:17.794Z",
                "actionType": "unload"
            },
            "associationType": "inline"
        },
        {
            "entity": {
                "id": "aaa842fe-9999-8888-7777-01f989b18d7a",
                "externalAttributes": {
                    "shipmentId": "83644099",
                    "orderNumber": "83644099"
                },
                "lifecycle": "realized",
                "stop": {
                    "entity": {
                        "id": "e5e5010e-9999-8888-7777-8a2c65437ea7",
                        "externalAttributes": {
                            "stopNumber": "1",
                            "stopId": "1234-1",
                            "projectedStopsTodo": "1",
                            "cancelled": "false",
                            "isActive": "false"
                        },
                        "actionType": "stop"
                    },
                    "associationType": "inline"
                },
                "location": {
                    "entity": {
                        "id": "f81cec67-9999-8888-7777-76f21eef82f0",
                        "geoReference": {
                            "lat": 52.331604,
                            "lon": 5.257721,
                            "type": "latLonPointGeoReference"
                        },
                        "administrativeReference": {
                            "name": "Customer 1",
                            "street": "Industriestraat",
                            "houseNumber": "2",
                            "postalCode": "1222AB",
                            "city": "ALMERE",
                            "country": "NL"
                        }
                    },
                    "associationType": "inline"
                },
                "startTime": "2020-12-11T15:06:28Z",
                "endTime": "2020-12-11T15:17:14Z",
                "actionType": "unload"
            },
            "associationType": "inline"
        },
        {
            "entity": {
                "id": "07adda2f-9999-8888-7777-d2aeb40da5e7",
                "externalAttributes": {
                    "shipmentId": "89342925",
                    "orderNumber": "89342925"
                },
                "lifecycle": "projected",
                "stop": {
                    "entity": {
                        "id": "02d6a2a8-9999-8888-7777-cd59e0ec35dd",
                        "externalAttributes": {
                            "stopNumber": "2",
                            "stopId": "1234-2",
                            "projectedStopsTodo": "0",
                            "cancelled": "false",
                            "isActive": "false"
                        },
                        "actionType": "stop"
                    },
                    "associationType": "inline"
                },
                "location": {
                    "entity": {
                        "id": "3a02546c-9999-8888-7777-d05b301da096",
                        "geoReference": {
                            "lat": 52.338184,
                            "lon": 5.301545,
                            "type": "latLonPointGeoReference"
                        },
                        "administrativeReference": {
                            "name": "Customer 2",
                            "street": "Molenweg",
                            "houseNumber": "4",
                            "postalCode": "1333AB",
                            "city": "ALMERE",
                            "country": "NL"
                        }
                    },
                    "associationType": "inline"
                },
                "startTime": "2020-12-11T15:57:52.629Z",
                "actionType": "unload"
            },
            "associationType": "inline"
        },
        {
            "entity": {
                "id": "07adda2f-9999-8888-7777-d2aeb40da5e7",
                "externalAttributes": {
                    "shipmentId": "89342925",
                    "orderNumber": "89342925"
                },
                "lifecycle": "projected",
                "stop": {
                    "entity": {
                        "id": "02d6a2a8-9999-8888-7777-cd59e0ec35dd",
                        "externalAttributes": {
                            "stopNumber": "2",
                            "stopId": "1234-2",
                            "projectedStopsTodo": "0",
                            "cancelled": "false",
                            "isActive": "false"
                        },
                        "actionType": "stop"
                    },
                    "associationType": "inline"
                },
                "location": {
                    "entity": {
                        "id": "3a02546c-9999-8888-7777-d05b301da096",
                        "geoReference": {
                            "lat": 52.338184,
                            "lon": 5.301545,
                            "type": "latLonPointGeoReference"
                        },
                        "administrativeReference": {
                            "name": "Customer 2",
                            "street": "Molenweg",
                            "houseNumber": "4",
                            "postalCode": "1333AB",
                            "city": "ALMERE",
                            "country": "NL"
                        }
                    },
                    "associationType": "inline"
                },
                "startTime": "2020-12-11T15:57:52.629Z",
                "actionType": "unload"
            },
            "associationType": "inline"
        }
    ]
}

Context Entity

Click on the orange arrow to expand nested keys

object

A single context object

associationType
string
Enum: "reference" "inline"

Inline indicates that all data is contained in this entity

Action Entity

Click on the orange arrow to expand nested keys

object

A single action object

associationType
string
Enum: "reference" "inline"

Inline indicates that all data is contained in this entity