API Reference
/
Integration

Transportial OTMS API (0.9.2)

Download OpenAPI description
index.json
index.yaml
Overview
URL http://transportial.com
Transportial info@transportial.com
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/

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.

ServiceCard

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

Operations

Tire

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

Operations

Action

Actions are dynamic entities that are able to couple together various static entities at a certain moment in time. For instance a Load action couples together a Consignment and a Vehicle at the moment the Loading happens.

Operations

Actor

Actors can be stacked and constrain different activities in their context

Operations

Charge

Charges

Operations

Invoice

Invoices

Operations

LedgerEntry

LedgerEntry ...

Operations

Payout

Payouts

Operations

Plan

Plans

Operations

Quote

Quotes

Operations

Administration

Administrations can be stacked and constrain different activities in their context

Operations

Transaction

Transactions

Operations

Alert

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

Operations

Publisher

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

Operations

App

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

Operations

Attribute

A generic entity that can help in defining other entities properties

Operations

Ban

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

Operations

Board

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

Operations

Booking

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

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

Camera

A Camera

Operations

CapacityContract

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

Operations

Capacity

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

Operations

Certificate

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

Operations

Chat

Sending messages to users grouped by rooms

Operations

MessageTemplate

MessageTemplates can be stacked and constrain different activities in their context

Operations

Chauffeur

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

Operations

Complaint

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

Operations

Consignment

Consignments can be stacked and constrain different activities in their context

Operations

Constraint

Constraints can be stacked and constrain different activities in their context

Operations

Contract

Contracts

Operations

Damage

Object describing a geographic damage. A damage 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

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

Feedback

Feedbacks

Operations

File

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

Operations

Fleet

Fleets can be stacked and constrain different activities in their context

Operations

General

General reference data sets like Languages, Currencies etc. and functions

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

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

Integration

An Integration is the connection for 2 systems. An integration can be configured and enabled through this object. It can also configure the entire connection or it can be pre-configured.

Operations

Update integration

Request

Update a integration

