Skip to content
/Message automation

Transportial OTMS API (0.9.74)

Welcome to the Transportial API. It's the full API access for the OTMS Transportatial application. Every feature that is available (and more) in the UI is available here. It's our mission to facilitate open, fast, enterprise grade architecture for transportation.

Download OpenAPI description
index.json
index.yaml
Overview
URL
http://transportial.com
Transportial
info@transportial.com
Terms of Service
Languages
Servers
Mock server
https://docs.transportial.com/_mock/apis
Test environment
https://test.api.otms.transportial.com/api
Production
https://api.otms.transportial.com/api

Calendar Events

Calendar occurrences for vehicles within a date range.

Operations

Tender

Tenders can be stacked and constrain different activities in their context

Operations

Widget

Widgets can be stacked and constrain different activities in their context

Operations

Vehicle

A Vehicle is a means to transport consignments from one location to potentially multiple other locations. There are various types of vehicles, each with their own unique properties like size, dimensions, fuel type and means of tranport (by air, on land, over sea).

Operations

Trip

A Trip is an aggregate entity that combines various entities to model visiting various locations, potentially doing one or multiple actions on each location, such as loading or unloading consignments. It is optionally coupled to a Vehicle that is/was driving this trip.

Operations

File

File management. Upload, retrieve and download files. Categorized by it's purpose.

Operations

CapacityContract

The CapacityContract is the entity to model a contract of a purchase of certain amount of scheduled capacity.

Operations

MessageTemplate

MessageTemplates can be stacked and constrain different activities in their context

Operations

Business

Business is a base entity that describes a companies information. Thiis entity is used for contracts, clients, invoices, quotes, etc. It can be any type of relation you do business with.

Operations

SAML

SAML Configuration for Single-SignOn(SSO) establishment between Service-Provider(SP) and Identity-Provider(IDP)

Operations

Route

A route models the path going from one location to at least one other location.

Operations

Chat

Sending messages to users grouped by rooms

Operations

TransportEquipment

TransportEquipment are the items to be transported as part of a consignment. TransportEquipment can be divided into two sub-types of transportEquipment, depending on the use case and the level of detail. TransportEquipment either consists of items, describing the actual transportEquipment to be transported. Or a transport equipment, which is equipment used to carry the actual transportEquipment to be transported. Transport equipment is (usually) a means to an end, not something that needs to be transported on itself, such as pallets.

Operations

Insights

All the insights you need can be gathered from these endpoints

Operations

User

Users related to the platform and all actions required

Operations

DocumentTemplate

Visual document template designer for creating CMR, invoices, quotes and custom documents

Operations

Message automation

MessageAutomations are communication automation connectors that can use events

Operations

Get MessageAutomations

Request

Get a MessageAutomations

Security
bearer or apiKey or apiSecret
Path
offsetinteger(int64)required
amountstringrequired
Headers
Authorizationstringrequired
curl -i -X GET \
  'https://docs.transportial.com/_mock/apis/messageAutomations/{offset}/{amount}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
totalResultsinteger(int32)
messageAutomationsArray of objects(MessageAutomationModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "totalResults": 0,
  "messageAutomations": [
    { … }
  ]
}

Get MessageAutomations

Request

Get a MessageAutomations

Security
bearer or apiKey or apiSecret
Path
offsetinteger(int64)required
amountinteger(int64)required
Headers
Authorizationstringrequired
curl -i -X POST \
  'https://docs.transportial.com/_mock/apis/messageAutomations/{offset}/{amount}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
totalResultsinteger(int32)
messageAutomationsArray of objects(MessageAutomationModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "totalResults": 0,
  "messageAutomations": [
    { … }
  ]
}

Update MessageAutomation

Request

Update MessageAutomation

Security
bearer or apiKey or apiSecret
Headers
Authorizationstringrequired
Bodyapplication/jsonrequired
curl -i -X PUT \
  https://docs.transportial.com/_mock/apis/messageAutomation \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
