Get a specific Actor by its UUID

Request

Security

BearerToken

Path

UUIDstring, (uuid)required

The unique UUID of this Actor

curl -i -X GET \
  'https://otm-api-spec.redocly.app/_mock/api/5.9/otm/api/v5/actors/{UUID}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Returned the entity with the provided UUID

Bodyapplication/json

entityTypestring

Value:"actor"

Example:"actor"

idstring

Uniquely identifies this entity. A URI can be assigned by the client to indicate where more information can be retrieved. Note that every entity always has a unique EntityId. However since, OTM5.2 it is not required to send it in the request. One can be generated for you by the server.

Example:"45db6ed0-28a7-4e4a-baba-3d5f8d171103"

namestring

Name of the entity. For display purposes and search only.

Example:"Logistics manager"

creationDatestring, (date-time)

The creation date of this entity.

lastModifiedstring, (date-time)

The last modified date of this entity. If none is given the creation date is used instead.

contextEventsArray of any(event)

The context events provides some optional information about the events that can provide additional information on the current state of this entity.

For example: your system might send ETA information for the arrival of a vehicle on a location. To make it clear what caused this ETA to be updated, we can include some information about what caused this ETA update by including an event as context. If your ETA update was caused by a location update, this event can be included as context. If the ETA was caused by a traffic accident on the route of the vehicle, you can include that event in the context.

externalAttributesobject

externalIdentifiersArray of objects(externalIdentifiers)

Standardized identifiers of this entity as known in external systems. Use this to exchange repeatable partner or system specific identifiers without overloading externalAttributes.

Example:

[
  {
    "id": "AAA",
    "scheme": "CAS"
  }
]

contactDetailsArray of any(contactDetails)

Contact details

Example:

[
  {
    "value": "Simon Isaac",
    "remark": "Wants to be called 'Sim'.",
    "type": "firstName"
  },
  {
    "value": "Macan",
    "type": "lastName"
  },
  {
    "value": "+312012345678",
    "remark": "private cellphone of the CEO",
    "language": "nld",
    "type": "phone"
  },
  {
    "value": "simon@macan",
    "type": "email"
  },
  {
    "value": "NL74BANK5890469479",
    "type": "iban"
  },
  {
    "value": "NL000099998B57",
    "type": "vatCode"
  }
]

locationsArray of any

Locations for this Actor.

typestringrequired

Value:"person"

Discriminator

firstNamestring

The first name.

lastNamestring

The last name.

rolestring

The role/function title in relation to where the person works. Note! This is not the same as the role(s) that an actor can have in relation to an entity (e.g. Carrier, Consignee, Driver, etc). Those roles are defined in the actor-roles.yaml schema.

departmentstring

languagesArray of strings

The languages this person speaks.

Response

{
  "id": "45db6ed0-28a7-4e4a-baba-3d5f8d171103",
  "name": "Logistics manager",
  "contactDetails": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ],
  "type": "person",
  "firstName": "string",
  "lastName": "string",
  "role": "string",
  "department": "string",
  "languages": [
    "nld"
  ]
}