Calendar occurrences for vehicles within a date range.
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
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
- Mock serverhttps://docs.transportial.com/_mock/apis/locations/{offset}/{amount}
- Test environmenthttps://test.api.otms.transportial.com/api/locations/{offset}/{amount}
- Productionhttps://api.otms.transportial.com/api/locations/{offset}/{amount}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.transportial.com/_mock/apis/locations/{offset}/{amount}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "locations": [ { … } ] }
- Mock serverhttps://docs.transportial.com/_mock/apis/locations/{offset}/{amount}
- Test environmenthttps://test.api.otms.transportial.com/api/locations/{offset}/{amount}
- Productionhttps://api.otms.transportial.com/api/locations/{offset}/{amount}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.transportial.com/_mock/apis/locations/{offset}/{amount}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "locations": [ { … } ] }
Bodyapplication/jsonrequired
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.
Enum"warehouse""store""environmentalZone""restrictedArea""customer""parkingSpot""loadingUnloadingArea""operationalBase""fuelStation"
- Mock serverhttps://docs.transportial.com/_mock/apis/location
- Test environmenthttps://test.api.otms.transportial.com/api/location
- Productionhttps://api.otms.transportial.com/api/location
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://docs.transportial.com/_mock/apis/location \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "warehouse",
"name": "string",
"unCode": "string",
"geoReference": {
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "addressGeoReference",
"name": "string",
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"postalCode": "string",
"city": "string",
"country": "string",
"hash": "string"
},
"administrativeReference": {
"name": "string",
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"postalCode": "string",
"city": "string",
"country": "string"
},
"contactDetails": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "iban",
"value": "string",
"remarks": "string"
}
],
"openingTimes": {
"monday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
},
"tuesday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
},
"wednesday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
},
"thursday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
},
"friday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
},
"saturday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
},
"sunday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
}
},
"terminal": {
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"integrationType": "portbase",
"ean": "string",
"bicsCode": "string",
"quayName": "string",
"smdgCode": "string",
"locations": [
{}
],
"allowedModalities": [
"string"
],
"terminalSettings": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"loading": true,
"full": true,
"modality": "string",
"sealNumberAllowed": true,
"reeferAllowed": true,
"grossWeightAllowed": true,
"outOfGaugeAllowed": true,
"dangerousGoodsAllowed": true,
"cargoCutOffInMinutes": 0
}
],
"tarRequired": true,
"roadLicenseIdRequired": true
},
"actions": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "load",
"groupId": "string",
"name": "string",
"externalAttributes": {
"property1": {},
"property2": {}
},
"identifiers": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"system": "string",
"value": "string",
"expiredAt": "2019-08-24T14:15:22Z"
}
],
"lifeCycle": "requested",
"result": {
"status": "succeeded",
"remark": "string",
"reason": "string",
"results": [
{
"property1": {},
"property2": {}
}
],
"answers": {
"property1": {},
"property2": {}
},
"attachments": [
{
"questionId": "string",
"type": "photo",
"documentId": "string",
"dataUrl": "string"
}
]
},
"remark": "string",
"sequenceNr": 0,
"tripSequenceNr": 0,
"location": {
"associationType": "inline",
"entity": {},
"description": "string"
},
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"eta": "2019-08-24T14:15:22Z",
"etd": "2019-08-24T14:15:22Z",
"timeFormat": "string",
"recurrence": "string",
"duration": 0,
"estimatedDuration": 0,
"inTripOnly": true,
"actions": [
{
"associationType": "inline",
"entity": {
"nonce": "string",
"versionNumber": 0,
"type": "load",
"name": "string",
"groupId": "string",
"externalAttributes": {
"property1": {},
"property2": {}
},
"lifeCycle": "requested",
"result": {
"status": "succeeded",
"remark": "string",
"reason": "string",
"results": [
{}
],
"answers": {
"property1": {},
"property2": {}
},
"attachments": [
null
]
},
"remark": "string",
"sequenceNr": 0,
"tripSequenceNr": 0,
"location": {
"associationType": "inline",
"entity": {},
"description": "string"
},
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"eta": "2019-08-24T14:15:22Z",
"etd": "2019-08-24T14:15:22Z",
"timeFormat": "string",
"recurrence": "string",
"duration": 0,
"estimatedDuration": 0,
"inTripOnly": true,
"actions": [
{}
],
"documents": [
{}
],
"contextEvents": [
{
"externalAttributes": {},
"identifiers": []
}
],
"attributes": [
{}
],
"timeslotBookings": [
{
"action": {},
"bookedBy": {}
}
],
"identifiers": [
{}
],
"constraints": [
{}
],
"communicationRequests": [
{
"communicationRequests": []
}
],
"consignment": {
"associationType": "inline",
"entity": {
"goods": [],
"consignment": {},
"nextAction": {},
"lastAction": {},
"lastPlannedAction": {},
"documents": [],
"actors": [],
"actions": [],
"pricingElements": [],
"externalAttributes": {},
"constraints": [],
"identifiers": [],
"attributes": []
}
},
"isContainmentAction": true,
"vehicle": {
"associationType": "inline"
},
"transportEquipment": {
"associationType": "inline"
},
"stop": {},
"pin": "string",
"tar": "string",
"shipmentLine": {
"scacCode": "string",
"smdgCode": "string"
},
"containmentUUID": "string"
},
"description": "string"
}
],
"communicationRequests": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"description": "string",
"status": "pending",
"responseMessage": "string",
"responseValue": "string"
}
],
"documents": [
{
"associationType": "inline"
}
],
"contextEvents": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "generalEvent",
"lifeCycle": "requested",
"externalAttributes": {
"property1": {},
"property2": {}
},
"identifiers": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"system": "string",
"value": "string",
"expiredAt": "2019-08-24T14:15:22Z"
}
],
"dateTime": "2019-08-24T14:15:22Z",
"vehicle": {},
"transportEquipment": {},
"stopAction": {
"trip": {
"associationType": "inline",
"entity": {},
"description": "string"
}
},
"geoReference": {
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "addressGeoReference",
"name": "string",
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"postalCode": "string",
"city": "string",
"country": "string",
"hash": "string"
}
}
],
"attributes": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"color": "string"
}
],
"versionNumber": 0,
"constraints": [
{
"associationType": "inline",
"entity": {
"nonce": "string",
"name": "string",
"enforceability": "enforced",
"type": "accessConstraint",
"description": "string"
},
"description": "string"
}
],
"consignment": {
"associationType": "inline",
"entity": {
"nonce": "string",
"versionNumber": 0,
"hasAgreedToPrice": true,
"orderType": "standard",
"name": "string",
"consignmentNr": "string",
"description": "string",
"status": "draft",
"highValueGoods": true,
"goods": [
{
"associationType": "inline"
}
],
"team": {
"nonce": "string",
"emailIntegration": {},
"vehicleGroups": [
{
"vehicles": []
}
],
"fleets": [
{
"vehicles": [],
"teams": [],
"businesses": []
}
],
"features": [
{
"accountTypes": []
}
],
"managers": [
{}
],
"name": "string",
"transportOrderPrefix": "string",
"consignmentPrefix": "string",
"users": [
{}
]
},
"consignment": {},
"currentLocation": {
"administrativeReference": {
"name": "string",
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"postalCode": "string",
"city": "string",
"country": "string"
},
"lat": 0.1,
"lon": 0.1,
"speed": {
"value": "string",
"unit": "string"
},
"heading": {
"value": "string",
"unit": "string"
},
"bearing": {
"value": "string",
"unit": "string"
},
"bearingType": "absolute"
},
"nextAction": {},
"lastAction": {},
"lastPlannedAction": {},
"isPlannedToLastLocation": true,
"documents": [
{
"associationType": "inline"
}
],
"actors": [
{
"associationType": "inline"
}
],
"actions": [
{
"associationType": "inline"
}
],
"pricingElements": [
{
"nonce": "string",
"sequenceNr": 0,
"quantity": 0,
"name": "string",
"description": "string",
"category": {
"identifiers": []
},
"business": {},
"amount": {},
"subTotal": {},
"tax": {},
"total": {}
}
],
"externalAttributes": {
"property1": {},
"property2": {}
},
"expectedRevenue": {
"amount": 0.1,
"currency": {
"nonce": "string",
"name": "string",
"short": "string",
"sign": "string",
"decimalDelimiter": "string",
"thousandDelimiter": "string",
"enabled": true
},
"taxRate": {
"nonce": "string",
"creditCode": "string",
"debitCode": "string",
"identifiers": [
null
],
"name": "string",
"description": "string",
"jurisdiction": "string",
"percentage": 0.1,
"inclusive": true,
"active": true
},
"inclusiveOfTax": true,
"moneyBuildBlocks": [
{}
]
},
"expectedCost": {
"amount": 0.1,
"currency": {
"nonce": "string",
"name": "string",
"short": "string",
"sign": "string",
"decimalDelimiter": "string",
"thousandDelimiter": "string",
"enabled": true
},
"taxRate": {
"nonce": "string",
"creditCode": "string",
"debitCode": "string",
"identifiers": [
null
],
"name": "string",
"description": "string",
"jurisdiction": "string",
"percentage": 0.1,
"inclusive": true,
"active": true
},
"inclusiveOfTax": true,
"moneyBuildBlocks": [
{}
]
},
"combined": true,
"type": "string",
"remark": "string",
"constraints": [
{
"nonce": "string",
"name": "string",
"enforceability": "enforced",
"type": "accessConstraint",
"description": "string"
}
],
"identifiers": [
{
"nonce": "string",
"name": "string",
"system": "string",
"value": "string",
"expiredAt": "2019-08-24T14:15:22Z"
}
],
"attributes": [
{
"nonce": "string",
"name": "string",
"color": "string"
}
]
}
},
"isContainmentAction": true,
"vehicle": {
"associationType": "inline"
},
"transportEquipment": {
"associationType": "inline"
},
"stop": {
"associationType": "inline",
"entity": {
"nonce": "string",
"versionNumber": 0,
"type": "load",
"name": "string",
"groupId": "string",
"externalAttributes": {
"property1": {},
"property2": {}
},
"lifeCycle": "requested",
"result": {
"status": "succeeded",
"remark": "string",
"reason": "string",
"results": [
{
"property1": {},
"property2": {}
}
],
"answers": {
"property1": {},
"property2": {}
},
"attachments": [
{}
]
},
"remark": "string",
"sequenceNr": 0,
"tripSequenceNr": 0,
"location": {
"associationType": "inline",
"entity": {},
"description": "string"
},
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"eta": "2019-08-24T14:15:22Z",
"etd": "2019-08-24T14:15:22Z",
"timeFormat": "string",
"recurrence": "string",
"duration": 0,
"estimatedDuration": 0,
"inTripOnly": true,
"actions": [
{}
],
"documents": [
{
"associationType": "inline"
}
],
"contextEvents": [
{
"nonce": "string",
"type": "generalEvent",
"lifeCycle": "requested",
"externalAttributes": {
"property1": {},
"property2": {}
},
"dateTime": "2019-08-24T14:15:22Z",
"identifiers": [
null
],
"vehicle": {
"business": {},
"pictures": [],
"loadCapacities": [],
"boardComputers": [],
"notes": [],
"sensors": [],
"fleets": [],
"chauffeurs": [],
"transportEquipments": [],
"actors": [],
"identifiers": [],
"cameras": [],
"pricingModules": [],
"axles": [],
"attributes": []
},
"transportEquipment": {
"documents": [],
"actors": [],
"actions": [],
"identifiers": [],
"requirementCodes": [],
"sensors": [],
"boardComputers": [],
"business": {},
"pricingModules": [],
"constraints": [],
"attributes": [],
"axles": []
},
"stopAction": {},
"geoReference": {}
}
],
"attributes": [
{
"nonce": "string",
"name": "string",
"color": "string"
}
],
"timeslotBookings": [
{
"nonce": "string",
"timeslot": {},
"action": {},
"consignment": {
"goods": [],
"consignment": {},
"nextAction": {},
"lastAction": {},
"lastPlannedAction": {},
"documents": [],
"actors": [],
"actions": [],
"pricingElements": [],
"externalAttributes": {},
"constraints": [],
"identifiers": [],
"attributes": []
},
"status": "REQUESTED",
"bookingDate": "2019-08-24",
"bookingStartTime": "2019-08-24T14:15:22Z",
"bookingEndTime": "2019-08-24T14:15:22Z",
"bookedBy": {},
"bookedAt": "2019-08-24T14:15:22Z",
"confirmedAt": "2019-08-24T14:15:22Z",
"cancelledAt": "2019-08-24T14:15:22Z",
"cancellationReason": "string",
"referenceNumber": "string",
"notes": "string",
"actualArrivalTime": "2019-08-24T14:15:22Z",
"actualDepartureTime": "2019-08-24T14:15:22Z"
}
],
"identifiers": [
{
"nonce": "string",
"name": "string",
"system": "string",
"value": "string",
"expiredAt": "2019-08-24T14:15:22Z"
}
],
"constraints": [
{
"associationType": "inline",
"entity": {},
"description": "string"
}
],
"communicationRequests": [
{
"nonce": "string",
"name": "string",
"description": "string",
"status": "pending",
"responseMessage": "string",
"responseValue": "string",
"communicationRequests": [
{}
]
}
],
"consignment": {
"associationType": "inline",
"entity": {
"nonce": "string",
"versionNumber": 0,
"hasAgreedToPrice": true,
"orderType": "standard",
"name": "string",
"consignmentNr": "string",
"description": "string",
"status": "draft",
"highValueGoods": true,
"goods": [
null
],
"team": {
"emailIntegration": {},
"vehicleGroups": [],
"fleets": [],
"features": [],
"managers": [],
"users": []
},
"consignment": {},
"currentLocation": {},
"nextAction": {},
"lastAction": {},
"lastPlannedAction": {},
"isPlannedToLastLocation": true,
"documents": [
null
],
"actors": [
null
],
"actions": [
null
],
"pricingElements": [
null
],
"externalAttributes": {
"property1": {},
"property2": {}
},
"expectedRevenue": {
"moneyBuildBlocks": []
},
"expectedCost": {
"moneyBuildBlocks": []
},
"combined": true,
"type": "string",
"remark": "string",
"constraints": [
null
],
"identifiers": [
null
],
"attributes": [
null
]
}
},
"isContainmentAction": true,
"vehicle": {
"associationType": "inline"
},
"transportEquipment": {
"associationType": "inline"
},
"stop": {},
"pin": "string",
"tar": "string",
"shipmentLine": {
"scacCode": "string",
"smdgCode": "string"
},
"containmentUUID": "string"
},
"description": "string"
},
"pin": "string",
"tar": "string",
"shipmentLine": {
"scacCode": "string",
"smdgCode": "string"
},
"containmentUUID": "string"
}
],
"constraints": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "accessConstraint",
"name": "string",
"enforceability": "enforced",
"description": "string"
}
],
"pricingElements": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"sequenceNr": 0,
"quantity": 0,
"name": "string",
"description": "string",
"category": {
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"creditCode": "string",
"debitCode": "string",
"defaultValue": 0.1,
"enabled": true,
"tripRevenue": true
},
"business": {}
}
],
"remark": "string",
"hash": "string",
"identifiers": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"system": "string",
"value": "string",
"expiredAt": "2019-08-24T14:15:22Z"
}
],
"externalAttributes": {
"property1": {},
"property2": {}
},
"dataIsComplete": true
}'Response
application/json
{ "success": true, "message": "string", "code": 0, "location": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "language": {}, "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { … }, "administrativeReference": { … }, "contactDetails": [ … ], "openingTimes": { … }, "terminal": { … }, "actions": [ … ], "constraints": [ … ], "pricingElements": [ … ], "remark": "string", "hash": "string", "identifiers": [ … ], "externalAttributes": { … }, "dataIsComplete": true } }
Bodyapplication/jsonrequired
Enum"warehouse""store""environmentalZone""restrictedArea""customer""parkingSpot""loadingUnloadingArea""operationalBase""fuelStation"
- Mock serverhttps://docs.transportial.com/_mock/apis/location
- Test environmenthttps://test.api.otms.transportial.com/api/location
- Productionhttps://api.otms.transportial.com/api/location
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.transportial.com/_mock/apis/location \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"nonce": "string",
"type": "warehouse",
"name": "string",
"unCode": "string",
"geoReference": {
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "addressGeoReference",
"name": "string",
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"postalCode": "string",
"city": "string",
"country": "string",
"hash": "string"
},
"administrativeReference": {
"name": "string",
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"postalCode": "string",
"city": "string",
"country": "string"
},
"contactDetails": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "iban",
"value": "string",
"remarks": "string"
}
],
"openingTimes": {
"monday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
},
"tuesday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
},
"wednesday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
},
"thursday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
},
"friday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
},
"saturday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
},
"sunday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
}
},
"terminal": {
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"integrationType": "portbase",
"ean": "string",
"bicsCode": "string",
"quayName": "string",
"smdgCode": "string",
"locations": [
{}
],
"allowedModalities": [
"string"
],
"terminalSettings": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"loading": true,
"full": true,
"modality": "string",
"sealNumberAllowed": true,
"reeferAllowed": true,
"grossWeightAllowed": true,
"outOfGaugeAllowed": true,
"dangerousGoodsAllowed": true,
"cargoCutOffInMinutes": 0
}
],
"tarRequired": true,
"roadLicenseIdRequired": true
},
"actions": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "load",
"groupId": "string",
"name": "string",
"externalAttributes": {
"property1": {},
"property2": {}
},
"identifiers": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"system": "string",
"value": "string",
"expiredAt": "2019-08-24T14:15:22Z"
}
],
"lifeCycle": "requested",
"result": {
"status": "succeeded",
"remark": "string",
"reason": "string",
"results": [
{
"property1": {},
"property2": {}
}
],
"answers": {
"property1": {},
"property2": {}
},
"attachments": [
{
"questionId": "string",
"type": "photo",
"documentId": "string",
"dataUrl": "string"
}
]
},
"remark": "string",
"sequenceNr": 0,
"tripSequenceNr": 0,
"location": {
"associationType": "inline",
"entity": {},
"description": "string"
},
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"eta": "2019-08-24T14:15:22Z",
"etd": "2019-08-24T14:15:22Z",
"timeFormat": "string",
"recurrence": "string",
"duration": 0,
"estimatedDuration": 0,
"inTripOnly": true,
"actions": [
{
"associationType": "inline",
"entity": {
"nonce": "string",
"versionNumber": 0,
"type": "load",
"name": "string",
"groupId": "string",
"externalAttributes": {
"property1": {},
"property2": {}
},
"lifeCycle": "requested",
"result": {
"status": "succeeded",
"remark": "string",
"reason": "string",
"results": [
{}
],
"answers": {
"property1": {},
"property2": {}
},
"attachments": [
null
]
},
"remark": "string",
"sequenceNr": 0,
"tripSequenceNr": 0,
"location": {
"associationType": "inline",
"entity": {},
"description": "string"
},
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"eta": "2019-08-24T14:15:22Z",
"etd": "2019-08-24T14:15:22Z",
"timeFormat": "string",
"recurrence": "string",
"duration": 0,
"estimatedDuration": 0,
"inTripOnly": true,
"actions": [
{}
],
"documents": [
{}
],
"contextEvents": [
{
"externalAttributes": {},
"identifiers": []
}
],
"attributes": [
{}
],
"timeslotBookings": [
{
"action": {},
"bookedBy": {}
}
],
"identifiers": [
{}
],
"constraints": [
{}
],
"communicationRequests": [
{
"communicationRequests": []
}
],
"consignment": {
"associationType": "inline",
"entity": {
"goods": [],
"consignment": {},
"nextAction": {},
"lastAction": {},
"lastPlannedAction": {},
"documents": [],
"actors": [],
"actions": [],
"pricingElements": [],
"externalAttributes": {},
"constraints": [],
"identifiers": [],
"attributes": []
}
},
"isContainmentAction": true,
"vehicle": {
"associationType": "inline"
},
"transportEquipment": {
"associationType": "inline"
},
"stop": {},
"pin": "string",
"tar": "string",
"shipmentLine": {
"scacCode": "string",
"smdgCode": "string"
},
"containmentUUID": "string"
},
"description": "string"
}
],
"communicationRequests": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"description": "string",
"status": "pending",
"responseMessage": "string",
"responseValue": "string"
}
],
"documents": [
{
"associationType": "inline"
}
],
"contextEvents": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "generalEvent",
"lifeCycle": "requested",
"externalAttributes": {
"property1": {},
"property2": {}
},
"identifiers": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"system": "string",
"value": "string",
"expiredAt": "2019-08-24T14:15:22Z"
}
],
"dateTime": "2019-08-24T14:15:22Z",
"vehicle": {},
"transportEquipment": {},
"stopAction": {
"trip": {
"associationType": "inline",
"entity": {},
"description": "string"
}
},
"geoReference": {
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "addressGeoReference",
"name": "string",
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"postalCode": "string",
"city": "string",
"country": "string",
"hash": "string"
}
}
],
"attributes": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"color": "string"
}
],
"versionNumber": 0,
"constraints": [
{
"associationType": "inline",
"entity": {
"nonce": "string",
"name": "string",
"enforceability": "enforced",
"type": "accessConstraint",
"description": "string"
},
"description": "string"
}
],
"consignment": {
"associationType": "inline",
"entity": {
"nonce": "string",
"versionNumber": 0,
"hasAgreedToPrice": true,
"orderType": "standard",
"name": "string",
"consignmentNr": "string",
"description": "string",
"status": "draft",
"highValueGoods": true,
"goods": [
{
"associationType": "inline"
}
],
"team": {
"nonce": "string",
"emailIntegration": {},
"vehicleGroups": [
{
"vehicles": []
}
],
"fleets": [
{
"vehicles": [],
"teams": [],
"businesses": []
}
],
"features": [
{
"accountTypes": []
}
],
"managers": [
{}
],
"name": "string",
"transportOrderPrefix": "string",
"consignmentPrefix": "string",
"users": [
{}
]
},
"consignment": {},
"currentLocation": {
"administrativeReference": {
"name": "string",
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"postalCode": "string",
"city": "string",
"country": "string"
},
"lat": 0.1,
"lon": 0.1,
"speed": {
"value": "string",
"unit": "string"
},
"heading": {
"value": "string",
"unit": "string"
},
"bearing": {
"value": "string",
"unit": "string"
},
"bearingType": "absolute"
},
"nextAction": {},
"lastAction": {},
"lastPlannedAction": {},
"isPlannedToLastLocation": true,
"documents": [
{
"associationType": "inline"
}
],
"actors": [
{
"associationType": "inline"
}
],
"actions": [
{
"associationType": "inline"
}
],
"pricingElements": [
{
"nonce": "string",
"sequenceNr": 0,
"quantity": 0,
"name": "string",
"description": "string",
"category": {
"identifiers": []
},
"business": {},
"amount": {},
"subTotal": {},
"tax": {},
"total": {}
}
],
"externalAttributes": {
"property1": {},
"property2": {}
},
"expectedRevenue": {
"amount": 0.1,
"currency": {
"nonce": "string",
"name": "string",
"short": "string",
"sign": "string",
"decimalDelimiter": "string",
"thousandDelimiter": "string",
"enabled": true
},
"taxRate": {
"nonce": "string",
"creditCode": "string",
"debitCode": "string",
"identifiers": [
null
],
"name": "string",
"description": "string",
"jurisdiction": "string",
"percentage": 0.1,
"inclusive": true,
"active": true
},
"inclusiveOfTax": true,
"moneyBuildBlocks": [
{}
]
},
"expectedCost": {
"amount": 0.1,
"currency": {
"nonce": "string",
"name": "string",
"short": "string",
"sign": "string",
"decimalDelimiter": "string",
"thousandDelimiter": "string",
"enabled": true
},
"taxRate": {
"nonce": "string",
"creditCode": "string",
"debitCode": "string",
"identifiers": [
null
],
"name": "string",
"description": "string",
"jurisdiction": "string",
"percentage": 0.1,
"inclusive": true,
"active": true
},
"inclusiveOfTax": true,
"moneyBuildBlocks": [
{}
]
},
"combined": true,
"type": "string",
"remark": "string",
"constraints": [
{
"nonce": "string",
"name": "string",
"enforceability": "enforced",
"type": "accessConstraint",
"description": "string"
}
],
"identifiers": [
{
"nonce": "string",
"name": "string",
"system": "string",
"value": "string",
"expiredAt": "2019-08-24T14:15:22Z"
}
],
"attributes": [
{
"nonce": "string",
"name": "string",
"color": "string"
}
]
}
},
"isContainmentAction": true,
"vehicle": {
"associationType": "inline"
},
"transportEquipment": {
"associationType": "inline"
},
"stop": {
"associationType": "inline",
"entity": {
"nonce": "string",
"versionNumber": 0,
"type": "load",
"name": "string",
"groupId": "string",
"externalAttributes": {
"property1": {},
"property2": {}
},
"lifeCycle": "requested",
"result": {
"status": "succeeded",
"remark": "string",
"reason": "string",
"results": [
{
"property1": {},
"property2": {}
}
],
"answers": {
"property1": {},
"property2": {}
},
"attachments": [
{}
]
},
"remark": "string",
"sequenceNr": 0,
"tripSequenceNr": 0,
"location": {
"associationType": "inline",
"entity": {},
"description": "string"
},
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"eta": "2019-08-24T14:15:22Z",
"etd": "2019-08-24T14:15:22Z",
"timeFormat": "string",
"recurrence": "string",
"duration": 0,
"estimatedDuration": 0,
"inTripOnly": true,
"actions": [
{}
],
"documents": [
{
"associationType": "inline"
}
],
"contextEvents": [
{
"nonce": "string",
"type": "generalEvent",
"lifeCycle": "requested",
"externalAttributes": {
"property1": {},
"property2": {}
},
"dateTime": "2019-08-24T14:15:22Z",
"identifiers": [
null
],
"vehicle": {
"business": {},
"pictures": [],
"loadCapacities": [],
"boardComputers": [],
"notes": [],
"sensors": [],
"fleets": [],
"chauffeurs": [],
"transportEquipments": [],
"actors": [],
"identifiers": [],
"cameras": [],
"pricingModules": [],
"axles": [],
"attributes": []
},
"transportEquipment": {
"documents": [],
"actors": [],
"actions": [],
"identifiers": [],
"requirementCodes": [],
"sensors": [],
"boardComputers": [],
"business": {},
"pricingModules": [],
"constraints": [],
"attributes": [],
"axles": []
},
"stopAction": {},
"geoReference": {}
}
],
"attributes": [
{
"nonce": "string",
"name": "string",
"color": "string"
}
],
"timeslotBookings": [
{
"nonce": "string",
"timeslot": {},
"action": {},
"consignment": {
"goods": [],
"consignment": {},
"nextAction": {},
"lastAction": {},
"lastPlannedAction": {},
"documents": [],
"actors": [],
"actions": [],
"pricingElements": [],
"externalAttributes": {},
"constraints": [],
"identifiers": [],
"attributes": []
},
"status": "REQUESTED",
"bookingDate": "2019-08-24",
"bookingStartTime": "2019-08-24T14:15:22Z",
"bookingEndTime": "2019-08-24T14:15:22Z",
"bookedBy": {},
"bookedAt": "2019-08-24T14:15:22Z",
"confirmedAt": "2019-08-24T14:15:22Z",
"cancelledAt": "2019-08-24T14:15:22Z",
"cancellationReason": "string",
"referenceNumber": "string",
"notes": "string",
"actualArrivalTime": "2019-08-24T14:15:22Z",
"actualDepartureTime": "2019-08-24T14:15:22Z"
}
],
"identifiers": [
{
"nonce": "string",
"name": "string",
"system": "string",
"value": "string",
"expiredAt": "2019-08-24T14:15:22Z"
}
],
"constraints": [
{
"associationType": "inline",
"entity": {},
"description": "string"
}
],
"communicationRequests": [
{
"nonce": "string",
"name": "string",
"description": "string",
"status": "pending",
"responseMessage": "string",
"responseValue": "string",
"communicationRequests": [
{}
]
}
],
"consignment": {
"associationType": "inline",
"entity": {
"nonce": "string",
"versionNumber": 0,
"hasAgreedToPrice": true,
"orderType": "standard",
"name": "string",
"consignmentNr": "string",
"description": "string",
"status": "draft",
"highValueGoods": true,
"goods": [
null
],
"team": {
"emailIntegration": {},
"vehicleGroups": [],
"fleets": [],
"features": [],
"managers": [],
"users": []
},
"consignment": {},
"currentLocation": {},
"nextAction": {},
"lastAction": {},
"lastPlannedAction": {},
"isPlannedToLastLocation": true,
"documents": [
null
],
"actors": [
null
],
"actions": [
null
],
"pricingElements": [
null
],
"externalAttributes": {
"property1": {},
"property2": {}
},
"expectedRevenue": {
"moneyBuildBlocks": []
},
"expectedCost": {
"moneyBuildBlocks": []
},
"combined": true,
"type": "string",
"remark": "string",
"constraints": [
null
],
"identifiers": [
null
],
"attributes": [
null
]
}
},
"isContainmentAction": true,
"vehicle": {
"associationType": "inline"
},
"transportEquipment": {
"associationType": "inline"
},
"stop": {},
"pin": "string",
"tar": "string",
"shipmentLine": {
"scacCode": "string",
"smdgCode": "string"
},
"containmentUUID": "string"
},
"description": "string"
},
"pin": "string",
"tar": "string",
"shipmentLine": {
"scacCode": "string",
"smdgCode": "string"
},
"containmentUUID": "string"
}
],
"constraints": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "accessConstraint",
"name": "string",
"enforceability": "enforced",
"description": "string"
}
],
"pricingElements": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"sequenceNr": 0,
"quantity": 0,
"name": "string",
"description": "string",
"category": {
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"creditCode": "string",
"debitCode": "string",
"defaultValue": 0.1,
"enabled": true,
"tripRevenue": true
},
"business": {}
}
],
"remark": "string",
"hash": "string",
"identifiers": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"system": "string",
"value": "string",
"expiredAt": "2019-08-24T14:15:22Z"
}
],
"externalAttributes": {
"property1": {},
"property2": {}
}
}'Response
application/json
{ "success": true, "message": "string", "code": 0, "location": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "language": {}, "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { … }, "administrativeReference": { … }, "contactDetails": [ … ], "openingTimes": { … }, "terminal": { … }, "actions": [ … ], "constraints": [ … ], "pricingElements": [ … ], "remark": "string", "hash": "string", "identifiers": [ … ], "externalAttributes": { … }, "dataIsComplete": true } }
Security
bearer or apiKey or apiSecret
- Mock serverhttps://docs.transportial.com/_mock/apis/location/{id}/action/{type}/duration{average}
- Test environmenthttps://test.api.otms.transportial.com/api/location/{id}/action/{type}/duration{average}
- Productionhttps://api.otms.transportial.com/api/location/{id}/action/{type}/duration{average}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.transportial.com/_mock/apis/location/{id}/action/{type}/duration{average}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "success": true, "message": "string", "code": 0, "duration": 0, "count": 0 }
- Mock serverhttps://docs.transportial.com/_mock/apis/location/{id}
- Test environmenthttps://test.api.otms.transportial.com/api/location/{id}
- Productionhttps://api.otms.transportial.com/api/location/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.transportial.com/_mock/apis/location/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "success": true, "message": "string", "code": 0, "location": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "language": {}, "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { … }, "administrativeReference": { … }, "contactDetails": [ … ], "openingTimes": { … }, "terminal": { … }, "actions": [ … ], "constraints": [ … ], "pricingElements": [ … ], "remark": "string", "hash": "string", "identifiers": [ … ], "externalAttributes": { … }, "dataIsComplete": true } }
- Mock serverhttps://docs.transportial.com/_mock/apis/location/{id}
- Test environmenthttps://test.api.otms.transportial.com/api/location/{id}
- Productionhttps://api.otms.transportial.com/api/location/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.transportial.com/_mock/apis/location/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "success": true, "message": "string", "code": 0, "location": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "language": {}, "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { … }, "administrativeReference": { … }, "contactDetails": [ … ], "openingTimes": { … }, "terminal": { … }, "actions": [ … ], "constraints": [ … ], "pricingElements": [ … ], "remark": "string", "hash": "string", "identifiers": [ … ], "externalAttributes": { … }, "dataIsComplete": true } }
Security
bearer or apiKey or apiSecret
- Mock serverhttps://docs.transportial.com/_mock/apis/location/{id}/actions/{offset}/{amount}
- Test environmenthttps://test.api.otms.transportial.com/api/location/{id}/actions/{offset}/{amount}
- Productionhttps://api.otms.transportial.com/api/location/{id}/actions/{offset}/{amount}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.transportial.com/_mock/apis/location/{id}/actions/{offset}/{amount}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Response
application/json
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "actions": [ { … } ] }
Security
bearer or apiKey or apiSecret
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.
Enum"warehouse""store""environmentalZone""restrictedArea""customer""parkingSpot""loadingUnloadingArea""operationalBase""fuelStation"
- Mock serverhttps://docs.transportial.com/_mock/apis/location/duplicates
- Test environmenthttps://test.api.otms.transportial.com/api/location/duplicates
- Productionhttps://api.otms.transportial.com/api/location/duplicates
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.transportial.com/_mock/apis/location/duplicates \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "warehouse",
"name": "string",
"unCode": "string",
"geoReference": {
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "addressGeoReference",
"name": "string",
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"postalCode": "string",
"city": "string",
"country": "string",
"hash": "string"
},
"administrativeReference": {
"name": "string",
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"postalCode": "string",
"city": "string",
"country": "string"
},
"contactDetails": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "iban",
"value": "string",
"remarks": "string"
}
],
"openingTimes": {
"monday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
},
"tuesday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
},
"wednesday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
},
"thursday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
},
"friday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
},
"saturday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
},
"sunday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
}
},
"terminal": {
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"integrationType": "portbase",
"ean": "string",
"bicsCode": "string",
"quayName": "string",
"smdgCode": "string",
"locations": [
{}
],
"allowedModalities": [
"string"
],
"terminalSettings": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"loading": true,
"full": true,
"modality": "string",
"sealNumberAllowed": true,
"reeferAllowed": true,
"grossWeightAllowed": true,
"outOfGaugeAllowed": true,
"dangerousGoodsAllowed": true,
"cargoCutOffInMinutes": 0
}
],
"tarRequired": true,
"roadLicenseIdRequired": true
},
"actions": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "load",
"groupId": "string",
"name": "string",
"externalAttributes": {
"property1": {},
"property2": {}
},
"identifiers": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"system": "string",
"value": "string",
"expiredAt": "2019-08-24T14:15:22Z"
}
],
"lifeCycle": "requested",
"result": {
"status": "succeeded",
"remark": "string",
"reason": "string",
"results": [
{
"property1": {},
"property2": {}
}
],
"answers": {
"property1": {},
"property2": {}
},
"attachments": [
{
"questionId": "string",
"type": "photo",
"documentId": "string",
"dataUrl": "string"
}
]
},
"remark": "string",
"sequenceNr": 0,
"tripSequenceNr": 0,
"location": {
"associationType": "inline",
"entity": {},
"description": "string"
},
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"eta": "2019-08-24T14:15:22Z",
"etd": "2019-08-24T14:15:22Z",
"timeFormat": "string",
"recurrence": "string",
"duration": 0,
"estimatedDuration": 0,
"inTripOnly": true,
"actions": [
{
"associationType": "inline",
"entity": {
"nonce": "string",
"versionNumber": 0,
"type": "load",
"name": "string",
"groupId": "string",
"externalAttributes": {
"property1": {},
"property2": {}
},
"lifeCycle": "requested",
"result": {
"status": "succeeded",
"remark": "string",
"reason": "string",
"results": [
{}
],
"answers": {
"property1": {},
"property2": {}
},
"attachments": [
null
]
},
"remark": "string",
"sequenceNr": 0,
"tripSequenceNr": 0,
"location": {
"associationType": "inline",
"entity": {},
"description": "string"
},
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"eta": "2019-08-24T14:15:22Z",
"etd": "2019-08-24T14:15:22Z",
"timeFormat": "string",
"recurrence": "string",
"duration": 0,
"estimatedDuration": 0,
"inTripOnly": true,
"actions": [
{}
],
"documents": [
{}
],
"contextEvents": [
{
"externalAttributes": {},
"identifiers": []
}
],
"attributes": [
{}
],
"timeslotBookings": [
{
"action": {},
"bookedBy": {}
}
],
"identifiers": [
{}
],
"constraints": [
{}
],
"communicationRequests": [
{
"communicationRequests": []
}
],
"consignment": {
"associationType": "inline",
"entity": {
"goods": [],
"consignment": {},
"nextAction": {},
"lastAction": {},
"lastPlannedAction": {},
"documents": [],
"actors": [],
"actions": [],
"pricingElements": [],
"externalAttributes": {},
"constraints": [],
"identifiers": [],
"attributes": []
}
},
"isContainmentAction": true,
"vehicle": {
"associationType": "inline"
},
"transportEquipment": {
"associationType": "inline"
},
"stop": {},
"pin": "string",
"tar": "string",
"shipmentLine": {
"scacCode": "string",
"smdgCode": "string"
},
"containmentUUID": "string"
},
"description": "string"
}
],
"communicationRequests": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"description": "string",
"status": "pending",
"responseMessage": "string",
"responseValue": "string"
}
],
"documents": [
{
"associationType": "inline"
}
],
"contextEvents": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "generalEvent",
"lifeCycle": "requested",
"externalAttributes": {
"property1": {},
"property2": {}
},
"identifiers": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"system": "string",
"value": "string",
"expiredAt": "2019-08-24T14:15:22Z"
}
],
"dateTime": "2019-08-24T14:15:22Z",
"vehicle": {},
"transportEquipment": {},
"stopAction": {
"trip": {
"associationType": "inline",
"entity": {},
"description": "string"
}
},
"geoReference": {
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "addressGeoReference",
"name": "string",
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"postalCode": "string",
"city": "string",
"country": "string",
"hash": "string"
}
}
],
"attributes": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"color": "string"
}
],
"versionNumber": 0,
"constraints": [
{
"associationType": "inline",
"entity": {
"nonce": "string",
"name": "string",
"enforceability": "enforced",
"type": "accessConstraint",
"description": "string"
},
"description": "string"
}
],
"consignment": {
"associationType": "inline",
"entity": {
"nonce": "string",
"versionNumber": 0,
"hasAgreedToPrice": true,
"orderType": "standard",
"name": "string",
"consignmentNr": "string",
"description": "string",
"status": "draft",
"highValueGoods": true,
"goods": [
{
"associationType": "inline"
}
],
"team": {
"nonce": "string",
"emailIntegration": {},
"vehicleGroups": [
{
"vehicles": []
}
],
"fleets": [
{
"vehicles": [],
"teams": [],
"businesses": []
}
],
"features": [
{
"accountTypes": []
}
],
"managers": [
{}
],
"name": "string",
"transportOrderPrefix": "string",
"consignmentPrefix": "string",
"users": [
{}
]
},
"consignment": {},
"currentLocation": {
"administrativeReference": {
"name": "string",
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"postalCode": "string",
"city": "string",
"country": "string"
},
"lat": 0.1,
"lon": 0.1,
"speed": {
"value": "string",
"unit": "string"
},
"heading": {
"value": "string",
"unit": "string"
},
"bearing": {
"value": "string",
"unit": "string"
},
"bearingType": "absolute"
},
"nextAction": {},
"lastAction": {},
"lastPlannedAction": {},
"isPlannedToLastLocation": true,
"documents": [
{
"associationType": "inline"
}
],
"actors": [
{
"associationType": "inline"
}
],
"actions": [
{
"associationType": "inline"
}
],
"pricingElements": [
{
"nonce": "string",
"sequenceNr": 0,
"quantity": 0,
"name": "string",
"description": "string",
"category": {
"identifiers": []
},
"business": {},
"amount": {},
"subTotal": {},
"tax": {},
"total": {}
}
],
"externalAttributes": {
"property1": {},
"property2": {}
},
"expectedRevenue": {
"amount": 0.1,
"currency": {
"nonce": "string",
"name": "string",
"short": "string",
"sign": "string",
"decimalDelimiter": "string",
"thousandDelimiter": "string",
"enabled": true
},
"taxRate": {
"nonce": "string",
"creditCode": "string",
"debitCode": "string",
"identifiers": [
null
],
"name": "string",
"description": "string",
"jurisdiction": "string",
"percentage": 0.1,
"inclusive": true,
"active": true
},
"inclusiveOfTax": true,
"moneyBuildBlocks": [
{}
]
},
"expectedCost": {
"amount": 0.1,
"currency": {
"nonce": "string",
"name": "string",
"short": "string",
"sign": "string",
"decimalDelimiter": "string",
"thousandDelimiter": "string",
"enabled": true
},
"taxRate": {
"nonce": "string",
"creditCode": "string",
"debitCode": "string",
"identifiers": [
null
],
"name": "string",
"description": "string",
"jurisdiction": "string",
"percentage": 0.1,
"inclusive": true,
"active": true
},
"inclusiveOfTax": true,
"moneyBuildBlocks": [
{}
]
},
"combined": true,
"type": "string",
"remark": "string",
"constraints": [
{
"nonce": "string",
"name": "string",
"enforceability": "enforced",
"type": "accessConstraint",
"description": "string"
}
],
"identifiers": [
{
"nonce": "string",
"name": "string",
"system": "string",
"value": "string",
"expiredAt": "2019-08-24T14:15:22Z"
}
],
"attributes": [
{
"nonce": "string",
"name": "string",
"color": "string"
}
]
}
},
"isContainmentAction": true,
"vehicle": {
"associationType": "inline"
},
"transportEquipment": {
"associationType": "inline"
},
"stop": {
"associationType": "inline",
"entity": {
"nonce": "string",
"versionNumber": 0,
"type": "load",
"name": "string",
"groupId": "string",
"externalAttributes": {
"property1": {},
"property2": {}
},
"lifeCycle": "requested",
"result": {
"status": "succeeded",
"remark": "string",
"reason": "string",
"results": [
{
"property1": {},
"property2": {}
}
],
"answers": {
"property1": {},
"property2": {}
},
"attachments": [
{}
]
},
"remark": "string",
"sequenceNr": 0,
"tripSequenceNr": 0,
"location": {
"associationType": "inline",
"entity": {},
"description": "string"
},
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"eta": "2019-08-24T14:15:22Z",
"etd": "2019-08-24T14:15:22Z",
"timeFormat": "string",
"recurrence": "string",
"duration": 0,
"estimatedDuration": 0,
"inTripOnly": true,
"actions": [
{}
],
"documents": [
{
"associationType": "inline"
}
],
"contextEvents": [
{
"nonce": "string",
"type": "generalEvent",
"lifeCycle": "requested",
"externalAttributes": {
"property1": {},
"property2": {}
},
"dateTime": "2019-08-24T14:15:22Z",
"identifiers": [
null
],
"vehicle": {
"business": {},
"pictures": [],
"loadCapacities": [],
"boardComputers": [],
"notes": [],
"sensors": [],
"fleets": [],
"chauffeurs": [],
"transportEquipments": [],
"actors": [],
"identifiers": [],
"cameras": [],
"pricingModules": [],
"axles": [],
"attributes": []
},
"transportEquipment": {
"documents": [],
"actors": [],
"actions": [],
"identifiers": [],
"requirementCodes": [],
"sensors": [],
"boardComputers": [],
"business": {},
"pricingModules": [],
"constraints": [],
"attributes": [],
"axles": []
},
"stopAction": {},
"geoReference": {}
}
],
"attributes": [
{
"nonce": "string",
"name": "string",
"color": "string"
}
],
"timeslotBookings": [
{
"nonce": "string",
"timeslot": {},
"action": {},
"consignment": {
"goods": [],
"consignment": {},
"nextAction": {},
"lastAction": {},
"lastPlannedAction": {},
"documents": [],
"actors": [],
"actions": [],
"pricingElements": [],
"externalAttributes": {},
"constraints": [],
"identifiers": [],
"attributes": []
},
"status": "REQUESTED",
"bookingDate": "2019-08-24",
"bookingStartTime": "2019-08-24T14:15:22Z",
"bookingEndTime": "2019-08-24T14:15:22Z",
"bookedBy": {},
"bookedAt": "2019-08-24T14:15:22Z",
"confirmedAt": "2019-08-24T14:15:22Z",
"cancelledAt": "2019-08-24T14:15:22Z",
"cancellationReason": "string",
"referenceNumber": "string",
"notes": "string",
"actualArrivalTime": "2019-08-24T14:15:22Z",
"actualDepartureTime": "2019-08-24T14:15:22Z"
}
],
"identifiers": [
{
"nonce": "string",
"name": "string",
"system": "string",
"value": "string",
"expiredAt": "2019-08-24T14:15:22Z"
}
],
"constraints": [
{
"associationType": "inline",
"entity": {},
"description": "string"
}
],
"communicationRequests": [
{
"nonce": "string",
"name": "string",
"description": "string",
"status": "pending",
"responseMessage": "string",
"responseValue": "string",
"communicationRequests": [
{}
]
}
],
"consignment": {
"associationType": "inline",
"entity": {
"nonce": "string",
"versionNumber": 0,
"hasAgreedToPrice": true,
"orderType": "standard",
"name": "string",
"consignmentNr": "string",
"description": "string",
"status": "draft",
"highValueGoods": true,
"goods": [
null
],
"team": {
"emailIntegration": {},
"vehicleGroups": [],
"fleets": [],
"features": [],
"managers": [],
"users": []
},
"consignment": {},
"currentLocation": {},
"nextAction": {},
"lastAction": {},
"lastPlannedAction": {},
"isPlannedToLastLocation": true,
"documents": [
null
],
"actors": [
null
],
"actions": [
null
],
"pricingElements": [
null
],
"externalAttributes": {
"property1": {},
"property2": {}
},
"expectedRevenue": {
"moneyBuildBlocks": []
},
"expectedCost": {
"moneyBuildBlocks": []
},
"combined": true,
"type": "string",
"remark": "string",
"constraints": [
null
],
"identifiers": [
null
],
"attributes": [
null
]
}
},
"isContainmentAction": true,
"vehicle": {
"associationType": "inline"
},
"transportEquipment": {
"associationType": "inline"
},
"stop": {},
"pin": "string",
"tar": "string",
"shipmentLine": {
"scacCode": "string",
"smdgCode": "string"
},
"containmentUUID": "string"
},
"description": "string"
},
"pin": "string",
"tar": "string",
"shipmentLine": {
"scacCode": "string",
"smdgCode": "string"
},
"containmentUUID": "string"
}
],
"constraints": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "accessConstraint",
"name": "string",
"enforceability": "enforced",
"description": "string"
}
],
"pricingElements": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"sequenceNr": 0,
"quantity": 0,
"name": "string",
"description": "string",
"category": {
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"creditCode": "string",
"debitCode": "string",
"defaultValue": 0.1,
"enabled": true,
"tripRevenue": true
},
"business": {}
}
],
"remark": "string",
"hash": "string",
"identifiers": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"system": "string",
"value": "string",
"expiredAt": "2019-08-24T14:15:22Z"
}
],
"externalAttributes": {
"property1": {},
"property2": {}
},
"dataIsComplete": true
}'Response
application/json
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "locations": [ { … } ] }
Security
bearer or apiKey or apiSecret
Enum"warehouse""store""environmentalZone""restrictedArea""customer""parkingSpot""loadingUnloadingArea""operationalBase""fuelStation"
- Mock serverhttps://docs.transportial.com/_mock/apis/location/geocode/addressGeoReference
- Test environmenthttps://test.api.otms.transportial.com/api/location/geocode/addressGeoReference
- Productionhttps://api.otms.transportial.com/api/location/geocode/addressGeoReference
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.transportial.com/_mock/apis/location/geocode/addressGeoReference \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"nonce": "string",
"type": "warehouse",
"name": "string",
"unCode": "string",
"geoReference": {
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "addressGeoReference",
"name": "string",
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"postalCode": "string",
"city": "string",
"country": "string",
"hash": "string"
},
"administrativeReference": {
"name": "string",
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"postalCode": "string",
"city": "string",
"country": "string"
},
"contactDetails": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "iban",
"value": "string",
"remarks": "string"
}
],
"openingTimes": {
"monday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
},
"tuesday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
},
"wednesday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
},
"thursday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
},
"friday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
},
"saturday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
},
"sunday": {
"start": "string",
"end": "string",
"open": true,
"day": "2019-08-24",
"name": "string",
"description": "string"
}
},
"terminal": {
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"integrationType": "portbase",
"ean": "string",
"bicsCode": "string",
"quayName": "string",
"smdgCode": "string",
"locations": [
{}
],
"allowedModalities": [
"string"
],
"terminalSettings": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"loading": true,
"full": true,
"modality": "string",
"sealNumberAllowed": true,
"reeferAllowed": true,
"grossWeightAllowed": true,
"outOfGaugeAllowed": true,
"dangerousGoodsAllowed": true,
"cargoCutOffInMinutes": 0
}
],
"tarRequired": true,
"roadLicenseIdRequired": true
},
"actions": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "load",
"groupId": "string",
"name": "string",
"externalAttributes": {
"property1": {},
"property2": {}
},
"identifiers": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"system": "string",
"value": "string",
"expiredAt": "2019-08-24T14:15:22Z"
}
],
"lifeCycle": "requested",
"result": {
"status": "succeeded",
"remark": "string",
"reason": "string",
"results": [
{
"property1": {},
"property2": {}
}
],
"answers": {
"property1": {},
"property2": {}
},
"attachments": [
{
"questionId": "string",
"type": "photo",
"documentId": "string",
"dataUrl": "string"
}
]
},
"remark": "string",
"sequenceNr": 0,
"tripSequenceNr": 0,
"location": {
"associationType": "inline",
"entity": {},
"description": "string"
},
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"eta": "2019-08-24T14:15:22Z",
"etd": "2019-08-24T14:15:22Z",
"timeFormat": "string",
"recurrence": "string",
"duration": 0,
"estimatedDuration": 0,
"inTripOnly": true,
"actions": [
{
"associationType": "inline",
"entity": {
"nonce": "string",
"versionNumber": 0,
"type": "load",
"name": "string",
"groupId": "string",
"externalAttributes": {
"property1": {},
"property2": {}
},
"lifeCycle": "requested",
"result": {
"status": "succeeded",
"remark": "string",
"reason": "string",
"results": [
{}
],
"answers": {
"property1": {},
"property2": {}
},
"attachments": [
null
]
},
"remark": "string",
"sequenceNr": 0,
"tripSequenceNr": 0,
"location": {
"associationType": "inline",
"entity": {},
"description": "string"
},
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"eta": "2019-08-24T14:15:22Z",
"etd": "2019-08-24T14:15:22Z",
"timeFormat": "string",
"recurrence": "string",
"duration": 0,
"estimatedDuration": 0,
"inTripOnly": true,
"actions": [
{}
],
"documents": [
{}
],
"contextEvents": [
{
"externalAttributes": {},
"identifiers": []
}
],
"attributes": [
{}
],
"timeslotBookings": [
{
"action": {},
"bookedBy": {}
}
],
"identifiers": [
{}
],
"constraints": [
{}
],
"communicationRequests": [
{
"communicationRequests": []
}
],
"consignment": {
"associationType": "inline",
"entity": {
"goods": [],
"consignment": {},
"nextAction": {},
"lastAction": {},
"lastPlannedAction": {},
"documents": [],
"actors": [],
"actions": [],
"pricingElements": [],
"externalAttributes": {},
"constraints": [],
"identifiers": [],
"attributes": []
}
},
"isContainmentAction": true,
"vehicle": {
"associationType": "inline"
},
"transportEquipment": {
"associationType": "inline"
},
"stop": {},
"pin": "string",
"tar": "string",
"shipmentLine": {
"scacCode": "string",
"smdgCode": "string"
},
"containmentUUID": "string"
},
"description": "string"
}
],
"communicationRequests": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"description": "string",
"status": "pending",
"responseMessage": "string",
"responseValue": "string"
}
],
"documents": [
{
"associationType": "inline"
}
],
"contextEvents": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "generalEvent",
"lifeCycle": "requested",
"externalAttributes": {
"property1": {},
"property2": {}
},
"identifiers": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"system": "string",
"value": "string",
"expiredAt": "2019-08-24T14:15:22Z"
}
],
"dateTime": "2019-08-24T14:15:22Z",
"vehicle": {},
"transportEquipment": {},
"stopAction": {
"trip": {
"associationType": "inline",
"entity": {},
"description": "string"
}
},
"geoReference": {
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "addressGeoReference",
"name": "string",
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"postalCode": "string",
"city": "string",
"country": "string",
"hash": "string"
}
}
],
"attributes": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"color": "string"
}
],
"versionNumber": 0,
"constraints": [
{
"associationType": "inline",
"entity": {
"nonce": "string",
"name": "string",
"enforceability": "enforced",
"type": "accessConstraint",
"description": "string"
},
"description": "string"
}
],
"consignment": {
"associationType": "inline",
"entity": {
"nonce": "string",
"versionNumber": 0,
"hasAgreedToPrice": true,
"orderType": "standard",
"name": "string",
"consignmentNr": "string",
"description": "string",
"status": "draft",
"highValueGoods": true,
"goods": [
{
"associationType": "inline"
}
],
"team": {
"nonce": "string",
"emailIntegration": {},
"vehicleGroups": [
{
"vehicles": []
}
],
"fleets": [
{
"vehicles": [],
"teams": [],
"businesses": []
}
],
"features": [
{
"accountTypes": []
}
],
"managers": [
{}
],
"name": "string",
"transportOrderPrefix": "string",
"consignmentPrefix": "string",
"users": [
{}
]
},
"consignment": {},
"currentLocation": {
"administrativeReference": {
"name": "string",
"street": "string",
"houseNumber": "string",
"houseNumberAddition": "string",
"postalCode": "string",
"city": "string",
"country": "string"
},
"lat": 0.1,
"lon": 0.1,
"speed": {
"value": "string",
"unit": "string"
},
"heading": {
"value": "string",
"unit": "string"
},
"bearing": {
"value": "string",
"unit": "string"
},
"bearingType": "absolute"
},
"nextAction": {},
"lastAction": {},
"lastPlannedAction": {},
"isPlannedToLastLocation": true,
"documents": [
{
"associationType": "inline"
}
],
"actors": [
{
"associationType": "inline"
}
],
"actions": [
{
"associationType": "inline"
}
],
"pricingElements": [
{
"nonce": "string",
"sequenceNr": 0,
"quantity": 0,
"name": "string",
"description": "string",
"category": {
"identifiers": []
},
"business": {},
"amount": {},
"subTotal": {},
"tax": {},
"total": {}
}
],
"externalAttributes": {
"property1": {},
"property2": {}
},
"expectedRevenue": {
"amount": 0.1,
"currency": {
"nonce": "string",
"name": "string",
"short": "string",
"sign": "string",
"decimalDelimiter": "string",
"thousandDelimiter": "string",
"enabled": true
},
"taxRate": {
"nonce": "string",
"creditCode": "string",
"debitCode": "string",
"identifiers": [
null
],
"name": "string",
"description": "string",
"jurisdiction": "string",
"percentage": 0.1,
"inclusive": true,
"active": true
},
"inclusiveOfTax": true,
"moneyBuildBlocks": [
{}
]
},
"expectedCost": {
"amount": 0.1,
"currency": {
"nonce": "string",
"name": "string",
"short": "string",
"sign": "string",
"decimalDelimiter": "string",
"thousandDelimiter": "string",
"enabled": true
},
"taxRate": {
"nonce": "string",
"creditCode": "string",
"debitCode": "string",
"identifiers": [
null
],
"name": "string",
"description": "string",
"jurisdiction": "string",
"percentage": 0.1,
"inclusive": true,
"active": true
},
"inclusiveOfTax": true,
"moneyBuildBlocks": [
{}
]
},
"combined": true,
"type": "string",
"remark": "string",
"constraints": [
{
"nonce": "string",
"name": "string",
"enforceability": "enforced",
"type": "accessConstraint",
"description": "string"
}
],
"identifiers": [
{
"nonce": "string",
"name": "string",
"system": "string",
"value": "string",
"expiredAt": "2019-08-24T14:15:22Z"
}
],
"attributes": [
{
"nonce": "string",
"name": "string",
"color": "string"
}
]
}
},
"isContainmentAction": true,
"vehicle": {
"associationType": "inline"
},
"transportEquipment": {
"associationType": "inline"
},
"stop": {
"associationType": "inline",
"entity": {
"nonce": "string",
"versionNumber": 0,
"type": "load",
"name": "string",
"groupId": "string",
"externalAttributes": {
"property1": {},
"property2": {}
},
"lifeCycle": "requested",
"result": {
"status": "succeeded",
"remark": "string",
"reason": "string",
"results": [
{
"property1": {},
"property2": {}
}
],
"answers": {
"property1": {},
"property2": {}
},
"attachments": [
{}
]
},
"remark": "string",
"sequenceNr": 0,
"tripSequenceNr": 0,
"location": {
"associationType": "inline",
"entity": {},
"description": "string"
},
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"eta": "2019-08-24T14:15:22Z",
"etd": "2019-08-24T14:15:22Z",
"timeFormat": "string",
"recurrence": "string",
"duration": 0,
"estimatedDuration": 0,
"inTripOnly": true,
"actions": [
{}
],
"documents": [
{
"associationType": "inline"
}
],
"contextEvents": [
{
"nonce": "string",
"type": "generalEvent",
"lifeCycle": "requested",
"externalAttributes": {
"property1": {},
"property2": {}
},
"dateTime": "2019-08-24T14:15:22Z",
"identifiers": [
null
],
"vehicle": {
"business": {},
"pictures": [],
"loadCapacities": [],
"boardComputers": [],
"notes": [],
"sensors": [],
"fleets": [],
"chauffeurs": [],
"transportEquipments": [],
"actors": [],
"identifiers": [],
"cameras": [],
"pricingModules": [],
"axles": [],
"attributes": []
},
"transportEquipment": {
"documents": [],
"actors": [],
"actions": [],
"identifiers": [],
"requirementCodes": [],
"sensors": [],
"boardComputers": [],
"business": {},
"pricingModules": [],
"constraints": [],
"attributes": [],
"axles": []
},
"stopAction": {},
"geoReference": {}
}
],
"attributes": [
{
"nonce": "string",
"name": "string",
"color": "string"
}
],
"timeslotBookings": [
{
"nonce": "string",
"timeslot": {},
"action": {},
"consignment": {
"goods": [],
"consignment": {},
"nextAction": {},
"lastAction": {},
"lastPlannedAction": {},
"documents": [],
"actors": [],
"actions": [],
"pricingElements": [],
"externalAttributes": {},
"constraints": [],
"identifiers": [],
"attributes": []
},
"status": "REQUESTED",
"bookingDate": "2019-08-24",
"bookingStartTime": "2019-08-24T14:15:22Z",
"bookingEndTime": "2019-08-24T14:15:22Z",
"bookedBy": {},
"bookedAt": "2019-08-24T14:15:22Z",
"confirmedAt": "2019-08-24T14:15:22Z",
"cancelledAt": "2019-08-24T14:15:22Z",
"cancellationReason": "string",
"referenceNumber": "string",
"notes": "string",
"actualArrivalTime": "2019-08-24T14:15:22Z",
"actualDepartureTime": "2019-08-24T14:15:22Z"
}
],
"identifiers": [
{
"nonce": "string",
"name": "string",
"system": "string",
"value": "string",
"expiredAt": "2019-08-24T14:15:22Z"
}
],
"constraints": [
{
"associationType": "inline",
"entity": {},
"description": "string"
}
],
"communicationRequests": [
{
"nonce": "string",
"name": "string",
"description": "string",
"status": "pending",
"responseMessage": "string",
"responseValue": "string",
"communicationRequests": [
{}
]
}
],
"consignment": {
"associationType": "inline",
"entity": {
"nonce": "string",
"versionNumber": 0,
"hasAgreedToPrice": true,
"orderType": "standard",
"name": "string",
"consignmentNr": "string",
"description": "string",
"status": "draft",
"highValueGoods": true,
"goods": [
null
],
"team": {
"emailIntegration": {},
"vehicleGroups": [],
"fleets": [],
"features": [],
"managers": [],
"users": []
},
"consignment": {},
"currentLocation": {},
"nextAction": {},
"lastAction": {},
"lastPlannedAction": {},
"isPlannedToLastLocation": true,
"documents": [
null
],
"actors": [
null
],
"actions": [
null
],
"pricingElements": [
null
],
"externalAttributes": {
"property1": {},
"property2": {}
},
"expectedRevenue": {
"moneyBuildBlocks": []
},
"expectedCost": {
"moneyBuildBlocks": []
},
"combined": true,
"type": "string",
"remark": "string",
"constraints": [
null
],
"identifiers": [
null
],
"attributes": [
null
]
}
},
"isContainmentAction": true,
"vehicle": {
"associationType": "inline"
},
"transportEquipment": {
"associationType": "inline"
},
"stop": {},
"pin": "string",
"tar": "string",
"shipmentLine": {
"scacCode": "string",
"smdgCode": "string"
},
"containmentUUID": "string"
},
"description": "string"
},
"pin": "string",
"tar": "string",
"shipmentLine": {
"scacCode": "string",
"smdgCode": "string"
},
"containmentUUID": "string"
}
],
"constraints": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"type": "accessConstraint",
"name": "string",
"enforceability": "enforced",
"description": "string"
}
],
"pricingElements": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"sequenceNr": 0,
"quantity": 0,
"name": "string",
"description": "string",
"category": {
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"creditCode": "string",
"debitCode": "string",
"defaultValue": 0.1,
"enabled": true,
"tripRevenue": true
},
"business": {}
}
],
"remark": "string",
"hash": "string",
"identifiers": [
{
"nonce": "string",
"uuid": "string",
"primaryPlatformId": "string",
"language": {},
"name": "string",
"system": "string",
"value": "string",
"expiredAt": "2019-08-24T14:15:22Z"
}
],
"externalAttributes": {
"property1": {},
"property2": {}
}
}'Response
application/json
{ "success": true, "message": "string", "code": 0, "latLonPointGeoReference": { "administrativeReference": { … }, "lat": 0.1, "lon": 0.1, "speed": { … }, "heading": { … }, "bearing": { … }, "bearingType": "absolute" } }
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