messageAutomationobject(MessageAutomationModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "messageAutomation": {
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "language": {},
    "type": "messageAutomation",
    "name": "string",
    "description": "string",
    "automationConfig": { … },
    "messageAutomationIntegration": {},
    "enabled": true,
    "lastHandled": "2019-08-24T14:15:22Z",
    "template": true,
    "templateCategory": "string"
  }
}

Add new MessageAutomation

Request

Add new MessageAutomation

Security
bearer or apiKey or apiSecret
Headers
Authorizationstringrequired
Bodyapplication/jsonrequired
curl -i -X POST \
  https://docs.transportial.com/_mock/apis/messageAutomation \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
messageAutomationobject(MessageAutomationModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "messageAutomation": {
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "language": {},
    "type": "messageAutomation",
    "name": "string",
    "description": "string",
    "automationConfig": { … },
    "messageAutomationIntegration": {},
    "enabled": true,
    "lastHandled": "2019-08-24T14:15:22Z",
    "template": true,
    "templateCategory": "string"
  }
}

Get MessageAutomation tasks

Request

Get list of MessageAutomation tasks

Security
bearer or apiKey or apiSecret
Path
idstringrequired
offsetinteger(int64)required
amountinteger(int64)required
Headers
Authorizationstringrequired
curl -i -X GET \
  'https://docs.transportial.com/_mock/apis/messageAutomation/{id}/tasks/{offset}/{amount}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
totalResultsinteger(int32)
messageAutomationTasksArray of objects(MessageAutomationTask)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "totalResults": 0,
  "messageAutomationTasks": [
    { … }
  ]
}

Get MessageAutomation

Request

Get a MessageAutomation by id

Security
bearer or apiKey or apiSecret
Path
idstringrequired
Headers
Authorizationstringrequired
curl -i -X GET \
  'https://docs.transportial.com/_mock/apis/messageAutomation/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
messageAutomationobject(MessageAutomationModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "messageAutomation": {
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "language": {},
    "type": "messageAutomation",
    "name": "string",
    "description": "string",
    "automationConfig": { … },
    "messageAutomationIntegration": {},
    "enabled": true,
    "lastHandled": "2019-08-24T14:15:22Z",
    "template": true,
    "templateCategory": "string"
  }
}

Delete MessageAutomation

Request

Delete a MessageAutomation

Security
bearer or apiKey or apiSecret
Path
idstringrequired
Headers
Authorizationstringrequired
curl -i -X DELETE \
  'https://docs.transportial.com/_mock/apis/messageAutomation/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
messageAutomationobject(MessageAutomationModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "messageAutomation": {
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "language": {},
    "type": "messageAutomation",
    "name": "string",
    "description": "string",
    "automationConfig": { … },
    "messageAutomationIntegration": {},
    "enabled": true,
    "lastHandled": "2019-08-24T14:15:22Z",
    "template": true,
    "templateCategory": "string"
  }
}

Duplicate MessageAutomation

Request

Duplicate a MessageAutomation

Security
bearer or apiKey or apiSecret
Path
idstringrequired
Headers
Authorizationstringrequired
curl -i -X POST \
  'https://docs.transportial.com/_mock/apis/messageAutomation/{id}/duplicate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
messageAutomationobject(MessageAutomationModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "messageAutomation": {
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "language": {},
    "type": "messageAutomation",
    "name": "string",
    "description": "string",
    "automationConfig": { … },
    "messageAutomationIntegration": {},
    "enabled": true,
    "lastHandled": "2019-08-24T14:15:22Z",
    "template": true,
    "templateCategory": "string"
  }
}

Get User Message Automation Preferences

Request

Get all user-enableable message automations with the current user's preference status

Security
bearer or apiKey or apiSecret
Headers
Authorizationstringrequired
curl -i -X GET \
  https://docs.transportial.com/_mock/apis/messageAutomation/user-preferences \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