Headers
Authorizationstringrequired
Bodyapplication/jsonrequired
idstring
noncestring
uuidstring
primaryPlatformIdstring
createdAtstring(date-time)
updatedAtstring(date-time)
typestring
Enum"manual""configured""messageAutomation""fileTemplate""apiAccess"
Discriminator
namestring
descriptionstring
scheduleobject(IntegrationSchedulerSchedule)
dataSourcesArray of objects(IntegrationDataSourceModel)
enabledboolean
lastHandledstring(date-time)
triggerTypestring
Enum"trigger""scheduler""listener"
triggerEventstring
Enum"afterCreatingTrip""afterUpdatingTrip""afterConfirmingTrip""afterStartingTrip""afterFinishingTrip""afterCancelingTrip""afterLocationUpdateEvent""afterCreatingMessage""afterUpdatingMessage""afterCreatingEvent"
filtersArray of objects(IntegrationFilter)
curl -i -X PUT \
  https://docs.transportial.com/_mock/apis/integration \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "type": "configured",
    "name": "string",
    "description": "string",
    "schedule": {
      "integrationSchedulerScheduleValue": 0,
      "integrationSchedulerScheduleType": "seconds",
      "milliseconds": 0
    },
    "dataSources": [
      {
        "id": "string",
        "nonce": "string",
        "uuid": "string",
        "primaryPlatformId": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "directionType": "in",
        "connectionType": "api",
        "requestMethod": "get",
        "dataType": "xml",
        "entityType": "action",
        "url": "string",
        "port": 0,
        "path": "string",
        "token": "string",
        "query": "string",
        "parameters": [
          {
            "sequenceNr": 0,
            "type": "constant",
            "regex": "string",
            "format": "string",
            "locale": "string",
            "zoneId": "string",
            "incomingPath": "string",
            "outgoingPath": "string",
            "fields": [
              {}
            ],
            "filters": [
              {
                "selector": "string",
                "comparisonType": "equal",
                "value": "string",
                "linkType": "and",
                "filters": [
                  null
                ],
                "sequenceNr": 0
              }
            ],
            "options": [
              "identifier"
            ]
          }
        ],
        "allowedIps": [
          "string"
        ],
        "hasAuthentication": true,
        "credentials": {
          "id": "string",
          "nonce": "string",
          "uuid": "string",
          "primaryPlatformId": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "authenticationMethod": "apiKey",
          "username": "string",
          "password": "string",
          "accessKey": "string",
          "secretKey": "string",
          "clientId": "string",
          "clientSecret": "string",
          "grantType": "string",
          "scope": "string",
          "apiKey": "string",
          "bearer": "string",
          "sshKey": {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "url": "string",
            "path": "string",
            "name": "string",
            "originalName": "string",
            "size": 0,
            "purpose": "string",
            "type": "IMAGE",
            "mimeType": "string",
            "extension": "string",
            "uploadedAt": "2019-08-24T14:15:22Z"
          },
          "sshTunnel": true,
          "sshHost": "string",
          "sshUsername": "string",
          "sshPassword": "string",
          "externalAttributes": {
            "property1": {},
            "property2": {}
          },
          "headers": {
            "property1": {},
            "property2": {}
          },
          "oauthUrl": "string",
          "oAuthCache": "string",
          "oAuthCacheCreationDate": "2019-08-24T14:15:22Z",
          "openIdToken": "string",
          "openIdRefreshToken": "string",
          "openIdAccessToken": "string",
          "openIdExpiration": "2019-08-24T14:15:22Z"
        },
        "otm": true,
        "fields": [
          {
            "sequenceNr": 0,
            "type": "constant",
            "regex": "string",
            "format": "string",
            "locale": "string",
            "zoneId": "string",
            "incomingPath": "string",
            "outgoingPath": "string",
            "fields": [
              {}
            ],
            "filters": [
              {
                "selector": "string",
                "comparisonType": "equal",
                "value": "string",
                "linkType": "and",
                "filters": [
                  null
                ],
                "sequenceNr": 0
              }
            ],
            "options": [
              "identifier"
            ]
          }
        ],
        "filters": [
          {
            "selector": "string",
            "comparisonType": "equal",
            "value": "string",
            "linkType": "and",
            "filters": [
              {}
            ],
            "sequenceNr": 0
          }
        ],
        "template": true
      }
    ],
    "enabled": true,
    "lastHandled": "2019-08-24T14:15:22Z",
    "triggerType": "trigger",
    "triggerEvent": "afterCreatingTrip",
    "filters": [
      {
        "selector": "string",
        "comparisonType": "equal",
        "value": "string",
        "linkType": "and",
        "filters": [
          {}
        ],
        "sequenceNr": 0
      }
    ]
  }'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
integrationobject(IntegrationModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "integration": {
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "type": "manual",
    "name": "string",
    "description": "string",
    "schedule": { … },
    "dataSources": [ … ],
    "enabled": true,
    "lastHandled": "2019-08-24T14:15:22Z",
    "triggerType": "trigger",
    "triggerEvent": "afterCreatingTrip",
    "filters": [ … ]
  }
}

Create integration

Request

Create a new integration

