Calendar occurrences for vehicles within a date range.
API Reference//
- Received message
Get message
Delete message
Read message
Update chat external integration
Delete chat external integration
Get chat
Delete chat
Unread chat
Get all chats
Get all chats
Send message to external channel
Get chat external integrations
Create chat external integration
Update chat
Create chat
Update message
Create chat message
Received message
Read message
Get all chats
Search all chats
Get translated message
Received message
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
Overview
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
- Mock serverhttps://docs.transportial.com/_mock/apis/chat/messages/{id}/{offset}/{amount}
- Test environmenthttps://test.api.otms.transportial.com/api/chat/messages/{id}/{offset}/{amount}
- Productionhttps://api.otms.transportial.com/api/chat/messages/{id}/{offset}/{amount}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.transportial.com/_mock/apis/chat/messages/{id}/{offset}/{amount}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "messages": [ { … } ], "unreadResults": 0 }
- Mock serverhttps://docs.transportial.com/_mock/apis/chat/message/{id}/received
- Test environmenthttps://test.api.otms.transportial.com/api/chat/message/{id}/received
- Productionhttps://api.otms.transportial.com/api/chat/message/{id}/received
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.transportial.com/_mock/apis/chat/message/{id}/received' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "success": true, "message": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "language": {}, "chat": {}, "user": { … }, "message": "string", "state": "normal", "type": "normal", "edited": true, "files": [ … ], "replyTo": {}, "responses": [ … ], "received": [ … ], "read": [ … ], "identifiers": [ … ], "mailMessage": { … }, "translatedMessage": "string" } }
- Mock serverhttps://docs.transportial.com/_mock/apis/chat/message:translate/{id}
- Test environmenthttps://test.api.otms.transportial.com/api/chat/message:translate/{id}
- Productionhttps://api.otms.transportial.com/api/chat/message:translate/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.transportial.com/_mock/apis/chat/message:translate/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "success": true, "message": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "language": {}, "chat": {}, "user": { … }, "message": "string", "state": "normal", "type": "normal", "edited": true, "files": [ … ], "replyTo": {}, "responses": [ … ], "received": [ … ], "read": [ … ], "identifiers": [ … ], "mailMessage": { … }, "translatedMessage": "string" } }
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
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
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