totalResultsinteger(int32)
preferencesArray of objects(UserMessageAutomationPreferenceModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "totalResults": 0,
  "preferences": [
    { … }
  ]
}

Toggle User Message Automation Preference

Request

Toggle a user's preference for a specific message automation

Security
bearer or apiKey or apiSecret
Headers
Authorizationstringrequired
Bodyapplication/jsonrequired

Toggle preference request

string
curl -i -X POST \
  https://docs.transportial.com/_mock/apis/messageAutomation/user-preference \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "messageAutomationId": "uuid-here",
    "enabled": true
  }'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
totalResultsinteger(int32)
preferencesArray of objects(UserMessageAutomationPreferenceModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "totalResults": 0,
  "preferences": [
    { … }
  ]
}

Get MessageAutomations

Request

Get a MessageAutomations

Security
bearer or apiKey or apiSecret
Headers
Authorizationstringrequired
curl -i -X GET \
  https://docs.transportial.com/_mock/apis/messageAutomation-templates \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
totalResultsinteger(int32)
messageAutomationsArray of objects(MessageAutomationModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "totalResults": 0,
  "messageAutomations": [
    { … }
  ]
}

Generate message automation with AI

Request

Use AI to generate a message automation configuration from a text description or documents

Security
bearer or apiKey or apiSecret
Headers
Authorizationstringrequired
Bodyapplication/jsonrequired
documentsArray of strings
contentstring
curl -i -X POST \
  https://docs.transportial.com/_mock/apis/messageAutomation/generate \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "documents": [
      "string"
    ],
    "content": "string"
  }'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
messageAutomationobject
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "messageAutomation": {
    "property1": {},
    "property2": {}
  }
}

Duplicate message automation template

Request

Duplicate a message automation template

Security
bearer or apiKey or apiSecret
Path
idstringrequired
Headers
Authorizationstringrequired
curl -i -X POST \
  'https://docs.transportial.com/_mock/apis/messageAutomation-template/{id}/duplicate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
messageAutomationobject(MessageAutomationModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "messageAutomation": {
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "language": {},
    "type": "messageAutomation",
    "name": "string",
    "description": "string",
    "automationConfig": { … },
    "messageAutomationIntegration": {},
    "enabled": true,
    "lastHandled": "2019-08-24T14:15:22Z",
    "template": true,
    "templateCategory": "string"
  }
}

Chauffeur

Chauffeurs are the people who are responsible for controlling a Vehicle. They have schedules, planning and legal responsibilities.

Operations

User roles

The permissions grouped by a "Role", that can be assigned to a user

Operations

StackMap

A stackMap models the snapshots of planned stacking across locations.

Operations

Quote

Quotes

Operations

ScheduleRoute

A scheduleRoute is a device that is able to measure a quantity in a certain unit, such as measuring the speed in km/h.

Operations

VehicleGroup

A VehicleGroup is a group of Vehicle's. Groups can be used to reference a list of vehicles without having to select each individual one.

Operations

LedgerEntry

LedgerEntry ...

Operations

Goods

Goods are the items to be transported as part of a consignment. Goods can be divided into two sub-types of goods, depending on the use case and the level of detail. Goods either consists of items, describing the actual goods to be transported. Or a transport equipment, which is equipment used to carry the actual goods to be transported. Transport equipment is (usually) a means to an end, not something that needs to be transported on itself, such as pallets.

Operations

Transaction

Transactions

Operations

Async

Generic asynchronous request results

Operations

Terminal

Terminal management for term&conditions in forwarded orders

Operations

Notification

Notification endpoint to notify people, groups or the entire user base of things they might want to know or need to know

Operations

Capacity

A capacity models the amount of cargo, a schedule can deliver.

Operations

Attribute

Object describing a geographic attribute. A attribute can either be a point or an area.