Headers
Authorizationstringrequired
Bodyapplication/jsonrequired
idstring
noncestring
uuidstring
primaryPlatformIdstring
createdAtstring(date-time)
updatedAtstring(date-time)
typestring
Enum"manual""configured""messageAutomation""fileTemplate""apiAccess"
Discriminator
namestring
descriptionstring
scheduleobject(IntegrationSchedulerSchedule)
dataSourcesArray of objects(IntegrationDataSourceModel)
enabledboolean
lastHandledstring(date-time)
triggerTypestring
Enum"trigger""scheduler""listener"
triggerEventstring
Enum"afterCreatingTrip""afterUpdatingTrip""afterConfirmingTrip""afterStartingTrip""afterFinishingTrip""afterCancelingTrip""afterLocationUpdateEvent""afterCreatingMessage""afterUpdatingMessage""afterCreatingEvent"
filtersArray of objects(IntegrationFilter)
curl -i -X POST \
  https://docs.transportial.com/_mock/apis/integration \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "type": "configured",
    "name": "string",
    "description": "string",
    "schedule": {
      "integrationSchedulerScheduleValue": 0,
      "integrationSchedulerScheduleType": "seconds",
      "milliseconds": 0
    },
    "dataSources": [
      {
        "id": "string",
        "nonce": "string",
        "uuid": "string",
        "primaryPlatformId": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "directionType": "in",
        "connectionType": "api",
        "requestMethod": "get",
        "dataType": "xml",
        "entityType": "action",
        "url": "string",
        "port": 0,
        "path": "string",
        "token": "string",
        "query": "string",
        "parameters": [
          {
            "sequenceNr": 0,
            "type": "constant",
            "regex": "string",
            "format": "string",
            "locale": "string",
            "zoneId": "string",
            "incomingPath": "string",
            "outgoingPath": "string",
            "fields": [
              {}
            ],
            "filters": [
              {
                "selector": "string",
                "comparisonType": "equal",
                "value": "string",
                "linkType": "and",
                "filters": [
                  null
                ],
                "sequenceNr": 0
              }
            ],
            "options": [
              "identifier"
            ]
          }
        ],
        "allowedIps": [
          "string"
        ],
        "hasAuthentication": true,
        "credentials": {
          "id": "string",
          "nonce": "string",
          "uuid": "string",
          "primaryPlatformId": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "authenticationMethod": "apiKey",
          "username": "string",
          "password": "string",
          "accessKey": "string",
          "secretKey": "string",
          "clientId": "string",
          "clientSecret": "string",
          "grantType": "string",
          "scope": "string",
          "apiKey": "string",
          "bearer": "string",
          "sshKey": {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "url": "string",
            "path": "string",
            "name": "string",
            "originalName": "string",
            "size": 0,
            "purpose": "string",
            "type": "IMAGE",
            "mimeType": "string",
            "extension": "string",
            "uploadedAt": "2019-08-24T14:15:22Z"
          },
          "sshTunnel": true,
          "sshHost": "string",
          "sshUsername": "string",
          "sshPassword": "string",
          "externalAttributes": {
            "property1": {},
            "property2": {}
          },
          "headers": {
            "property1": {},
            "property2": {}
          },
          "oauthUrl": "string",
          "oAuthCache": "string",
          "oAuthCacheCreationDate": "2019-08-24T14:15:22Z",
          "openIdToken": "string",
          "openIdRefreshToken": "string",
          "openIdAccessToken": "string",
          "openIdExpiration": "2019-08-24T14:15:22Z"
        },
        "otm": true,
        "fields": [
          {
            "sequenceNr": 0,
            "type": "constant",
            "regex": "string",
            "format": "string",
            "locale": "string",
            "zoneId": "string",
            "incomingPath": "string",
            "outgoingPath": "string",
            "fields": [
              {}
            ],
            "filters": [
              {
                "selector": "string",
                "comparisonType": "equal",
                "value": "string",
                "linkType": "and",
                "filters": [
                  null
                ],
                "sequenceNr": 0
              }
            ],
            "options": [
              "identifier"
            ]
          }
        ],
        "filters": [
          {
            "selector": "string",
            "comparisonType": "equal",
            "value": "string",
            "linkType": "and",
            "filters": [
              {}
            ],
            "sequenceNr": 0
          }
        ],
        "template": true
      }
    ],
    "enabled": true,
    "lastHandled": "2019-08-24T14:15:22Z",
    "triggerType": "trigger",
    "triggerEvent": "afterCreatingTrip",
    "filters": [
      {
        "selector": "string",
        "comparisonType": "equal",
        "value": "string",
        "linkType": "and",
        "filters": [
          {}
        ],
        "sequenceNr": 0
      }
    ]
  }'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
integrationobject(IntegrationModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "integration": {
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "type": "manual",
    "name": "string",
    "description": "string",
    "schedule": { … },
    "dataSources": [ … ],
    "enabled": true,
    "lastHandled": "2019-08-24T14:15:22Z",
    "triggerType": "trigger",
    "triggerEvent": "afterCreatingTrip",
    "filters": [ … ]
  }
}

Get integration

Request

Get a integration on id

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

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
integrationobject(IntegrationModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "integration": {
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "type": "manual",
    "name": "string",
    "description": "string",
    "schedule": { … },
    "dataSources": [ … ],
    "enabled": true,
    "lastHandled": "2019-08-24T14:15:22Z",
    "triggerType": "trigger",
    "triggerEvent": "afterCreatingTrip",
    "filters": [ … ]
  }
}

