Our full API documentation can be found here for OTMS. It describes our endpoints and the way we accept data.
URL http://transportial.com
Transportial info@transportial.com
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.
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.
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.
curl -i -X PUT \ https://docs.transportial.com/_mock/apis/vehicle \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "nonce": "string", "versionNumber": 0, "hasAgreedToPrice": true, "transportMode": "maritime", "loadCapacities": [ { "value": "string", "unit": "string" } ], "loadMeters": { "value": "string", "unit": "string" }, "actors": [ { "associationType": "inline" } ], "legalStatistics": { "lastInstantOfAVehicleOwnerLocation": "2019-08-24T14:15:22Z", "countryCabotageStatistics": { "property1": { "completedCabotageTrips": 0, "lastInstantOfCompletedCabotageTrip": "2019-08-24T14:15:22Z", "lastInstantOfInternationalTripWithCountryAsDestination": "2019-08-24T14:15:22Z" }, "property2": { "completedCabotageTrips": 0, "lastInstantOfCompletedCabotageTrip": "2019-08-24T14:15:22Z", "lastInstantOfInternationalTripWithCountryAsDestination": "2019-08-24T14:15:22Z" } }, "lastInstantOfInternationalTrip": "2019-08-24T14:15:22Z", "lastInternationalTripDestinationCountry": "string" }, "capacityContract": { "nonce": "string", "name": "string", "type": "permanentContract", "communicationMethod": "messageAutomation", "contract": { "nonce": "string", "title": "string", "description": "string", "deliveryTerms": "EXW", "contractor": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "relationType": "string", "alias": "string", "description": "string", "transportLicenseNumber": "string", "eori": "string", "scacCode": "string", "industry": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "abbreviated": "string", "enabled": true }, "website": "string", "coc": "string", "vat": "string", "verified": true, "documents": [ { "associationType": "inline", "entity": { "nonce": "string", "description": "string", "expiresAt": "2019-08-24T14:15:22Z", "fileName": "string", "mimeType": "string", "encoding": "string", "verified": true, "content": {}, "file": {}, "externalAttributes": { "property1": {}, "property2": {} }, "name": "string" } } ], "logo": { "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" }, "banners": [ { "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" } ], "locations": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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": [ {} ], "constraints": [ {} ], "pricingElements": [ {} ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } } ], "identification": [ { "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" } ], "contactDetails": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "contactPersons": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "administration": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "primary": true, "business": {}, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "balance": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0.1, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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 }, "numberFormat": "string", "numberLength": 0, "dueDays": 0, "invoiceNumberIndex": { "property1": 0, "property2": 0 }, "quoteNumberIndex": { "property1": 0, "property2": 0 }, "automaticallySendReminders": true, "invoiceTermsAndConditions": "string", "quoteTermsAndConditions": "string", "invoiceNumbering": 0, "quoteNumbering": 0 }, "pricingConfigurationCount": 0, "hasAgreedToPrice": true }, "contractorSignee": { "nonce": "string", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" }, "client": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "relationType": "string", "alias": "string", "description": "string", "transportLicenseNumber": "string", "eori": "string", "scacCode": "string", "industry": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "abbreviated": "string", "enabled": true }, "website": "string", "coc": "string", "vat": "string", "verified": true, "documents": [ { "associationType": "inline", "entity": { "nonce": "string", "description": "string", "expiresAt": "2019-08-24T14:15:22Z", "fileName": "string", "mimeType": "string", "encoding": "string", "verified": true, "content": {}, "file": {}, "externalAttributes": { "property1": {}, "property2": {} }, "name": "string" } } ], "logo": { "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" }, "banners": [ { "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" } ], "locations": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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": [ {} ], "constraints": [ {} ], "pricingElements": [ {} ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } } ], "identification": [ { "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" } ], "contactDetails": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "contactPersons": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "administration": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "primary": true, "business": {}, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "balance": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0.1, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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 }, "numberFormat": "string", "numberLength": 0, "dueDays": 0, "invoiceNumberIndex": { "property1": 0, "property2": 0 }, "quoteNumberIndex": { "property1": 0, "property2": 0 }, "automaticallySendReminders": true, "invoiceTermsAndConditions": "string", "quoteTermsAndConditions": "string", "invoiceNumbering": 0, "quoteNumbering": 0 }, "pricingConfigurationCount": 0, "hasAgreedToPrice": true }, "clientSignee": { "nonce": "string", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } }, "business": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "relationType": "string", "alias": "string", "description": "string", "transportLicenseNumber": "string", "eori": "string", "scacCode": "string", "industry": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "abbreviated": "string", "enabled": true }, "website": "string", "coc": "string", "vat": "string", "verified": true, "documents": [ { "associationType": "inline", "entity": { "nonce": "string", "description": "string", "expiresAt": "2019-08-24T14:15:22Z", "fileName": "string", "mimeType": "string", "encoding": "string", "verified": true, "content": { "contentType": "data", "data": "string" }, "file": { "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" }, "externalAttributes": { "property1": {}, "property2": {} }, "name": "string" } } ], "logo": { "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" }, "banners": [ { "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" } ], "locations": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "constraints": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "accessConstraint", "name": "string", "enforceability": "enforced", "description": "string" } ], "pricingElements": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "category": {}, "amount": {} } ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } } ], "identification": [ { "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" } ], "contactDetails": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "contactPersons": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "administration": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "primary": true, "business": {}, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "balance": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0.1, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "taxRate": { "nonce": "string", "creditCode": "string", "debitCode": "string", "identifiers": [ {} ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true }, "numberFormat": "string", "numberLength": 0, "dueDays": 0, "invoiceNumberIndex": { "property1": 0, "property2": 0 }, "quoteNumberIndex": { "property1": 0, "property2": 0 }, "automaticallySendReminders": true, "invoiceTermsAndConditions": "string", "quoteTermsAndConditions": "string", "invoiceNumbering": 0, "quoteNumbering": 0 }, "pricingConfigurationCount": 0, "hasAgreedToPrice": true }, "administration": { "nonce": "string", "name": "string", "primary": true, "business": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "relationType": "string", "alias": "string", "description": "string", "transportLicenseNumber": "string", "eori": "string", "scacCode": "string", "industry": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "abbreviated": "string", "enabled": true }, "website": "string", "coc": "string", "vat": "string", "verified": true, "documents": [ { "associationType": "inline", "entity": { "nonce": "string", "description": "string", "expiresAt": "2019-08-24T14:15:22Z", "fileName": "string", "mimeType": "string", "encoding": "string", "verified": true, "content": {}, "file": {}, "externalAttributes": { "property1": {}, "property2": {} }, "name": "string" } } ], "logo": { "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" }, "banners": [ { "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" } ], "locations": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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": [ {} ], "constraints": [ {} ], "pricingElements": [ {} ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } } ], "identification": [ { "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" } ], "contactDetails": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "contactPersons": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "administration": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "primary": true, "business": {}, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "balance": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0.1, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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 }, "numberFormat": "string", "numberLength": 0, "dueDays": 0, "invoiceNumberIndex": { "property1": 0, "property2": 0 }, "quoteNumberIndex": { "property1": 0, "property2": 0 }, "automaticallySendReminders": true, "invoiceTermsAndConditions": "string", "quoteTermsAndConditions": "string", "invoiceNumbering": 0, "quoteNumbering": 0 }, "pricingConfigurationCount": 0, "hasAgreedToPrice": true }, "currency": { "nonce": "string", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "balance": { "nonce": "string", "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": [ { "nonce": "string", "name": "string", "system": "string", "value": "string", "expiredAt": "2019-08-24T14:15:22Z" } ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true }, "numberFormat": "string", "numberLength": 0, "dueDays": 0, "invoiceNumberIndex": { "property1": 0, "property2": 0 }, "quoteNumberIndex": { "property1": 0, "property2": 0 }, "automaticallySendReminders": true, "invoiceTermsAndConditions": "string", "quoteTermsAndConditions": "string", "invoiceStandardDocuments": [ { "nonce": "string", "description": "string", "expiresAt": "2019-08-24T14:15:22Z", "fileName": "string", "mimeType": "string", "encoding": "string", "verified": true, "content": { "contentType": "data", "data": "string" }, "file": { "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" }, "externalAttributes": { "property1": {}, "property2": {} }, "name": "string" } ], "quoteStandardDocuments": [ { "nonce": "string", "description": "string", "expiresAt": "2019-08-24T14:15:22Z", "fileName": "string", "mimeType": "string", "encoding": "string", "verified": true, "content": { "contentType": "data", "data": "string" }, "file": { "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" }, "externalAttributes": { "property1": {}, "property2": {} }, "name": "string" } ], "invoiceNumbering": 0, "quoteNumbering": 0 }, "startTime": "2019-08-24T14:15:22Z", "endTime": "2019-08-24T14:15:22Z", "selfBilling": true, "currency": { "nonce": "string", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "triggerType": "endOfWeek", "pricingModules": [ { "nonce": "string", "type": "fixed", "name": "string", "sequenceNr": 0, "description": "string", "category": { "nonce": "string", "name": "string", "creditCode": "string", "debitCode": "string", "defaultValue": 0.1, "enabled": true }, "taxRates": [ { "nonce": "string", "sequenceNr": 0, "name": "string", "description": "string", "taxRate": { "nonce": "string", "creditCode": "string", "debitCode": "string", "identifiers": [ null ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "filters": [ { "filters": [] } ] } ], "filters": [ { "selector": "string", "comparisonType": "equal", "value": "string", "linkType": "and", "filters": [ { "filters": [] } ], "sequenceNr": 0 } ], "oncePerInvoice": true } ], "lastHandledSelfBilling": "2019-08-24T14:15:22Z", "signature": { "nonce": "string", "ip": "string", "userAgent": "string", "date": "2019-08-24T14:15:22Z", "file": { "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" } }, "integration": { "nonce": "string", "type": "manual", "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": [ null ], "filters": [ null ], "options": [ null ] } ], "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": [ null ], "filters": [ null ], "options": [ null ] } ], "filters": [ { "selector": "string", "comparisonType": "equal", "value": "string", "linkType": "and", "filters": [ null ], "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": [ { "vehicles": [] } ] }, "name": "string", "text": "string" } ], "triggerType": "trigger", "triggerEvent": "afterCreatingTrip", "filters": [ { "selector": "string", "comparisonType": "equal", "value": "string", "linkType": "and", "filters": [ {} ], "sequenceNr": 0 } ] }, "messageAutomation": { "nonce": "string", "name": "string", "description": "string", "automationConfig": { "triggerType": "trigger", "triggerEvent": "afterCreatingTrip", "schedule": { "integrationSchedulerScheduleValue": 0, "integrationSchedulerScheduleType": "seconds", "milliseconds": 0 }, "filters": [ { "selector": "string", "comparisonType": "equal", "value": "string", "linkType": "and", "filters": [ {} ], "sequenceNr": 0 } ], "query": { "nonce": "string", "fields": [ { "name": "string", "groupByAggregate": "count" } ], "entityType": "action", "joins": [ { "type": "inner_join", "entityType": "action", "onLeft": {}, "onRight": {} } ], "filters": [ { "nonce": "string", "sequenceNr": 0, "field": "string", "comparisonOperations": "equal", "value": "string", "valueType": "constant", "linkType": "and" } ], "groupBy": [ { "name": "string", "groupByAggregate": "count" } ], "having": { "name": "string", "groupByAggregate": "count" }, "sortFields": [ { "name": "string", "groupByAggregate": "count" } ], "sortDirection": "asc", "limit": 0, "offset": 0 }, "recipients": [ "string" ], "recipientSelector": "string", "toggleForAll": true, "channel": "email", "manualIntegration": { "nonce": "string", "type": "manual", "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": [ null ], "allowedIps": [ null ], "hasAuthentication": true, "credentials": { "externalAttributes": {}, "headers": {} }, "otm": true, "fields": [ null ], "filters": [ null ], "template": true } ], "enabled": true, "lastHandled": "2019-08-24T14:15:22Z", "sectorType": "boardComputer", "manualType": "transics", "enabledFunctions": [ "string" ], "url": "string", "port": 0, "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" }, "filters": [ { "selector": "string", "comparisonType": "equal", "value": "string", "linkType": "and", "filters": [ null ], "sequenceNr": 0 } ], "integration": [ { "nonce": "string", "author": { "vehicleGroups": [] }, "name": "string", "text": "string" } ] }, "includeAttachments": true, "subject": "string", "currentTriggerPosition": 0, "localizedTexts": [ { "language": { "nonce": "string", "name": "string", "localName": "string", "code": "string", "iso3166": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "dateFormat": "string", "measurementUnit": "metric" }, "content": "string", "messageTemplate": "string", "subject": "string" } ], "defaultLanguageId": "string", "languageSelector": "string" }, "enabled": true, "lastHandled": "2019-08-24T14:15:22Z", "template": true, "templateCategory": "string", "type": "messageAutomation", "notes": [ { "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": [ { "vehicles": [] } ] }, "name": "string", "text": "string" } ] }, "consignments": [ { "nonce": "string", "versionNumber": 0, "hasAgreedToPrice": true, "name": "string", "consignmentNr": "string", "description": "string", "status": "draft", "highValueGoods": true, "goods": [ { "associationType": "inline" } ], "consignment": {}, "originalPhysicalSender": { "nonce": "string", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "nonce": "string", "type": "addressGeoReference", "hash": "string", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postCode": "string", "city": "string", "country": "string" }, "administrativeReference": { "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "contactPersons": [ { "nonce": "string", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "hash": "string", "externalAttributes": { "property1": {}, "property2": {} }, "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ], "remark": "string" }, "originalLegalSender": { "nonce": "string", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "nonce": "string", "type": "addressGeoReference", "hash": "string", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postCode": "string", "city": "string", "country": "string" }, "administrativeReference": { "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "contactPersons": [ { "nonce": "string", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "hash": "string", "externalAttributes": { "property1": {}, "property2": {} }, "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ], "remark": "string" }, "originalPhysicalAddressee": { "nonce": "string", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "nonce": "string", "type": "addressGeoReference", "hash": "string", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postCode": "string", "city": "string", "country": "string" }, "administrativeReference": { "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "contactPersons": [ { "nonce": "string", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "hash": "string", "externalAttributes": { "property1": {}, "property2": {} }, "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ], "remark": "string" }, "originalLegalAddressee": { "nonce": "string", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "nonce": "string", "type": "addressGeoReference", "hash": "string", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postCode": "string", "city": "string", "country": "string" }, "administrativeReference": { "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "contactPersons": [ { "nonce": "string", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "hash": "string", "externalAttributes": { "property1": {}, "property2": {} }, "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ], "remark": "string" }, "isPlannedToLastLocation": true, "documents": [ { "associationType": "inline" } ], "actors": [ { "associationType": "inline" } ], "pricingElements": [ { "nonce": "string", "name": "string", "description": "string", "category": { "nonce": "string", "name": "string", "creditCode": "string", "debitCode": "string", "defaultValue": 0.1, "enabled": true }, "amount": { "nonce": "string", "amount": 0.1, "currency": {}, "taxRate": { "identifiers": [] }, "inclusiveOfTax": true } } ], "externalAttributes": { "property1": {}, "property2": {} }, "expectedRevenue": { "nonce": "string", "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": [ {} ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true }, "expectedCost": { "nonce": "string", "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": [ {} ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true }, "combined": true, "type": "string", "remark": "string", "constraints": [ { "nonce": "string", "name": "string", "enforceability": "enforced", "type": "accessConstraint", "description": "string" } ], "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ] } ], "purchasedUnits": 0, "capacity": { "nonce": "string", "name": "string", "description": "string", "business": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "relationType": "string", "alias": "string", "description": "string", "transportLicenseNumber": "string", "eori": "string", "scacCode": "string", "industry": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "abbreviated": "string", "enabled": true }, "website": "string", "coc": "string", "vat": "string", "verified": true, "documents": [ { "associationType": "inline", "entity": { "nonce": "string", "description": "string", "expiresAt": "2019-08-24T14:15:22Z", "fileName": "string", "mimeType": "string", "encoding": "string", "verified": true, "content": {}, "file": {}, "externalAttributes": { "property1": {}, "property2": {} }, "name": "string" } } ], "logo": { "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" }, "banners": [ { "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" } ], "locations": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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": [ {} ], "constraints": [ {} ], "pricingElements": [ {} ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } } ], "identification": [ { "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" } ], "contactDetails": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "contactPersons": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "administration": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "primary": true, "business": {}, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "balance": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0.1, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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 }, "numberFormat": "string", "numberLength": 0, "dueDays": 0, "invoiceNumberIndex": { "property1": 0, "property2": 0 }, "quoteNumberIndex": { "property1": 0, "property2": 0 }, "automaticallySendReminders": true, "invoiceTermsAndConditions": "string", "quoteTermsAndConditions": "string", "invoiceNumbering": 0, "quoteNumbering": 0 }, "pricingConfigurationCount": 0, "hasAgreedToPrice": true }, "schedule": { "nonce": "string", "name": "string", "description": "string", "weekDays": [ "sunday" ], "startDate": "2019-08-24T14:15:22Z", "endDate": "2019-08-24T14:15:22Z", "timeSlotTemplates": [ { "nonce": "string", "capacityUnits": 0, "weekDay": "sunday", "startTime": "2019-08-24T14:15:22Z", "endTime": "2019-08-24T14:15:22Z", "pricingModules": [ { "taxRates": [], "filters": [] } ] } ], "timeSlots": [ { "nonce": "string", "date": "2019-08-24T14:15:22Z", "startTime": "2019-08-24T14:15:22Z", "endTime": "2019-08-24T14:15:22Z", "consignments": [ { "goods": [], "documents": [], "actors": [], "pricingElements": [], "externalAttributes": {}, "constraints": [], "attributes": [] } ], "route": { "nonce": "string", "time": 0, "cost": 0, "distance": 0, "expenses": [ null ], "additionalInfo": { "property1": {}, "property2": {} }, "lineString": "string", "actors": [ null ], "actions": [ null ], "name": "string", "constraints": [ null ] } } ] }, "modality": "maritime", "subType": "load", "capacityPerUnit": { "value": "string", "unit": "string" }, "totalUnits": 0, "availableCapacity": { "value": "string", "unit": "string" }, "totalCapacity": { "value": "string", "unit": "string" }, "pricingModules": [ { "nonce": "string", "type": "fixed", "name": "string", "sequenceNr": 0, "description": "string", "category": { "nonce": "string", "name": "string", "creditCode": "string", "debitCode": "string", "defaultValue": 0.1, "enabled": true }, "taxRates": [ { "nonce": "string", "sequenceNr": 0, "name": "string", "description": "string", "taxRate": { "identifiers": [] }, "filters": [ null ] } ], "filters": [ { "selector": "string", "comparisonType": "equal", "value": "string", "linkType": "and", "filters": [ null ], "sequenceNr": 0 } ], "oncePerInvoice": true } ] } }, "name": "string", "description": "string", "vin": "string", "licensePlate": "string", "vehicleType": "string", "emissionStandard": "euro0", "fuelCapacity": { "value": "string", "unit": "string" }, "fuelType": "string", "maxLinks": 0, "length": { "value": "string", "unit": "string" }, "height": { "value": "string", "unit": "string" }, "width": { "value": "string", "unit": "string" }, "loadLength": { "value": "string", "unit": "string" }, "loadHeight": { "value": "string", "unit": "string" }, "loadWidth": { "value": "string", "unit": "string" }, "maxWeight": { "value": "string", "unit": "string" }, "emptyWeight": { "value": "string", "unit": "string" }, "operational": true, "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ] }'
{ "success": true, "message": "string", "code": 0, "vehicle": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "vin": "string", "licensePlate": "string", "vehicleType": "string", "transportMode": "maritime", "emissionStandard": "euro0", "fuelCapacity": { … }, "fuelType": "string", "maxLinks": 0, "loadCapacities": [ … ], "length": { … }, "height": { … }, "width": { … }, "loadLength": { … }, "loadHeight": { … }, "loadWidth": { … }, "maxWeight": { … }, "emptyWeight": { … }, "loadMeters": { … }, "operational": true, "actors": [ … ], "legalStatistics": { … }, "capacityContract": { … }, "attributes": [ … ], "stackCapacities": [ … ], "versionNumber": 0 } }
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.
curl -i -X POST \ https://docs.transportial.com/_mock/apis/vehicle \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "nonce": "string", "versionNumber": 0, "hasAgreedToPrice": true, "transportMode": "maritime", "loadCapacities": [ { "value": "string", "unit": "string" } ], "loadMeters": { "value": "string", "unit": "string" }, "actors": [ { "associationType": "inline" } ], "legalStatistics": { "lastInstantOfAVehicleOwnerLocation": "2019-08-24T14:15:22Z", "countryCabotageStatistics": { "property1": { "completedCabotageTrips": 0, "lastInstantOfCompletedCabotageTrip": "2019-08-24T14:15:22Z", "lastInstantOfInternationalTripWithCountryAsDestination": "2019-08-24T14:15:22Z" }, "property2": { "completedCabotageTrips": 0, "lastInstantOfCompletedCabotageTrip": "2019-08-24T14:15:22Z", "lastInstantOfInternationalTripWithCountryAsDestination": "2019-08-24T14:15:22Z" } }, "lastInstantOfInternationalTrip": "2019-08-24T14:15:22Z", "lastInternationalTripDestinationCountry": "string" }, "capacityContract": { "nonce": "string", "name": "string", "type": "permanentContract", "communicationMethod": "messageAutomation", "contract": { "nonce": "string", "title": "string", "description": "string", "deliveryTerms": "EXW", "contractor": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "relationType": "string", "alias": "string", "description": "string", "transportLicenseNumber": "string", "eori": "string", "scacCode": "string", "industry": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "abbreviated": "string", "enabled": true }, "website": "string", "coc": "string", "vat": "string", "verified": true, "documents": [ { "associationType": "inline", "entity": { "nonce": "string", "description": "string", "expiresAt": "2019-08-24T14:15:22Z", "fileName": "string", "mimeType": "string", "encoding": "string", "verified": true, "content": {}, "file": {}, "externalAttributes": { "property1": {}, "property2": {} }, "name": "string" } } ], "logo": { "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" }, "banners": [ { "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" } ], "locations": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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": [ {} ], "constraints": [ {} ], "pricingElements": [ {} ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } } ], "identification": [ { "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" } ], "contactDetails": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "contactPersons": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "administration": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "primary": true, "business": {}, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "balance": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0.1, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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 }, "numberFormat": "string", "numberLength": 0, "dueDays": 0, "invoiceNumberIndex": { "property1": 0, "property2": 0 }, "quoteNumberIndex": { "property1": 0, "property2": 0 }, "automaticallySendReminders": true, "invoiceTermsAndConditions": "string", "quoteTermsAndConditions": "string", "invoiceNumbering": 0, "quoteNumbering": 0 }, "pricingConfigurationCount": 0, "hasAgreedToPrice": true }, "contractorSignee": { "nonce": "string", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" }, "client": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "relationType": "string", "alias": "string", "description": "string", "transportLicenseNumber": "string", "eori": "string", "scacCode": "string", "industry": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "abbreviated": "string", "enabled": true }, "website": "string", "coc": "string", "vat": "string", "verified": true, "documents": [ { "associationType": "inline", "entity": { "nonce": "string", "description": "string", "expiresAt": "2019-08-24T14:15:22Z", "fileName": "string", "mimeType": "string", "encoding": "string", "verified": true, "content": {}, "file": {}, "externalAttributes": { "property1": {}, "property2": {} }, "name": "string" } } ], "logo": { "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" }, "banners": [ { "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" } ], "locations": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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": [ {} ], "constraints": [ {} ], "pricingElements": [ {} ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } } ], "identification": [ { "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" } ], "contactDetails": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "contactPersons": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "administration": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "primary": true, "business": {}, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "balance": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0.1, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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 }, "numberFormat": "string", "numberLength": 0, "dueDays": 0, "invoiceNumberIndex": { "property1": 0, "property2": 0 }, "quoteNumberIndex": { "property1": 0, "property2": 0 }, "automaticallySendReminders": true, "invoiceTermsAndConditions": "string", "quoteTermsAndConditions": "string", "invoiceNumbering": 0, "quoteNumbering": 0 }, "pricingConfigurationCount": 0, "hasAgreedToPrice": true }, "clientSignee": { "nonce": "string", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } }, "business": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "relationType": "string", "alias": "string", "description": "string", "transportLicenseNumber": "string", "eori": "string", "scacCode": "string", "industry": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "abbreviated": "string", "enabled": true }, "website": "string", "coc": "string", "vat": "string", "verified": true, "documents": [ { "associationType": "inline", "entity": { "nonce": "string", "description": "string", "expiresAt": "2019-08-24T14:15:22Z", "fileName": "string", "mimeType": "string", "encoding": "string", "verified": true, "content": { "contentType": "data", "data": "string" }, "file": { "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" }, "externalAttributes": { "property1": {}, "property2": {} }, "name": "string" } } ], "logo": { "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" }, "banners": [ { "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" } ], "locations": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "constraints": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "accessConstraint", "name": "string", "enforceability": "enforced", "description": "string" } ], "pricingElements": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "category": {}, "amount": {} } ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } } ], "identification": [ { "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" } ], "contactDetails": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "contactPersons": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "administration": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "primary": true, "business": {}, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "balance": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0.1, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "taxRate": { "nonce": "string", "creditCode": "string", "debitCode": "string", "identifiers": [ {} ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true }, "numberFormat": "string", "numberLength": 0, "dueDays": 0, "invoiceNumberIndex": { "property1": 0, "property2": 0 }, "quoteNumberIndex": { "property1": 0, "property2": 0 }, "automaticallySendReminders": true, "invoiceTermsAndConditions": "string", "quoteTermsAndConditions": "string", "invoiceNumbering": 0, "quoteNumbering": 0 }, "pricingConfigurationCount": 0, "hasAgreedToPrice": true }, "administration": { "nonce": "string", "name": "string", "primary": true, "business": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "relationType": "string", "alias": "string", "description": "string", "transportLicenseNumber": "string", "eori": "string", "scacCode": "string", "industry": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "abbreviated": "string", "enabled": true }, "website": "string", "coc": "string", "vat": "string", "verified": true, "documents": [ { "associationType": "inline", "entity": { "nonce": "string", "description": "string", "expiresAt": "2019-08-24T14:15:22Z", "fileName": "string", "mimeType": "string", "encoding": "string", "verified": true, "content": {}, "file": {}, "externalAttributes": { "property1": {}, "property2": {} }, "name": "string" } } ], "logo": { "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" }, "banners": [ { "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" } ], "locations": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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": [ {} ], "constraints": [ {} ], "pricingElements": [ {} ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } } ], "identification": [ { "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" } ], "contactDetails": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "contactPersons": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "administration": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "primary": true, "business": {}, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "balance": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0.1, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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 }, "numberFormat": "string", "numberLength": 0, "dueDays": 0, "invoiceNumberIndex": { "property1": 0, "property2": 0 }, "quoteNumberIndex": { "property1": 0, "property2": 0 }, "automaticallySendReminders": true, "invoiceTermsAndConditions": "string", "quoteTermsAndConditions": "string", "invoiceNumbering": 0, "quoteNumbering": 0 }, "pricingConfigurationCount": 0, "hasAgreedToPrice": true }, "currency": { "nonce": "string", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "balance": { "nonce": "string", "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": [ { "nonce": "string", "name": "string", "system": "string", "value": "string", "expiredAt": "2019-08-24T14:15:22Z" } ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true }, "numberFormat": "string", "numberLength": 0, "dueDays": 0, "invoiceNumberIndex": { "property1": 0, "property2": 0 }, "quoteNumberIndex": { "property1": 0, "property2": 0 }, "automaticallySendReminders": true, "invoiceTermsAndConditions": "string", "quoteTermsAndConditions": "string", "invoiceStandardDocuments": [ { "nonce": "string", "description": "string", "expiresAt": "2019-08-24T14:15:22Z", "fileName": "string", "mimeType": "string", "encoding": "string", "verified": true, "content": { "contentType": "data", "data": "string" }, "file": { "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" }, "externalAttributes": { "property1": {}, "property2": {} }, "name": "string" } ], "quoteStandardDocuments": [ { "nonce": "string", "description": "string", "expiresAt": "2019-08-24T14:15:22Z", "fileName": "string", "mimeType": "string", "encoding": "string", "verified": true, "content": { "contentType": "data", "data": "string" }, "file": { "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" }, "externalAttributes": { "property1": {}, "property2": {} }, "name": "string" } ], "invoiceNumbering": 0, "quoteNumbering": 0 }, "startTime": "2019-08-24T14:15:22Z", "endTime": "2019-08-24T14:15:22Z", "selfBilling": true, "currency": { "nonce": "string", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "triggerType": "endOfWeek", "pricingModules": [ { "nonce": "string", "type": "fixed", "name": "string", "sequenceNr": 0, "description": "string", "category": { "nonce": "string", "name": "string", "creditCode": "string", "debitCode": "string", "defaultValue": 0.1, "enabled": true }, "taxRates": [ { "nonce": "string", "sequenceNr": 0, "name": "string", "description": "string", "taxRate": { "nonce": "string", "creditCode": "string", "debitCode": "string", "identifiers": [ null ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "filters": [ { "filters": [] } ] } ], "filters": [ { "selector": "string", "comparisonType": "equal", "value": "string", "linkType": "and", "filters": [ { "filters": [] } ], "sequenceNr": 0 } ], "oncePerInvoice": true } ], "lastHandledSelfBilling": "2019-08-24T14:15:22Z", "signature": { "nonce": "string", "ip": "string", "userAgent": "string", "date": "2019-08-24T14:15:22Z", "file": { "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" } }, "integration": { "nonce": "string", "type": "manual", "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": [ null ], "filters": [ null ], "options": [ null ] } ], "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": [ null ], "filters": [ null ], "options": [ null ] } ], "filters": [ { "selector": "string", "comparisonType": "equal", "value": "string", "linkType": "and", "filters": [ null ], "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": [ { "vehicles": [] } ] }, "name": "string", "text": "string" } ], "triggerType": "trigger", "triggerEvent": "afterCreatingTrip", "filters": [ { "selector": "string", "comparisonType": "equal", "value": "string", "linkType": "and", "filters": [ {} ], "sequenceNr": 0 } ] }, "messageAutomation": { "nonce": "string", "name": "string", "description": "string", "automationConfig": { "triggerType": "trigger", "triggerEvent": "afterCreatingTrip", "schedule": { "integrationSchedulerScheduleValue": 0, "integrationSchedulerScheduleType": "seconds", "milliseconds": 0 }, "filters": [ { "selector": "string", "comparisonType": "equal", "value": "string", "linkType": "and", "filters": [ {} ], "sequenceNr": 0 } ], "query": { "nonce": "string", "fields": [ { "name": "string", "groupByAggregate": "count" } ], "entityType": "action", "joins": [ { "type": "inner_join", "entityType": "action", "onLeft": {}, "onRight": {} } ], "filters": [ { "nonce": "string", "sequenceNr": 0, "field": "string", "comparisonOperations": "equal", "value": "string", "valueType": "constant", "linkType": "and" } ], "groupBy": [ { "name": "string", "groupByAggregate": "count" } ], "having": { "name": "string", "groupByAggregate": "count" }, "sortFields": [ { "name": "string", "groupByAggregate": "count" } ], "sortDirection": "asc", "limit": 0, "offset": 0 }, "recipients": [ "string" ], "recipientSelector": "string", "toggleForAll": true, "channel": "email", "manualIntegration": { "nonce": "string", "type": "manual", "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": [ null ], "allowedIps": [ null ], "hasAuthentication": true, "credentials": { "externalAttributes": {}, "headers": {} }, "otm": true, "fields": [ null ], "filters": [ null ], "template": true } ], "enabled": true, "lastHandled": "2019-08-24T14:15:22Z", "sectorType": "boardComputer", "manualType": "transics", "enabledFunctions": [ "string" ], "url": "string", "port": 0, "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" }, "filters": [ { "selector": "string", "comparisonType": "equal", "value": "string", "linkType": "and", "filters": [ null ], "sequenceNr": 0 } ], "integration": [ { "nonce": "string", "author": { "vehicleGroups": [] }, "name": "string", "text": "string" } ] }, "includeAttachments": true, "subject": "string", "currentTriggerPosition": 0, "localizedTexts": [ { "language": { "nonce": "string", "name": "string", "localName": "string", "code": "string", "iso3166": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "dateFormat": "string", "measurementUnit": "metric" }, "content": "string", "messageTemplate": "string", "subject": "string" } ], "defaultLanguageId": "string", "languageSelector": "string" }, "enabled": true, "lastHandled": "2019-08-24T14:15:22Z", "template": true, "templateCategory": "string", "type": "messageAutomation", "notes": [ { "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": [ { "vehicles": [] } ] }, "name": "string", "text": "string" } ] }, "consignments": [ { "nonce": "string", "versionNumber": 0, "hasAgreedToPrice": true, "name": "string", "consignmentNr": "string", "description": "string", "status": "draft", "highValueGoods": true, "goods": [ { "associationType": "inline" } ], "consignment": {}, "originalPhysicalSender": { "nonce": "string", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "nonce": "string", "type": "addressGeoReference", "hash": "string", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postCode": "string", "city": "string", "country": "string" }, "administrativeReference": { "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "contactPersons": [ { "nonce": "string", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "hash": "string", "externalAttributes": { "property1": {}, "property2": {} }, "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ], "remark": "string" }, "originalLegalSender": { "nonce": "string", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "nonce": "string", "type": "addressGeoReference", "hash": "string", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postCode": "string", "city": "string", "country": "string" }, "administrativeReference": { "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "contactPersons": [ { "nonce": "string", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "hash": "string", "externalAttributes": { "property1": {}, "property2": {} }, "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ], "remark": "string" }, "originalPhysicalAddressee": { "nonce": "string", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "nonce": "string", "type": "addressGeoReference", "hash": "string", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postCode": "string", "city": "string", "country": "string" }, "administrativeReference": { "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "contactPersons": [ { "nonce": "string", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "hash": "string", "externalAttributes": { "property1": {}, "property2": {} }, "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ], "remark": "string" }, "originalLegalAddressee": { "nonce": "string", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "nonce": "string", "type": "addressGeoReference", "hash": "string", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postCode": "string", "city": "string", "country": "string" }, "administrativeReference": { "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string" }, "contactPersons": [ { "nonce": "string", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "hash": "string", "externalAttributes": { "property1": {}, "property2": {} }, "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ], "remark": "string" }, "isPlannedToLastLocation": true, "documents": [ { "associationType": "inline" } ], "actors": [ { "associationType": "inline" } ], "pricingElements": [ { "nonce": "string", "name": "string", "description": "string", "category": { "nonce": "string", "name": "string", "creditCode": "string", "debitCode": "string", "defaultValue": 0.1, "enabled": true }, "amount": { "nonce": "string", "amount": 0.1, "currency": {}, "taxRate": { "identifiers": [] }, "inclusiveOfTax": true } } ], "externalAttributes": { "property1": {}, "property2": {} }, "expectedRevenue": { "nonce": "string", "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": [ {} ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true }, "expectedCost": { "nonce": "string", "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": [ {} ], "name": "string", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true }, "inclusiveOfTax": true }, "combined": true, "type": "string", "remark": "string", "constraints": [ { "nonce": "string", "name": "string", "enforceability": "enforced", "type": "accessConstraint", "description": "string" } ], "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ] } ], "purchasedUnits": 0, "capacity": { "nonce": "string", "name": "string", "description": "string", "business": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "relationType": "string", "alias": "string", "description": "string", "transportLicenseNumber": "string", "eori": "string", "scacCode": "string", "industry": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "abbreviated": "string", "enabled": true }, "website": "string", "coc": "string", "vat": "string", "verified": true, "documents": [ { "associationType": "inline", "entity": { "nonce": "string", "description": "string", "expiresAt": "2019-08-24T14:15:22Z", "fileName": "string", "mimeType": "string", "encoding": "string", "verified": true, "content": {}, "file": {}, "externalAttributes": { "property1": {}, "property2": {} }, "name": "string" } } ], "logo": { "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" }, "banners": [ { "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" } ], "locations": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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": [ {} ], "constraints": [ {} ], "pricingElements": [ {} ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } } ], "identification": [ { "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" } ], "contactDetails": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "contactPersons": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "firstName": "string", "lastName": "string", "position": "string", "email": "string", "phone": "string" } ], "administration": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "primary": true, "business": {}, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "short": "string", "sign": "string", "decimalDelimiter": "string", "thousandDelimiter": "string", "enabled": true }, "balance": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0.1, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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 }, "numberFormat": "string", "numberLength": 0, "dueDays": 0, "invoiceNumberIndex": { "property1": 0, "property2": 0 }, "quoteNumberIndex": { "property1": 0, "property2": 0 }, "automaticallySendReminders": true, "invoiceTermsAndConditions": "string", "quoteTermsAndConditions": "string", "invoiceNumbering": 0, "quoteNumbering": 0 }, "pricingConfigurationCount": 0, "hasAgreedToPrice": true }, "schedule": { "nonce": "string", "name": "string", "description": "string", "weekDays": [ "sunday" ], "startDate": "2019-08-24T14:15:22Z", "endDate": "2019-08-24T14:15:22Z", "timeSlotTemplates": [ { "nonce": "string", "capacityUnits": 0, "weekDay": "sunday", "startTime": "2019-08-24T14:15:22Z", "endTime": "2019-08-24T14:15:22Z", "pricingModules": [ { "taxRates": [], "filters": [] } ] } ], "timeSlots": [ { "nonce": "string", "date": "2019-08-24T14:15:22Z", "startTime": "2019-08-24T14:15:22Z", "endTime": "2019-08-24T14:15:22Z", "consignments": [ { "goods": [], "documents": [], "actors": [], "pricingElements": [], "externalAttributes": {}, "constraints": [], "attributes": [] } ], "route": { "nonce": "string", "time": 0, "cost": 0, "distance": 0, "expenses": [ null ], "additionalInfo": { "property1": {}, "property2": {} }, "lineString": "string", "actors": [ null ], "actions": [ null ], "name": "string", "constraints": [ null ] } } ] }, "modality": "maritime", "subType": "load", "capacityPerUnit": { "value": "string", "unit": "string" }, "totalUnits": 0, "availableCapacity": { "value": "string", "unit": "string" }, "totalCapacity": { "value": "string", "unit": "string" }, "pricingModules": [ { "nonce": "string", "type": "fixed", "name": "string", "sequenceNr": 0, "description": "string", "category": { "nonce": "string", "name": "string", "creditCode": "string", "debitCode": "string", "defaultValue": 0.1, "enabled": true }, "taxRates": [ { "nonce": "string", "sequenceNr": 0, "name": "string", "description": "string", "taxRate": { "identifiers": [] }, "filters": [ null ] } ], "filters": [ { "selector": "string", "comparisonType": "equal", "value": "string", "linkType": "and", "filters": [ null ], "sequenceNr": 0 } ], "oncePerInvoice": true } ] } }, "name": "string", "description": "string", "vin": "string", "licensePlate": "string", "vehicleType": "string", "emissionStandard": "euro0", "fuelCapacity": { "value": "string", "unit": "string" }, "fuelType": "string", "maxLinks": 0, "length": { "value": "string", "unit": "string" }, "height": { "value": "string", "unit": "string" }, "width": { "value": "string", "unit": "string" }, "loadLength": { "value": "string", "unit": "string" }, "loadHeight": { "value": "string", "unit": "string" }, "loadWidth": { "value": "string", "unit": "string" }, "maxWeight": { "value": "string", "unit": "string" }, "emptyWeight": { "value": "string", "unit": "string" }, "operational": true, "attributes": [ { "nonce": "string", "name": "string", "color": "string" } ] }'
{ "success": true, "message": "string", "code": 0, "vehicle": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "vin": "string", "licensePlate": "string", "vehicleType": "string", "transportMode": "maritime", "emissionStandard": "euro0", "fuelCapacity": { … }, "fuelType": "string", "maxLinks": 0, "loadCapacities": [ … ], "length": { … }, "height": { … }, "width": { … }, "loadLength": { … }, "loadHeight": { … }, "loadWidth": { … }, "maxWeight": { … }, "emptyWeight": { … }, "loadMeters": { … }, "operational": true, "actors": [ … ], "legalStatistics": { … }, "capacityContract": { … }, "attributes": [ … ], "stackCapacities": [ … ], "versionNumber": 0 } }
curl -i -X GET \ 'https://docs.transportial.com/_mock/apis/vehicle/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "vehicle": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "vin": "string", "licensePlate": "string", "vehicleType": "string", "transportMode": "maritime", "emissionStandard": "euro0", "fuelCapacity": { … }, "fuelType": "string", "maxLinks": 0, "loadCapacities": [ … ], "length": { … }, "height": { … }, "width": { … }, "loadLength": { … }, "loadHeight": { … }, "loadWidth": { … }, "maxWeight": { … }, "emptyWeight": { … }, "loadMeters": { … }, "operational": true, "actors": [ … ], "legalStatistics": { … }, "capacityContract": { … }, "attributes": [ … ], "stackCapacities": [ … ], "versionNumber": 0 } }
curl -i -X DELETE \ 'https://docs.transportial.com/_mock/apis/vehicle/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "vehicle": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "vin": "string", "licensePlate": "string", "vehicleType": "string", "transportMode": "maritime", "emissionStandard": "euro0", "fuelCapacity": { … }, "fuelType": "string", "maxLinks": 0, "loadCapacities": [ … ], "length": { … }, "height": { … }, "width": { … }, "loadLength": { … }, "loadHeight": { … }, "loadWidth": { … }, "maxWeight": { … }, "emptyWeight": { … }, "loadMeters": { … }, "operational": true, "actors": [ … ], "legalStatistics": { … }, "capacityContract": { … }, "attributes": [ … ], "stackCapacities": [ … ], "versionNumber": 0 } }
curl -i -X GET \ 'https://docs.transportial.com/_mock/apis/vehicle/extended/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "extendedVehicle": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "vin": "string", "licensePlate": "string", "vehicleType": "string", "transportMode": "maritime", "emissionStandard": "euro0", "fuelCapacity": { … }, "fuelType": "string", "maxLinks": 0, "loadCapacities": [ … ], "length": { … }, "height": { … }, "width": { … }, "loadLength": { … }, "loadHeight": { … }, "loadWidth": { … }, "maxWeight": { … }, "emptyWeight": { … }, "loadMeters": { … }, "operational": true, "actors": [ … ], "legalStatistics": { … }, "capacityContract": { … }, "attributes": [ … ], "stackCapacities": [ … ], "versionNumber": 0 } }
curl -i -X GET \ 'https://docs.transportial.com/_mock/apis/vehicles/extended/{offset}/{amount}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "extendedVehicles": [ { … } ] }
curl -i -X POST \ 'https://docs.transportial.com/_mock/apis/vehicles/extended/{offset}/{amount}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "extendedVehicles": [ { … } ] }
curl -i -X GET \ 'https://docs.transportial.com/_mock/apis/vehicle/{id}/trips:active/{offset}/{amount}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "trips": [ { … } ] }
curl -i -X GET \ 'https://docs.transportial.com/_mock/apis/vehicle/{id}/chauffeurs' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "chauffeurs": [ { … } ] }
curl -i -X GET \ 'https://docs.transportial.com/_mock/apis/vehicle/{id}/events/{offset}/{amount}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "activities": [ { … } ] }
curl -i -X GET \ 'https://docs.transportial.com/_mock/apis/vehicle/{id}/trips:history/{offset}/{amount}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "trips": [ { … } ] }
curl -i -X GET \ 'https://docs.transportial.com/_mock/apis/vehicle/{id}/locationUpdateEvents/{fromDate}/{toDate}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "events": [ { … } ] }
curl -i -X GET \ 'https://docs.transportial.com/_mock/apis/vehicle/{id}/transportEquipments' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "transportEquipments": [ { … } ] }
curl -i -X GET \ 'https://docs.transportial.com/_mock/apis/vehicle/{id}/trips:byDate/{fromDate}/{toDate}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "trips": [ { … } ] }
curl -i -X GET \ 'https://docs.transportial.com/_mock/apis/vehicle/{id}/trips/{offset}/{amount}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "trips": [ { … } ] }
curl -i -X GET \ https://docs.transportial.com/_mock/apis/vehicles/location \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "vehicles": [ { … } ] }
curl -i -X POST \ https://docs.transportial.com/_mock/apis/vehicles/location \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "vehicles": [ { … } ] }
curl -i -X POST \ 'https://docs.transportial.com/_mock/apis/vehicles/trips:nextActive/{offset}/{amount}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "vehiclesTrips": [ { … } ] }
curl -i -X GET \ 'https://docs.transportial.com/_mock/apis/vehicles/{offset}/{amount}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "vehicles": [ { … } ] }
curl -i -X POST \ 'https://docs.transportial.com/_mock/apis/vehicles/{offset}/{amount}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "vehicles": [ { … } ] }
curl -i -X POST \ 'https://docs.transportial.com/_mock/apis/vehicles/trips:byDate/{fromDate}/{toDate}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "vehiclesTrips": [ { … } ] }
curl -i -X POST \ 'https://docs.transportial.com/_mock/apis/vehicle/{id}/attach/chauffeur' \ -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": "attachTransportEquipment", "groupId": "string", "name": "string", "externalAttributes": { "property1": {}, "property2": {} }, "identifiers": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "system": "string", "value": "string", "expiredAt": "2019-08-24T14:15:22Z" } ], "lifeCycle": "requested", "result": { "status": "succeeded", "remark": "string", "reason": "string" }, "remark": "string", "sequenceNr": 0, "location": { "associationType": "inline", "entity": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "constraints": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "accessConstraint", "name": "string", "enforceability": "enforced", "description": "string" } ], "pricingElements": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "category": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "creditCode": "string", "debitCode": "string", "defaultValue": 0.1, "enabled": true }, "amount": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0.1, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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 } } ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } }, "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, "actions": [ { "type": "inline", "associationType": "string", "entity": { "nonce": "string", "versionNumber": 0, "type": "load", "groupId": "string", "name": "string", "externalAttributes": { "property1": {}, "property2": {} }, "lifeCycle": "requested", "result": { "status": "succeeded", "remark": "string", "reason": "string" }, "remark": "string", "sequenceNr": 0, "location": { "associationType": "inline", "entity": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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": [ {} ], "constraints": [ {} ], "pricingElements": [ {} ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } }, "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, "actions": [ {} ], "documents": [ { "associationType": "inline" } ], "identifiers": [ { "nonce": "string", "name": "string", "system": "string", "value": "string", "expiredAt": "2019-08-24T14:15:22Z" } ], "constraints": [ { "associationType": "inline", "entity": { "nonce": "string", "name": "string", "enforceability": "enforced", "type": "accessConstraint", "description": "string" }, "description": "string" } ], "communicationRequests": [ { "nonce": "string", "name": "string", "description": "string", "status": "pending", "responseMessage": "string", "responseValue": "string", "communicationRequests": [ {} ] } ], "isContainmentAction": true, "vehicle": { "associationType": "inline" }, "pin": "string", "tar": "string", "shipmentLine": { "scacCode": "string", "smdgCode": "string" }, "containmentUUID": "string" }, "description": "string" } ], "communicationRequests": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "status": "pending", "responseMessage": "string", "responseValue": "string" } ], "documents": [ { "associationType": "inline" } ], "versionNumber": 0, "constraints": [ { "associationType": "inline", "entity": { "nonce": "string", "name": "string", "enforceability": "enforced", "type": "accessConstraint", "description": "string" }, "description": "string" } ], "isContainmentAction": true, "vehicle": { "associationType": "inline" }, "stop": { "type": "inline", "associationType": "string", "entity": { "nonce": "string", "versionNumber": 0, "type": "load", "groupId": "string", "name": "string", "externalAttributes": { "property1": {}, "property2": {} }, "lifeCycle": "requested", "result": { "status": "succeeded", "remark": "string", "reason": "string" }, "remark": "string", "sequenceNr": 0, "location": { "associationType": "inline", "entity": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "constraints": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "accessConstraint", "name": "string", "enforceability": "enforced", "description": "string" } ], "pricingElements": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "category": {}, "amount": {} } ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } }, "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, "actions": [ {} ], "documents": [ { "associationType": "inline" } ], "identifiers": [ { "nonce": "string", "name": "string", "system": "string", "value": "string", "expiredAt": "2019-08-24T14:15:22Z" } ], "constraints": [ { "associationType": "inline", "entity": { "nonce": "string", "name": "string", "enforceability": "enforced", "type": "accessConstraint", "description": "string" }, "description": "string" } ], "communicationRequests": [ { "nonce": "string", "name": "string", "description": "string", "status": "pending", "responseMessage": "string", "responseValue": "string", "communicationRequests": [ {} ] } ], "isContainmentAction": true, "vehicle": { "associationType": "inline" }, "pin": "string", "tar": "string", "shipmentLine": { "scacCode": "string", "smdgCode": "string" }, "containmentUUID": "string" }, "description": "string" }, "pin": "string", "tar": "string", "shipmentLine": { "scacCode": "string", "smdgCode": "string" }, "containmentUUID": "string" }'
{ "success": true, "message": "string", "code": 0, "vehicle": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "vin": "string", "licensePlate": "string", "vehicleType": "string", "transportMode": "maritime", "emissionStandard": "euro0", "fuelCapacity": { … }, "fuelType": "string", "maxLinks": 0, "loadCapacities": [ … ], "length": { … }, "height": { … }, "width": { … }, "loadLength": { … }, "loadHeight": { … }, "loadWidth": { … }, "maxWeight": { … }, "emptyWeight": { … }, "loadMeters": { … }, "operational": true, "actors": [ … ], "legalStatistics": { … }, "capacityContract": { … }, "attributes": [ … ], "stackCapacities": [ … ], "versionNumber": 0 } }
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.
The type of action
curl -i -X POST \ 'https://docs.transportial.com/_mock/apis/vehicle/{id}/attach/transportEquipment' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "nonce": "string", "versionNumber": 0, "type": "attachTransportEquipment", "groupId": "string", "name": "string", "externalAttributes": { "property1": {}, "property2": {} }, "lifeCycle": "requested", "result": { "status": "succeeded", "remark": "string", "reason": "string" }, "remark": "string", "sequenceNr": 0, "location": { "associationType": "inline", "entity": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "constraints": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "accessConstraint", "name": "string", "enforceability": "enforced", "description": "string" } ], "pricingElements": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "category": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "creditCode": "string", "debitCode": "string", "defaultValue": 0.1, "enabled": true }, "amount": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0.1, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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 } } ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } }, "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, "actions": [ { "type": "inline", "associationType": "string", "entity": {}, "description": "string" } ], "documents": [ { "associationType": "inline" } ], "identifiers": [ { "nonce": "string", "name": "string", "system": "string", "value": "string", "expiredAt": "2019-08-24T14:15:22Z" } ], "constraints": [ { "associationType": "inline", "entity": { "nonce": "string", "name": "string", "enforceability": "enforced", "type": "accessConstraint", "description": "string" }, "description": "string" } ], "communicationRequests": [ { "nonce": "string", "name": "string", "description": "string", "status": "pending", "responseMessage": "string", "responseValue": "string", "communicationRequests": [ {} ] } ], "isContainmentAction": true, "vehicle": { "associationType": "inline" }, "pin": "string", "tar": "string", "shipmentLine": { "scacCode": "string", "smdgCode": "string" }, "containmentUUID": "string" }'
{ "success": true, "message": "string", "code": 0, "vehicle": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "vin": "string", "licensePlate": "string", "vehicleType": "string", "transportMode": "maritime", "emissionStandard": "euro0", "fuelCapacity": { … }, "fuelType": "string", "maxLinks": 0, "loadCapacities": [ … ], "length": { … }, "height": { … }, "width": { … }, "loadLength": { … }, "loadHeight": { … }, "loadWidth": { … }, "maxWeight": { … }, "emptyWeight": { … }, "loadMeters": { … }, "operational": true, "actors": [ … ], "legalStatistics": { … }, "capacityContract": { … }, "attributes": [ … ], "stackCapacities": [ … ], "versionNumber": 0 } }
curl -i -X POST \ 'https://docs.transportial.com/_mock/apis/vehicle/{id}/detach/chauffeur' \ -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": "attachTransportEquipment", "groupId": "string", "name": "string", "externalAttributes": { "property1": {}, "property2": {} }, "identifiers": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "system": "string", "value": "string", "expiredAt": "2019-08-24T14:15:22Z" } ], "lifeCycle": "requested", "result": { "status": "succeeded", "remark": "string", "reason": "string" }, "remark": "string", "sequenceNr": 0, "location": { "associationType": "inline", "entity": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "constraints": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "accessConstraint", "name": "string", "enforceability": "enforced", "description": "string" } ], "pricingElements": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "category": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "creditCode": "string", "debitCode": "string", "defaultValue": 0.1, "enabled": true }, "amount": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0.1, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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 } } ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } }, "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, "actions": [ { "type": "inline", "associationType": "string", "entity": { "nonce": "string", "versionNumber": 0, "type": "load", "groupId": "string", "name": "string", "externalAttributes": { "property1": {}, "property2": {} }, "lifeCycle": "requested", "result": { "status": "succeeded", "remark": "string", "reason": "string" }, "remark": "string", "sequenceNr": 0, "location": { "associationType": "inline", "entity": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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": [ {} ], "constraints": [ {} ], "pricingElements": [ {} ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } }, "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, "actions": [ {} ], "documents": [ { "associationType": "inline" } ], "identifiers": [ { "nonce": "string", "name": "string", "system": "string", "value": "string", "expiredAt": "2019-08-24T14:15:22Z" } ], "constraints": [ { "associationType": "inline", "entity": { "nonce": "string", "name": "string", "enforceability": "enforced", "type": "accessConstraint", "description": "string" }, "description": "string" } ], "communicationRequests": [ { "nonce": "string", "name": "string", "description": "string", "status": "pending", "responseMessage": "string", "responseValue": "string", "communicationRequests": [ {} ] } ], "isContainmentAction": true, "vehicle": { "associationType": "inline" }, "pin": "string", "tar": "string", "shipmentLine": { "scacCode": "string", "smdgCode": "string" }, "containmentUUID": "string" }, "description": "string" } ], "communicationRequests": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "status": "pending", "responseMessage": "string", "responseValue": "string" } ], "documents": [ { "associationType": "inline" } ], "versionNumber": 0, "constraints": [ { "associationType": "inline", "entity": { "nonce": "string", "name": "string", "enforceability": "enforced", "type": "accessConstraint", "description": "string" }, "description": "string" } ], "isContainmentAction": true, "vehicle": { "associationType": "inline" }, "stop": { "type": "inline", "associationType": "string", "entity": { "nonce": "string", "versionNumber": 0, "type": "load", "groupId": "string", "name": "string", "externalAttributes": { "property1": {}, "property2": {} }, "lifeCycle": "requested", "result": { "status": "succeeded", "remark": "string", "reason": "string" }, "remark": "string", "sequenceNr": 0, "location": { "associationType": "inline", "entity": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "constraints": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "accessConstraint", "name": "string", "enforceability": "enforced", "description": "string" } ], "pricingElements": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "category": {}, "amount": {} } ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } }, "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, "actions": [ {} ], "documents": [ { "associationType": "inline" } ], "identifiers": [ { "nonce": "string", "name": "string", "system": "string", "value": "string", "expiredAt": "2019-08-24T14:15:22Z" } ], "constraints": [ { "associationType": "inline", "entity": { "nonce": "string", "name": "string", "enforceability": "enforced", "type": "accessConstraint", "description": "string" }, "description": "string" } ], "communicationRequests": [ { "nonce": "string", "name": "string", "description": "string", "status": "pending", "responseMessage": "string", "responseValue": "string", "communicationRequests": [ {} ] } ], "isContainmentAction": true, "vehicle": { "associationType": "inline" }, "pin": "string", "tar": "string", "shipmentLine": { "scacCode": "string", "smdgCode": "string" }, "containmentUUID": "string" }, "description": "string" }, "pin": "string", "tar": "string", "shipmentLine": { "scacCode": "string", "smdgCode": "string" }, "containmentUUID": "string" }'
{ "success": true, "message": "string", "code": 0, "vehicle": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "vin": "string", "licensePlate": "string", "vehicleType": "string", "transportMode": "maritime", "emissionStandard": "euro0", "fuelCapacity": { … }, "fuelType": "string", "maxLinks": 0, "loadCapacities": [ … ], "length": { … }, "height": { … }, "width": { … }, "loadLength": { … }, "loadHeight": { … }, "loadWidth": { … }, "maxWeight": { … }, "emptyWeight": { … }, "loadMeters": { … }, "operational": true, "actors": [ … ], "legalStatistics": { … }, "capacityContract": { … }, "attributes": [ … ], "stackCapacities": [ … ], "versionNumber": 0 } }
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.
The type of action
curl -i -X POST \ 'https://docs.transportial.com/_mock/apis/vehicle/{id}/detach/transportEquipment' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "nonce": "string", "versionNumber": 0, "type": "attachTransportEquipment", "groupId": "string", "name": "string", "externalAttributes": { "property1": {}, "property2": {} }, "lifeCycle": "requested", "result": { "status": "succeeded", "remark": "string", "reason": "string" }, "remark": "string", "sequenceNr": 0, "location": { "associationType": "inline", "entity": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "warehouse", "name": "string", "unCode": "string", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "iban", "value": "string", "remarks": "string" } ], "constraints": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "accessConstraint", "name": "string", "enforceability": "enforced", "description": "string" } ], "pricingElements": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "category": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "creditCode": "string", "debitCode": "string", "defaultValue": 0.1, "enabled": true }, "amount": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "amount": 0.1, "currency": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "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 } } ], "remark": "string", "hash": "string", "externalAttributes": { "property1": {}, "property2": {} } }, "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, "actions": [ { "type": "inline", "associationType": "string", "entity": {}, "description": "string" } ], "documents": [ { "associationType": "inline" } ], "identifiers": [ { "nonce": "string", "name": "string", "system": "string", "value": "string", "expiredAt": "2019-08-24T14:15:22Z" } ], "constraints": [ { "associationType": "inline", "entity": { "nonce": "string", "name": "string", "enforceability": "enforced", "type": "accessConstraint", "description": "string" }, "description": "string" } ], "communicationRequests": [ { "nonce": "string", "name": "string", "description": "string", "status": "pending", "responseMessage": "string", "responseValue": "string", "communicationRequests": [ {} ] } ], "isContainmentAction": true, "vehicle": { "associationType": "inline" }, "pin": "string", "tar": "string", "shipmentLine": { "scacCode": "string", "smdgCode": "string" }, "containmentUUID": "string" }'
{ "success": true, "message": "string", "code": 0, "vehicle": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "vin": "string", "licensePlate": "string", "vehicleType": "string", "transportMode": "maritime", "emissionStandard": "euro0", "fuelCapacity": { … }, "fuelType": "string", "maxLinks": 0, "loadCapacities": [ … ], "length": { … }, "height": { … }, "width": { … }, "loadLength": { … }, "loadHeight": { … }, "loadWidth": { … }, "maxWeight": { … }, "emptyWeight": { … }, "loadMeters": { … }, "operational": true, "actors": [ … ], "legalStatistics": { … }, "capacityContract": { … }, "attributes": [ … ], "stackCapacities": [ … ], "versionNumber": 0 } }
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.
curl -i -X POST \ 'https://docs.transportial.com/_mock/apis/vehicle/{uuid}/{lifeCycle}/event' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "nonce": "string", "type": "arrivalEvent", "lifeCycle": "requested", "externalAttributes": { "property1": {}, "property2": {} }, "dateTime": "2019-08-24T14:15:22Z", "geoReference": { "nonce": "string", "type": "addressGeoReference", "hash": "string", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postCode": "string", "city": "string", "country": "string" } }'
{ "success": true, "message": "string", "code": 0, "event": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "generalEvent", "lifeCycle": "requested", "externalAttributes": { … }, "dateTime": "2019-08-24T14:15:22Z", "geoReference": { … } } }
curl -i -X POST \ 'https://docs.transportial.com/_mock/apis/vehicle/{uuid}/{lifeCycle}/locationUpdate' \ -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": "arrivalEvent", "lifeCycle": "requested", "externalAttributes": { "property1": {}, "property2": {} }, "dateTime": "2019-08-24T14:15:22Z", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "addressGeoReference", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string", "hash": "string" } }'
{ "success": true, "message": "string", "code": 0, "event": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "generalEvent", "lifeCycle": "requested", "externalAttributes": { … }, "dateTime": "2019-08-24T14:15:22Z", "geoReference": { … } } }
curl -i -X POST \ 'https://docs.transportial.com/_mock/apis/vehicle/{uuid}/{lifeCycle}/startEngine' \ -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": "arrivalEvent", "lifeCycle": "requested", "externalAttributes": { "property1": {}, "property2": {} }, "dateTime": "2019-08-24T14:15:22Z", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "addressGeoReference", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string", "hash": "string" } }'
{ "success": true, "message": "string", "code": 0, "event": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "generalEvent", "lifeCycle": "requested", "externalAttributes": { … }, "dateTime": "2019-08-24T14:15:22Z", "geoReference": { … } } }
curl -i -X POST \ 'https://docs.transportial.com/_mock/apis/vehicle/{uuid}/{lifeCycle}/startMoving' \ -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": "arrivalEvent", "lifeCycle": "requested", "externalAttributes": { "property1": {}, "property2": {} }, "dateTime": "2019-08-24T14:15:22Z", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "addressGeoReference", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string", "hash": "string" } }'
{ "success": true, "message": "string", "code": 0, "event": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "generalEvent", "lifeCycle": "requested", "externalAttributes": { … }, "dateTime": "2019-08-24T14:15:22Z", "geoReference": { … } } }
curl -i -X POST \ 'https://docs.transportial.com/_mock/apis/vehicle/{uuid}/{lifeCycle}/startWaiting' \ -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": "arrivalEvent", "lifeCycle": "requested", "externalAttributes": { "property1": {}, "property2": {} }, "dateTime": "2019-08-24T14:15:22Z", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "addressGeoReference", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string", "hash": "string" } }'
{ "success": true, "message": "string", "code": 0, "event": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "generalEvent", "lifeCycle": "requested", "externalAttributes": { … }, "dateTime": "2019-08-24T14:15:22Z", "geoReference": { … } } }
curl -i -X POST \ 'https://docs.transportial.com/_mock/apis/vehicle/{uuid}/{lifeCycle}/stopEngine' \ -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": "arrivalEvent", "lifeCycle": "requested", "externalAttributes": { "property1": {}, "property2": {} }, "dateTime": "2019-08-24T14:15:22Z", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "addressGeoReference", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string", "hash": "string" } }'
{ "success": true, "message": "string", "code": 0, "event": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "generalEvent", "lifeCycle": "requested", "externalAttributes": { … }, "dateTime": "2019-08-24T14:15:22Z", "geoReference": { … } } }
curl -i -X POST \ 'https://docs.transportial.com/_mock/apis/vehicle/{uuid}/{lifeCycle}/stopMoving' \ -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": "arrivalEvent", "lifeCycle": "requested", "externalAttributes": { "property1": {}, "property2": {} }, "dateTime": "2019-08-24T14:15:22Z", "geoReference": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "addressGeoReference", "name": "string", "street": "string", "houseNumber": "string", "houseNumberAddition": "string", "postalCode": "string", "city": "string", "country": "string", "hash": "string" } }'
{ "success": true, "message": "string", "code": 0, "event": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "generalEvent", "lifeCycle": "requested", "externalAttributes": { … }, "dateTime": "2019-08-24T14:15:22Z", "geoReference": { … } } }
curl -i -X GET \ 'https://docs.transportial.com/_mock/apis/vehicles/{uuid}/{lifeCycle}/events/{offset}/{amount}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "results": { "property1": { … }, "property2": { … } } }