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
curl -i -X PUT \ https://docs.transportial.com/_mock/apis/ban \ -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", "name": "string", "description": "string", "chauffeur": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "driver", "picture": { "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" }, "user": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "user", "username": "string", "avatar": { "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" }, "firstName": "string", "lastName": "string", "email": "string", "phone": "string", "passwordModified": "2019-08-24T14:15:22Z", "twoFactorAuthentication": true, "status": "DELETED", "loginMethod": "DEFAULT", "timezone": "string", "vehicleGroups": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "vehicles": [ { "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": [ null ], "length": {}, "height": {}, "width": {}, "loadLength": {}, "loadHeight": {}, "loadWidth": {}, "maxWeight": {}, "emptyWeight": {}, "loadMeters": {}, "operational": true, "actors": [ null ], "legalStatistics": { "countryCabotageStatistics": {} }, "capacityContract": { "pricingModules": [], "consignments": [] }, "attributes": [ null ], "stackCapacities": [ null ], "versionNumber": 0, "hasAgreedToPrice": true } ] } ], "activeAdministration": { "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": { "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": { "externalAttributes": {} } } ], "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": {}, "administrativeReference": {}, "contactDetails": [ null ], "constraints": [ null ], "pricingElements": [ null ], "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": {}, "pricingConfigurationCount": 0, "hasAgreedToPrice": true }, "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 }, "accountType": "default", "standardLoadingSize": 0 }, "firstName": "string", "lastName": "string", "dateOfBirth": "2019-08-24", "birthPlace": "string", "nationality": "string", "hourlyRate": { "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": [ { "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 }, "hoursPerMonth": 0.1, "adr": { "hasADR": true, "ADRNumber": "string", "ADRValidFromDate": "2019-08-24", "ADRExpirationDate": "2019-08-24", "ADRFiles": [ { "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" } ] }, "driverLicense": { "hasDriverLicense": true, "driverLicenseNumber": "string", "driverLicenseValidFromDate": "2019-08-24", "driverLicenseExpirationDate": "2019-08-24", "driverLicenseObtainedOn": "2019-08-24", "driverLicenseCountryOfIssue": "string", "driverLicenseIssuingAuthority": "string", "driverLicenseFiles": [ { "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" } ] }, "tachoCard": { "cardId": "string", "countryOfIssue": "string", "renewalIndex": "string", "replacementIndex": "string", "startOfValidity": "2019-08-24T14:15:22Z", "endOfValidity": "2019-08-24T14:15:22Z" }, "remainingDrivingTimes": { "daysOfReducedRest": { "total": 0, "maximum": 0, "minimum": 0, "remaining": 0 }, "dailyAmplitude": { "total": 0, "maximum": 0, "minimum": 0, "remaining": 0 }, "drivingTimeBelowMaximum": { "total": 0, "maximum": 0, "minimum": 0, "remaining": 0 }, "dailyDrivingTime": { "total": 0, "maximum": 0, "minimum": 0, "remaining": 0 }, "daysOfDrivingLongerThan9h": { "total": 0, "maximum": 0, "minimum": 0, "remaining": 0 }, "weeklyDrivingTime": { "total": 0, "maximum": 0, "minimum": 0, "remaining": 0 }, "BIWeeklyDrivingTime": { "total": 0, "maximum": 0, "minimum": 0, "remaining": 0 }, "daysOfConsecutiveDriving": { "total": 0, "maximum": 0, "minimum": 0, "remaining": 0 } }, "upcomingRestingTimes": { "week": 0, "year": 0, "upcomingRestingTime": 0 }, "languages": [ "string" ], "contactDetails": [ { "associationType": "inline" } ], "pricingModules": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "fixed", "name": "string", "sequenceNr": 0, "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 }, "taxRates": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "sequenceNr": 0, "name": "string", "description": "string", "taxRate": { "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", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true, "identifiers": [ null ] }, "filters": [ { "filters": [] } ] } ], "filters": [ { "selector": "string", "comparisonType": "equal", "value": "string", "linkType": "and", "filters": [ { "filters": [] } ], "sequenceNr": 0 } ], "oncePerInvoice": true, "targetEntityType": "fleetVehicle", "amount": 0.1 } ] }, "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": { "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": {}, "taxRate": { "identifiers": [] }, "inclusiveOfTax": true } } ], "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": [ { "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", "invoiceNumbering": 0, "quoteNumbering": 0 }, "pricingConfigurationCount": 0, "hasAgreedToPrice": true }, "actor": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "user": { "nonce": "string", "hasAgreedToPrice": true, "type": "user", "username": "string", "firstName": "string", "lastName": "string", "email": "string", "phone": "string", "passwordModified": "2019-08-24T14:15:22Z", "twoFactorAuthentication": true, "status": "DELETED", "loginMethod": "DEFAULT", "accountType": "default", "standardLoadingSize": 10, "timezone": "string", "vehicleGroups": [ { "nonce": "string", "name": "string", "vehicles": [ { "nonce": "string", "versionNumber": 0, "hasAgreedToPrice": true, "transportMode": "maritime", "loadCapacities": [ null ], "loadMeters": {}, "actors": [ null ], "legalStatistics": { "countryCabotageStatistics": {} }, "capacityContract": { "pricingModules": [], "consignments": [] }, "name": "string", "description": "string", "vin": "string", "licensePlate": "string", "vehicleType": "string", "emissionStandard": "euro0", "fuelCapacity": {}, "fuelType": "string", "maxLinks": 0, "length": {}, "height": {}, "width": {}, "loadLength": {}, "loadHeight": {}, "loadWidth": {}, "maxWeight": {}, "emptyWeight": {}, "operational": true, "attributes": [ null ] } ] } ] }, "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" } ], "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" } ] }, "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" } ], "notes": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "author": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "user", "username": "string", "avatar": { "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" }, "firstName": "string", "lastName": "string", "email": "string", "phone": "string", "passwordModified": "2019-08-24T14:15:22Z", "twoFactorAuthentication": true, "status": "DELETED", "loginMethod": "DEFAULT", "timezone": "string", "vehicleGroups": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "vehicles": [ { "loadCapacities": [], "actors": [], "attributes": [], "stackCapacities": [] } ] } ], "activeAdministration": { "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": { "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": [ {} ], "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": [ {} ], "locations": [ { "contactDetails": [], "constraints": [], "pricingElements": [], "externalAttributes": {} } ], "identification": [ {} ], "contactDetails": [ {} ], "contactPersons": [ {} ], "administration": {}, "pricingConfigurationCount": 0, "hasAgreedToPrice": true }, "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 }, "accountType": "default", "standardLoadingSize": 0 }, "name": "string", "text": "string" } ] }'
{ "success": true, "message": "string", "code": 0, "ban": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "chauffeur": { … }, "business": { … }, "actor": { … }, "identifiers": [ … ], "notes": [ … ] } }
curl -i -X POST \ https://docs.transportial.com/_mock/apis/ban \ -H 'Authorization: Bearer <YOUR_JWT_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "nonce": "string", "name": "string", "description": "string", "chauffeur": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "driver", "picture": { "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" }, "user": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "user", "username": "string", "avatar": { "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" }, "firstName": "string", "lastName": "string", "email": "string", "phone": "string", "passwordModified": "2019-08-24T14:15:22Z", "twoFactorAuthentication": true, "status": "DELETED", "loginMethod": "DEFAULT", "timezone": "string", "vehicleGroups": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "vehicles": [ { "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": [ null ], "length": {}, "height": {}, "width": {}, "loadLength": {}, "loadHeight": {}, "loadWidth": {}, "maxWeight": {}, "emptyWeight": {}, "loadMeters": {}, "operational": true, "actors": [ null ], "legalStatistics": { "countryCabotageStatistics": {} }, "capacityContract": { "pricingModules": [], "consignments": [] }, "attributes": [ null ], "stackCapacities": [ null ], "versionNumber": 0, "hasAgreedToPrice": true } ] } ], "activeAdministration": { "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": { "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": { "externalAttributes": {} } } ], "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": {}, "administrativeReference": {}, "contactDetails": [ null ], "constraints": [ null ], "pricingElements": [ null ], "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": {}, "pricingConfigurationCount": 0, "hasAgreedToPrice": true }, "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 }, "accountType": "default", "standardLoadingSize": 0 }, "firstName": "string", "lastName": "string", "dateOfBirth": "2019-08-24", "birthPlace": "string", "nationality": "string", "hourlyRate": { "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": [ { "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 }, "hoursPerMonth": 0.1, "adr": { "hasADR": true, "ADRNumber": "string", "ADRValidFromDate": "2019-08-24", "ADRExpirationDate": "2019-08-24", "ADRFiles": [ { "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" } ] }, "driverLicense": { "hasDriverLicense": true, "driverLicenseNumber": "string", "driverLicenseValidFromDate": "2019-08-24", "driverLicenseExpirationDate": "2019-08-24", "driverLicenseObtainedOn": "2019-08-24", "driverLicenseCountryOfIssue": "string", "driverLicenseIssuingAuthority": "string", "driverLicenseFiles": [ { "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" } ] }, "tachoCard": { "cardId": "string", "countryOfIssue": "string", "renewalIndex": "string", "replacementIndex": "string", "startOfValidity": "2019-08-24T14:15:22Z", "endOfValidity": "2019-08-24T14:15:22Z" }, "remainingDrivingTimes": { "daysOfReducedRest": { "total": 0, "maximum": 0, "minimum": 0, "remaining": 0 }, "dailyAmplitude": { "total": 0, "maximum": 0, "minimum": 0, "remaining": 0 }, "drivingTimeBelowMaximum": { "total": 0, "maximum": 0, "minimum": 0, "remaining": 0 }, "dailyDrivingTime": { "total": 0, "maximum": 0, "minimum": 0, "remaining": 0 }, "daysOfDrivingLongerThan9h": { "total": 0, "maximum": 0, "minimum": 0, "remaining": 0 }, "weeklyDrivingTime": { "total": 0, "maximum": 0, "minimum": 0, "remaining": 0 }, "BIWeeklyDrivingTime": { "total": 0, "maximum": 0, "minimum": 0, "remaining": 0 }, "daysOfConsecutiveDriving": { "total": 0, "maximum": 0, "minimum": 0, "remaining": 0 } }, "upcomingRestingTimes": { "week": 0, "year": 0, "upcomingRestingTime": 0 }, "languages": [ "string" ], "contactDetails": [ { "associationType": "inline" } ], "pricingModules": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "fixed", "name": "string", "sequenceNr": 0, "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 }, "taxRates": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "sequenceNr": 0, "name": "string", "description": "string", "taxRate": { "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", "description": "string", "jurisdiction": "string", "percentage": 0.1, "inclusive": true, "active": true, "identifiers": [ null ] }, "filters": [ { "filters": [] } ] } ], "filters": [ { "selector": "string", "comparisonType": "equal", "value": "string", "linkType": "and", "filters": [ { "filters": [] } ], "sequenceNr": 0 } ], "oncePerInvoice": true, "targetEntityType": "fleetVehicle", "amount": 0.1 } ] }, "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": { "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": {}, "taxRate": { "identifiers": [] }, "inclusiveOfTax": true } } ], "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": [ { "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", "invoiceNumbering": 0, "quoteNumbering": 0 }, "pricingConfigurationCount": 0, "hasAgreedToPrice": true }, "actor": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "user": { "nonce": "string", "hasAgreedToPrice": true, "type": "user", "username": "string", "firstName": "string", "lastName": "string", "email": "string", "phone": "string", "passwordModified": "2019-08-24T14:15:22Z", "twoFactorAuthentication": true, "status": "DELETED", "loginMethod": "DEFAULT", "accountType": "default", "standardLoadingSize": 10, "timezone": "string", "vehicleGroups": [ { "nonce": "string", "name": "string", "vehicles": [ { "nonce": "string", "versionNumber": 0, "hasAgreedToPrice": true, "transportMode": "maritime", "loadCapacities": [ null ], "loadMeters": {}, "actors": [ null ], "legalStatistics": { "countryCabotageStatistics": {} }, "capacityContract": { "pricingModules": [], "consignments": [] }, "name": "string", "description": "string", "vin": "string", "licensePlate": "string", "vehicleType": "string", "emissionStandard": "euro0", "fuelCapacity": {}, "fuelType": "string", "maxLinks": 0, "length": {}, "height": {}, "width": {}, "loadLength": {}, "loadHeight": {}, "loadWidth": {}, "maxWeight": {}, "emptyWeight": {}, "operational": true, "attributes": [ null ] } ] } ] }, "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" } ], "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" } ] }, "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" } ], "notes": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "author": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "type": "user", "username": "string", "avatar": { "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" }, "firstName": "string", "lastName": "string", "email": "string", "phone": "string", "passwordModified": "2019-08-24T14:15:22Z", "twoFactorAuthentication": true, "status": "DELETED", "loginMethod": "DEFAULT", "timezone": "string", "vehicleGroups": [ { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "vehicles": [ { "loadCapacities": [], "actors": [], "attributes": [], "stackCapacities": [] } ] } ], "activeAdministration": { "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": { "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": [ {} ], "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": [ {} ], "locations": [ { "contactDetails": [], "constraints": [], "pricingElements": [], "externalAttributes": {} } ], "identification": [ {} ], "contactDetails": [ {} ], "contactPersons": [ {} ], "administration": {}, "pricingConfigurationCount": 0, "hasAgreedToPrice": true }, "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 }, "accountType": "default", "standardLoadingSize": 0 }, "name": "string", "text": "string" } ] }'
{ "success": true, "message": "string", "code": 0, "ban": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "chauffeur": { … }, "business": { … }, "actor": { … }, "identifiers": [ … ], "notes": [ … ] } }
curl -i -X GET \ 'https://docs.transportial.com/_mock/apis/ban/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "ban": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "chauffeur": { … }, "business": { … }, "actor": { … }, "identifiers": [ … ], "notes": [ … ] } }
curl -i -X DELETE \ 'https://docs.transportial.com/_mock/apis/ban/{id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "ban": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "description": "string", "chauffeur": { … }, "business": { … }, "actor": { … }, "identifiers": [ … ], "notes": [ … ] } }
curl -i -X GET \ 'https://docs.transportial.com/_mock/apis/bans/actor/{id}/{offset}/{amount}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "bans": [ { … } ] }
curl -i -X GET \ 'https://docs.transportial.com/_mock/apis/bans/business/{id}/{offset}/{amount}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "bans": [ { … } ] }
curl -i -X GET \ 'https://docs.transportial.com/_mock/apis/bans/chauffeur/{id}/{offset}/{amount}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "bans": [ { … } ] }
curl -i -X GET \ 'https://docs.transportial.com/_mock/apis/bans/{offset}/{amount}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "bans": [ { … } ] }
curl -i -X POST \ 'https://docs.transportial.com/_mock/apis/bans/{offset}/{amount}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "bans": [ { … } ] }
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.