Delete integration

Request

Delete a integration

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

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
integrationobject(IntegrationModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "integration": {
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "type": "manual",
    "name": "string",
    "description": "string",
    "schedule": { … },
    "dataSources": [ … ],
    "enabled": true,
    "lastHandled": "2019-08-24T14:15:22Z",
    "triggerType": "trigger",
    "triggerEvent": "afterCreatingTrip",
    "filters": [ … ]
  }
}

Generate integration credentials

Request

Generate all new integration credentials

Headers
Authorizationstringrequired
Bodyapplication/jsonrequired
noncestring

Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created.

authenticationMethodstring
Enum"apiKey""accessKeys""basic""OAuth""bearer""openId""headers"
usernamestring
passwordstring
accessKeystring
secretKeystring
clientIdstring
clientSecretstring
grantTypestring
scopestring
apiKeystring
bearerstring
sshKeyobject(File)
sshTunnelboolean
sshHoststring
sshUsernamestring
sshPasswordstring
externalAttributesobject
headersobject
oauthUrlstring
oAuthCachestring
oAuthCacheCreationDatestring(date-time)
openIdTokenstring
openIdRefreshTokenstring
openIdAccessTokenstring
openIdExpirationstring(date-time)
curl -i -X POST \
  https://docs.transportial.com/_mock/apis/integration/generate/credentials \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "nonce": "string",
    "authenticationMethod": "apiKey",
    "username": "string",
    "password": "string",
    "accessKey": "string",
    "secretKey": "string",
    "clientId": "string",
    "clientSecret": "string",
    "grantType": "string",
    "scope": "string",
    "apiKey": "string",
    "bearer": "string",
    "sshKey": {
      "nonce": "string",
      "url": "string",
      "path": "string",
      "name": "string",
      "originalName": "string",
      "size": 0,
      "purpose": "string",
      "type": "IMAGE",
      "mimeType": "string",
      "extension": "string",
      "uploadedAt": "2019-08-24T14:15:22Z"
    },
    "sshTunnel": true,
    "sshHost": "string",
    "sshUsername": "string",
    "sshPassword": "string",
    "externalAttributes": {
      "property1": {},
      "property2": {}
    },
    "headers": {
      "property1": {},
      "property2": {}
    },
    "oauthUrl": "string",
    "oAuthCache": "string",
    "oAuthCacheCreationDate": "2019-08-24T14:15:22Z",
    "openIdToken": "string",
    "openIdRefreshToken": "string",
    "openIdAccessToken": "string",
    "openIdExpiration": "2019-08-24T14:15:22Z"
  }'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
credentialsobject(IntegrationCredentialsModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "credentials": {
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "authenticationMethod": "apiKey",
    "username": "string",
    "password": "string",
    "accessKey": "string",
    "secretKey": "string",
    "clientId": "string",
    "clientSecret": "string",
    "grantType": "string",
    "scope": "string",
    "apiKey": "string",
    "bearer": "string",
    "sshKey": { … },
    "sshTunnel": true,
    "sshHost": "string",
    "sshUsername": "string",
    "sshPassword": "string",
    "externalAttributes": { … },
    "headers": { … },
    "oauthUrl": "string",
    "oAuthCache": "string",
    "oAuthCacheCreationDate": "2019-08-24T14:15:22Z",
    "openIdToken": "string",
    "openIdRefreshToken": "string",
    "openIdAccessToken": "string",
    "openIdExpiration": "2019-08-24T14:15:22Z"
  }
}

Get integration logs

Request

Get list of integration logs

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

Responses

Success

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

Get integration logs

Request

Get list of integrations

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

Responses

Success

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

Get integration request logs

Request

Get list of integration request logs

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

Responses

Success

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

Get integration tasks

Request

Get list of integration tasks

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

Responses

Success

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

Get integrations

Request

Get list of integrations

Path
offsetinteger(int64)required
amountinteger(int64)required
Headers
Authorizationstringrequired
curl -i -X GET \
  'https://docs.transportial.com/_mock/apis/integrations/{offset}/{amount}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

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

Get integrations

Request

Get list of integrations

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

