Last updated 1 month ago

Data Format - Basics

OpenTripModel

As we mentioned earlier, we are using the OpenTripModel standard to model the messages we send you. On the next pages, we will guide you through our most common fields and logic. However, if you feel the need for more in-depth knowledge on the complete OpenTripModel, feel free to go to the official website at https://www.opentripmodel.org/

Basic Structure

We are going to take you through the data structure step by step. Let's see the basic structure first. A bare minimal message could look like underneath. (No, we won't be sending you empty ones, like this)

{
  "id": "2a8af6c6-e4d5-5dfb-9532-e8b17c3ffd88",
  "name": "14165903",
  "context": [],
  "externalAttributes": {},
  "actions": []
}
id
uuid

Universally Unique Identifier to the trip.

name
string

Identifier of this trip as typically seen in the URL that is unique within a shipper in the Simacan domain.

context
string

Current context that triggered the push of this message.

A location update or crossing a geofence could be a trigger

externalAttributes
object

Any optional attributes related to this trip.

You can find the tripId ("Ritnummer" in Dutch) in here

actions
array

All actions that are involved in this trip

Every action has a lifecycle attribute indicating its stage. More on the next page