Transportial OTMS API (0.9.2)

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

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

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.

Actors can be stacked and constrain different activities in their context

Charges

Invoices

LedgerEntry ...

Payouts

Plans

Quotes

Administrations can be stacked and constrain different activities in their context

Transactions

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

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

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

A generic entity that can help in defining other entities properties

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

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

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

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.

A Camera

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

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

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

Sending messages to users grouped by rooms

MessageTemplates can be stacked and constrain different activities in their context

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

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

Consignments can be stacked and constrain different activities in their context

Constraints can be stacked and constrain different activities in their context

Contracts

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

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

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.

Feedbacks

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

Fleets can be stacked and constrain different activities in their context

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

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.

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.

All the insights you need can be gathered from these endpoints

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.

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

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

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

Mails can be stacked and constrain different activities in their context

The management overviews

Message-Automations are communication automation connectors that can use events

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

Platforms can be stacked and constrain different activities in their context

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

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

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

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

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

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

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

Tachograph methods

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.

Tenders can be stacked and constrain different activities in their context

Terminals

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

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

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.

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.

Types