Responses

Success

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

Get manual integration functions

Request

Get list of manual integration functions

Path
typestringrequired
Headers
Authorizationstringrequired
curl -i -X GET \
  'https://docs.transportial.com/_mock/apis/integration/type/{type}/functions' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
totalResultsinteger(int32)
functionsArray of strings
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "totalResults": 0,
  "functions": [
    "string"
  ]
}

Import data

Request

Import data from any format through our mapping tool into the platform

Headers
Authorizationstringrequired
Bodyapplication/jsonrequired
successboolean
messagestring
codeinteger(int32)
curl -i -X POST \
  https://docs.transportial.com/_mock/apis/integration/import/data \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "success": true,
    "message": "string",
    "code": 0
  }'

Responses

Success

Bodyapplication/json
datastring
entityTypestring
Enum"action""attachTransportEquipmentAction""detachTransportEquipmentAction""stopAction""loadAction""unloadAction""waitAction""consignment""extendedConsignment""transportEquipment"
fieldsArray of objects(IntegrationField)
Response
application/json
{
  "data": "string",
  "entityType": "action",
  "fields": [
    { … }
  ]
}

Handle

Request

Create a new integration

Path
idstringrequired
dataSourceIdstringrequired
tokenstringrequired
Headers
X-API-KEYstring
X-API-SECRETstring
Authorisationstring
curl -i -X GET \
  'https://docs.transportial.com/_mock/apis/integration/{id}/dataSource/{dataSourceId}/{token}' \
  -H 'Authorisation: string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-API-KEY: string' \
  -H 'X-API-SECRET: string'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
integrationobject(IntegrationModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "integration": {
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "type": "manual",
    "name": "string",
    "description": "string",
    "schedule": { … },
    "dataSources": [ … ],
    "enabled": true,
    "lastHandled": "2019-08-24T14:15:22Z",
    "triggerType": "trigger",
    "triggerEvent": "afterCreatingTrip",
    "filters": [ … ]
  }
}

Handle incoming email

Request

Tne endpoint to receive email data

curl -i -X POST \
  https://docs.transportial.com/_mock/apis/integration/email \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
integrationobject(IntegrationModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "integration": {
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "type": "manual",
    "name": "string",
    "description": "string",
    "schedule": { … },
    "dataSources": [ … ],
    "enabled": true,
    "lastHandled": "2019-08-24T14:15:22Z",
    "triggerType": "trigger",
    "triggerEvent": "afterCreatingTrip",
    "filters": [ … ]
  }
}

Set open id authentication token

Request

Enable the authentication flow for OpenId by setting the toke

Path
idstringrequired
Query
tokenstring
curl -i -X PUT \
  'https://docs.transportial.com/_mock/apis/integration/{id}/openId?token=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

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

Handle

Request

Create a new integration

Path
tokenstringrequired
idstringrequired
curl -i -X GET \
  'https://docs.transportial.com/_mock/apis/integration/{id}/{token}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
integrationobject(IntegrationModel)
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "integration": {
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "type": "manual",
    "name": "string",
    "description": "string",
    "schedule": { … },
    "dataSources": [ … ],
    "enabled": true,
    "lastHandled": "2019-08-24T14:15:22Z",
    "triggerType": "trigger",
    "triggerEvent": "afterCreatingTrip",
    "filters": [ … ]
  }
}

Test DataSource mapping

Request

Ability to test the integration DataSource field mapping response

Headers
Authorizationstringrequired
Bodyapplication/jsonrequired
successboolean
messagestring
codeinteger(int32)
datastring
curl -i -X POST \
  https://docs.transportial.com/_mock/apis/integration/dataSource/mapping:test \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "success": true,
    "message": "string",
    "code": 0,
    "data": "string"
  }'

Responses

Success

Bodyapplication/json
datastring
dataSourceobject(IntegrationDataSource)
Response
application/json
{
  "data": "string",
  "dataSource": {
    "id": "string",
    "nonce": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "directionType": "in",
    "connectionType": "api",
    "requestMethod": "get",
    "dataType": "xml",
    "entityType": "action",
    "url": "string",
    "port": 0,
    "path": "string",
    "token": "string",
    "query": "string",
    "parameters": [ … ],
    "allowedIps": [ … ],
    "hasAuthentication": true,
    "credentials": { … },
    "otm": true,
    "fields": [ … ],
    "filters": [ … ],
    "template": true
  }
}

