Trip Interface Description 1.2.2 Help

Trip messages

This chapter describes the different types of trip messages within the FleetGO Drivers App Interface.

Message structure

The FleetGO Drivers App Interface consists of 2 different types of trip messages that can be sent to a device:

  1. Update messages - Used for sending a new trip or updating an existing trip

  2. Delete messages - Used for deleting a trip

Each trip message consists of an action and data field as described below.

Property

Required

Type

Description

action

true

string

Used to describe which action should be performed. Possible values are:

  • update - Used to update an existing trip or send a new trip

  • delete - Used to delete a trip

data

true

Entity

The data field should contain an Entity representing the trip. Please refer to the Entity chapter for more details.

When updating a trip using the update action, the trip is first deleted cascadingly. After deleting the trip, the data field gets parsed and saved. The data field should thus always contain the full representation of the trip. Partial updates are not supported.

Examples

The example below contains a JSON representation of a message to send/update a trip. The data fields contains an Entity representing the trip.

{ "action": "update", "data": { "foreignId": "1234", "flag": "trip", "title": "3", "rank": 1, "meta": { "driver": "John Doe", "date": "12-02-2020" }, "entities": [ { "foreignId": "1234-1", "flag": "stop", "title": "Load action 1234-1", "meta": { "type": "load", "date": "12-02-2020", "tripReference": "1234", "address": { "name": "FleetGO Barneveld", "address": "Anthonie Fokkerstraat 43A", "zipCode": "3772 MP", "city": "Barneveld", "countryCode": "NL", "latitude": 52.12818, "longitude": 5.5658 } }, "entities": [ { "foreignId": "1234-1-9876", "flag": "goods_line", "meta": { "name": "Europallet with smartphones", "unit": "pallet", "weight": 1000.0, "amount": 2, "ldm": 4 }, "title": "Smartphones", "entities": [] } ] }, { "foreignId": "LO-1234-2", "flag": "stop", "title": "Unload action 1234-2", "meta": { "type": "unload", "tripReference": "1234", "date": "12-02-2020", "address": { "name": "FleetGO Barneveld", "address": "Anthonie Fokkerstraat 43A", "zipCode": "3772 MP", "city": "Barneveld", "countryCode": "NL", "latitude": 52.12818, "longitude": 5.5658 } }, "entities": [ { "foreignId": "LO-1234-2-9876", "flag": "goods_line", "meta": { "name": "Europallet with smartphones", "unit": "pallet", "weight": 1000.0, "amount": 2, "ldm": 4 }, "title": "Smartphones", "entities": [] } ] } ] } }

After successfully processing the message, an EntityReceived message is generated.

The example below contains a JSON representation of message to delete a trip. When sending a delete message it is sufficient to just include the foreignId, title and flag. All other entity fields like meta and rank are ignored. If the title field is empty or not present, the foreignId field is shown to the user.

{ "action": "delete", "data": { "foreignId": "1234", "title": "3", "flag": "trip" } }

Deleting an entity happens cascadingly. After successfully deleting a trip, an EntityDeleted is generated.

Last modified: 19 November 2025