EntityReceived Message

The EntityReceived message is generated after a trip message with action update has been received by the app successfully.

As described in the Sending trips chapter, sending a trip to the app is an asynchronous process. When the API responds with a 200 (OK) statuscode, it doesn't mean that the trip is present in the app. After receiving an EntityReceived message, you may assume that the trip is present in the app.

The data field of an EntityReceived message always contains the properties described below.

Property	Nullable	Type	Description
foreignId	false	string	Contains the `foreignId` of the root entity as provided in the trip message sent to the app
flag	false	string	Contains the `flag` of the root entity as provided in the trip message sent to the app

Example

The example below contains an EntityReceived message for a trip with foreignId 1234 and flag trip.

{
  "type": "EntityReceived",
  "data": {
    "foreignId": "1234",
    "flag": "trip"
  },
  "location": {
    "latitude": 52.2531361,
    "longitude": 5.4890928,
    "speedMs": 25,
    "bearing": 75.0
  },
  "origin": {
    "appId": 60000153,
    "deviceId": "358240051111110",
    "driverNumber": "110",
    "coDriverNumber": null
  },
  "vehicle": {
    "licensePlate": "AA-BB-12",
    "odometer": 250000
  },
  "messageTime": "2020-04-01T12:35:34.769Z"
}

Last modified: 16 May 2024