Test fileTemplate mapping

Request

Ability to test the integration fileTemplate field mapping response

Headers
Authorizationstringrequired
Bodyapplication/jsonrequired
noncestring

Nonce, a field that is not saved and returns exactly the same value you sent. This ensures you can identify your object that has been updated or created.

typestring
Enum"manual""configured""messageAutomation""fileTemplate""apiAccess"
Discriminator
namestring
descriptionstring
scheduleobject(IntegrationSchedulerSchedule)
dataSourcesArray of objects(IntegrationDataSource)
enabledboolean
lastHandledstring(date-time)
integrationArray of objects(Note)
triggerTypestring
Enum"trigger""scheduler""listener"
triggerEventstring
Enum"afterCreatingTrip""afterUpdatingTrip""afterConfirmingTrip""afterStartingTrip""afterFinishingTrip""afterCancelingTrip""afterLocationUpdateEvent""afterCreatingMessage""afterUpdatingMessage""afterCreatingEvent"
filtersArray of objects(IntegrationFilter)
curl -i -X POST \
  https://docs.transportial.com/_mock/apis/integration/fileTemplate/mapping:test \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "nonce": "string",
    "type": "configured",
    "name": "string",
    "description": "string",
    "schedule": {
      "integrationSchedulerScheduleValue": 0,
      "integrationSchedulerScheduleType": "seconds",
      "milliseconds": 0
    },
    "dataSources": [
      {
        "nonce": "string",
        "directionType": "in",
        "connectionType": "api",
        "requestMethod": "get",
        "dataType": "xml",
        "entityType": "action",
        "url": "string",
        "port": 0,
        "path": "string",
        "token": "string",
        "query": "string",
        "parameters": [
          {
            "sequenceNr": 0,
            "type": "constant",
            "regex": "string",
            "format": "string",
            "locale": "string",
            "zoneId": "string",
            "incomingPath": "string",
            "outgoingPath": "string",
            "fields": [
              {}
            ],
            "filters": [
              {
                "selector": "string",
                "comparisonType": "equal",
                "value": "string",
                "linkType": "and",
                "filters": [
                  null
                ],
                "sequenceNr": 0
              }
            ],
            "options": [
              "identifier"
            ]
          }
        ],
        "allowedIps": [
          "string"
        ],
        "hasAuthentication": true,
        "credentials": {
          "nonce": "string",
          "authenticationMethod": "apiKey",
          "username": "string",
          "password": "string",
          "accessKey": "string",
          "secretKey": "string",
          "clientId": "string",
          "clientSecret": "string",
          "grantType": "string",
          "scope": "string",
          "apiKey": "string",
          "bearer": "string",
          "sshKey": {
            "nonce": "string",
            "url": "string",
            "path": "string",
            "name": "string",
            "originalName": "string",
            "size": 0,
            "purpose": "string",
            "type": "IMAGE",
            "mimeType": "string",
            "extension": "string",
            "uploadedAt": "2019-08-24T14:15:22Z"
          },
          "sshTunnel": true,
          "sshHost": "string",
          "sshUsername": "string",
          "sshPassword": "string",
          "externalAttributes": {
            "property1": {},
            "property2": {}
          },
          "headers": {
            "property1": {},
            "property2": {}
          },
          "oauthUrl": "string",
          "oAuthCache": "string",
          "oAuthCacheCreationDate": "2019-08-24T14:15:22Z",
          "openIdToken": "string",
          "openIdRefreshToken": "string",
          "openIdAccessToken": "string",
          "openIdExpiration": "2019-08-24T14:15:22Z"
        },
        "otm": true,
        "fields": [
          {
            "sequenceNr": 0,
            "type": "constant",
            "regex": "string",
            "format": "string",
            "locale": "string",
            "zoneId": "string",
            "incomingPath": "string",
            "outgoingPath": "string",
            "fields": [
              {}
            ],
            "filters": [
              {
                "selector": "string",
                "comparisonType": "equal",
                "value": "string",
                "linkType": "and",
                "filters": [
                  null
                ],
                "sequenceNr": 0
              }
            ],
            "options": [
              "identifier"
            ]
          }
        ],
        "filters": [
          {
            "selector": "string",
            "comparisonType": "equal",
            "value": "string",
            "linkType": "and",
            "filters": [
              {}
            ],
            "sequenceNr": 0
          }
        ],
        "template": true
      }
    ],
    "enabled": true,
    "lastHandled": "2019-08-24T14:15:22Z",
    "integration": [
      {
        "nonce": "string",
        "author": {
          "nonce": "string",
          "hasAgreedToPrice": true,
          "type": "user",
          "username": "string",
          "firstName": "string",
          "lastName": "string",
          "email": "string",
          "phone": "string",
          "passwordModified": "2019-08-24T14:15:22Z",
          "twoFactorAuthentication": true,
          "status": "DELETED",
          "loginMethod": "DEFAULT",
          "accountType": "default",
          "standardLoadingSize": 10,
          "timezone": "string",
          "vehicleGroups": [
            {
              "nonce": "string",
              "name": "string",
              "vehicles": [
                {
                  "loadCapacities": [],
                  "actors": [],
                  "attributes": []
                }
              ]
            }
          ]
        },
        "name": "string",
        "text": "string"
      }
    ],
    "triggerType": "trigger",
    "triggerEvent": "afterCreatingTrip",
    "filters": [
      {
        "selector": "string",
        "comparisonType": "equal",
        "value": "string",
        "linkType": "and",
        "filters": [
          {}
        ],
        "sequenceNr": 0
      }
    ]
  }'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
