Data Format - Actors

Example

On the previous pages, you saw the basic structure of a message, external attributes and vehicle data we might send you. Next, we show you the actors. In OpenTripModel, a single actor represents an organization or person that participates in a logistic process

In the following example we expanded all keys in the actors object. In the table underneath we give a short description of every key

Copy

Copied

{
  "id": "2a8af6c6-e4d5-5dfb-9532-e8b17c3ffd88",
  "name": "DCX|2020|32-2-888",
  "externalAttributes": {},
  "vehicle": {},
  "actors": [
    {
      "entity": {
        "id": "66cbe2e0-3f0e-5b19-85e8-f0fb7302a888",
        "name": "Janszoon Transport B.V.",
        "externalAttributes": {
          "code": "janszoon",
          "description": "carrier"
        }
      },
      "associationType": "inline"
    },
    {
      "entity": {
        "id": "79b50ea6-b390-528e-9920-efe260a1b888",
        "name": "Supermercado",
        "externalAttributes": {
          "code": "supermercado",
          "description": "shipper"
        }
      },
      "associationType": "inline"
    }
  ],
  "actions": []
}

Actors entity scheme

object

Container object

uuid

Universally Unique Identifier to the actor

name

string

Name of the involved party

object

code	string Code for the actor in Simacan's domain
identifier	string External identifier for the actor, currently only in use for Home Delivery operations
remark	string Remark for the specific actor, currently only in use for Home Delivery operations
newCustomer	boolean Used for customer addresses to indicate when they are delivered for the first time, currently only applied in HomeDelivery operations
creationDate	timestamp Date and time when the actor was created in Simacan's database. Mainly in use for automated creation of actors (common in Home Delivery operations)

associationType

string

See the basics for an explanation