Operations

Sensor

A sensor is a device that is able to measure a quantity in a certain unit, such as measuring the speed in km/h.

Operations

Camera

A Camera.

Operations

Location

Object describing a geographic location. A location can either be a point or an area.

Operations

TransportOrder

The TransportOrder is the top-level entity to model a group of related consignments that might be transported separately, but need to be administered together.

Operations

Team

A Team is a group of Vehicle's. Groups can be used to reference a list of vehicles without having to select each individual one.

Operations

ToDo

A to-do represents a basic specific task within a lane of a board.

Operations

Constraint

Constraints can be stacked and constrain different activities in their context

Operations

General

General reference data sets like Languages, Currencies etc.

Operations

Pricing

A pricing models the path going from one location to at least one other location.

Operations

Invoice

Invoices

Operations

Integration

Update an existing integration test case.

Operations

Lane

A lane contains a location and status of a todo task.

Operations

Administration

Administrations can be stacked and constrain different activities in their context

Operations

Consignment

Consignments can be stacked and constrain different activities in their context

Operations

BoardComputer

A Boardcomputer is a device that tracks properties of a Vehicle. Values received from a Boardcomputer can be the current location, speed, temperatues etc.

Operations

Booking

Object describing a geographic booking. A booking can either be a point or an area.

Operations

Document

Documents are the base entities to handle all types of external data files and the references to them

Operations

Chauffeur Calendar Events Occurrences

Calendar Events API endpoints.

Operations

Complaint

Object describing a geographic Complaint. A Complaint can either be a point or an area.

Operations

Routing

Everything routing: meaning the routes from A-B supporting multiple modalities

Operations

Board

Boards contain Lanes and might represent a module of a project or a project itself

Operations

Event

Events - like actions - model dynamic entities that couple various static entities at a certain moment in time. Events are used for either real-time updates, or updates on earlier provided data. Notice that in both event types these are updates on earlier provided data, whereas actions are usually used together with the entities they dynamically couple.

Operations

Timeslot Booking

Endpoints for managing delivery/pickup timeslot bookings

Operations

Action

Actions can be stacked and constrain different activities in their context

Operations

CalendarEvent

Calendar events management for vehicles, transport equipment, and chauffeurs

Operations

Mail

Mails can be stacked and constrain different activities in their context

Operations

Fleet

Fleets can be stacked and constrain different activities in their context

Operations

Tire

Object describing a geographic Tire. A Tire can either be a point or an area.

Operations

Settings

The user settings for the system

Operations

Actor

Actors can be stacked and constrain different activities in their context

Operations

Type

Types

Operations

Action Schedules

Manage standalone operational schedules.

Operations

Damage

Object describing a geographic damage. A damage can either be a point or an area.

Operations

Optimization

Transport optimization endpoints for creating optimal trips and managing routes

Operations

Tachograph

Tachograph methods

Operations

Contract

Contracts

Operations

Management

The management overviews

Operations

TQL

TQL stands for "Transportial Query Language". It's used to be able to run any query from a given JSON request

Operations

Chauffeur Timeslots

Chauffeur Timeslot API endpoints.

Operations

Certificate

Object describing a geographic Certificate. A Certificate can either be a point or an area.

Operations

Chauffeur Calendar Events

Check if a specific chauffeur is available within a date range.

Operations

ServiceCard

Object describing a geographic ServiceCard. A ServiceCard can either be a point or an area.

Operations

Ban

Object describing a geographic Ban. A Ban can either be a point or an area.

Operations

Transportial

Our full API documentation can be found here for OTMS. It describes our endpoints and the way we accept data.

Authentication

You can authenticate users by a login call and sending their token in the Authorization header.

OTM5

Our API is fully supportive of the OTM5 data structure. You can send and receive those objects in the exact definition. In our documentation you will find our other objects and you don't need to use Associations, we do return that structure however.

Alert

Operations