datastring
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "data": "string"
}

Upload a template file

Request

Upload a new file

Headers
Authorizationstringrequired
Bodyapplication/jsonrequired
idstring
noncestring
uuidstring
primaryPlatformIdstring
createdAtstring(date-time)
updatedAtstring(date-time)
urlstring
pathstring
namestring
originalNamestring
sizeinteger(int64)
purposestring
typestring
Enum"IMAGE""VIDEO""MUSIC""WORD""EXCEL""CSV""PDF""EMAIL""JSON"
mimeTypestring
extensionstring
uploadedAtstring(date-time)
curl -i -X POST \
  https://docs.transportial.com/_mock/apis/integration/file/upload \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "url": "string",
    "path": "string",
    "name": "string",
    "originalName": "string",
    "size": 0,
    "purpose": "string",
    "type": "IMAGE",
    "mimeType": "string",
    "extension": "string",
    "uploadedAt": "2019-08-24T14:15:22Z"
  }'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
fileobject(FileModel)
matrixArray of strings
matrixFingerPrintstring
htmlstring
htmlFingerPrintstring
Response
application/json
{
  "success": true,
  "message": "string",
  "code": 0,
  "file": {
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "url": "string",
    "path": "string",
    "name": "string",
    "originalName": "string",
    "size": 0,
    "purpose": "string",
    "type": "IMAGE",
    "mimeType": "string",
    "extension": "string",
    "uploadedAt": "2019-08-24T14:15:22Z"
  },
  "matrix": [
    [ … ]
  ],
  "matrixFingerPrint": "string",
  "html": "string",
  "htmlFingerPrint": "string"
}

Lane

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

Operations

ToDo

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

Operations

Location

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

Operations

Mail

Mails can be stacked and constrain different activities in their context

Operations

Management

The management overviews

Operations

MessageAutomation

Message-Automations are communication automation connectors that can use events

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

Platform

Platforms can be stacked and constrain different activities in their context

Operations

SAML

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

Operations

Pricing

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

Operations

Route

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

Operations

Routing

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

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

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

Support

Support tickets are there to diagnose issues in the software or help users if they have a question

Operations

Tachograph

Tachograph methods

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

Tender

Tenders can be stacked and constrain different activities in their context

Operations

Terminal

Terminals

Operations

ToDoComment

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

Operations

TQL

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

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

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

Type

Types

Operations

User

Users related to the platform and all actions required

Operations

User roles

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

Operations

Settings

The user settings for the system

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

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 transport (by air, on land, over sea).

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

Widget

Widgets can be stacked and constrain different activities in their context

Operations