{ "openapi": "3.0.3", "info": { "title": "Driver API", "version": "2.0.70", "contact": { "name": "MendriX", "url": "https://www.mendrix.nl/" }, "description": "REST API documentation for driver / mobile app integrations.\n\nAll endpoints require a valid **driver** JWT bearer token.\n\nYou can also call these endpoints with an API token, but then you have to provide the `operatorId` query parameter." }, "paths": { "/driver-api/get-processed-mutations/": { "post": { "tags": [ "Get Processed Mutations" ], "summary": "mutations which have been processed by TMS", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TGetProcessedMutationIdsRequestBody" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TMutationResponse" } } } } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/rides/": { "get": { "tags": [ "Ride" ], "summary": "Rides", "description": "Get all planned rides for the operator.", "parameters": [ { "name": "operatorId", "in": "query", "description": "Operator to get the rides for. Required unless the driver token already carries an operator claim.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TRideResponse" } } } } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/goods/": { "get": { "tags": [ "Good" ], "summary": "Goods", "description": "Get goods that are available for the operator, by good ids.", "parameters": [ { "name": "operatorId", "in": "query", "description": "Operator to get the goods for. Required unless the driver token already carries an operator claim.", "required": false, "schema": { "type": "string" } }, { "name": "ids", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TGoodResponse" } } } } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] }, "post": { "tags": [ "Good" ], "summary": "Add a good by trace", "description": "Add a new Good to a task. The good is added as a return good or as an extra good based on the scan-trace type.", "parameters": [ { "name": "operatorId", "in": "query", "description": "Operator adding the good. Required unless the driver token already carries an operator claim.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TNewGood" } } } }, "responses": { "200": { "description": "" } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/vehicles/": { "get": { "tags": [ "Vehicles" ], "summary": "Vehicles", "description": "Get all available vehicles.", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TVehicleResponse" } } } } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/logo/{id}": { "get": { "tags": [ "Master Data" ], "summary": "Get logo by id", "description": "Get a logo by id from MendriX TMS.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TLogoResponse" } } } } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/settings/color-profile": { "get": { "tags": [ "Settings" ], "summary": "Color profile", "description": "Get the color profile for the app for this operator / company.", "parameters": [ { "name": "operatorId", "in": "query", "description": "Operator to get the color profile for. Required unless the driver token already carries an operator claim.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TColorProfileSetResponse" } } } } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/contacts": { "get": { "tags": [ "Master Data" ], "summary": "Contacts", "description": "Get the phone numbers important for drivers.", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TContactResponse" } } } } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/dossier/orders/{id}": { "get": { "tags": [ "Dossier" ], "summary": "Get a dossier", "description": "Get one dossier for the specified order (key).", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TDossierFolderResponse" } } } } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/trailers/": { "get": { "tags": [ "Trailers" ], "summary": "Trailers", "description": "Get all available Trailers.", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TTrailerResponse" } } } } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/dossier/orders/{id}/contents/{subpath}": { "get": { "tags": [ "Dossier" ], "summary": "Get a file content", "description": "Download a dossier file for the specified order (key) and subpath / filename.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subpath", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/dossier/rides": { "post": { "tags": [ "Dossier" ], "summary": "Upload file to rides", "description": "Upload a file to one or more rides. Headers: ids (CSV), name (string), type (damage|document|other|questionnaire)", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TDossierFileResponse" } } } } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/planning/": { "get": { "tags": [ "Planning" ], "summary": "Planning for the operator", "description": "Get all planned tasks, rides and goods in one planning object", "parameters": [ { "name": "operatorId", "in": "query", "description": "Operator to get the planning for. Required unless the driver token already carries an operator claim.", "required": false, "schema": { "type": "string" } }, { "name": "use", "in": "query", "description": "Internal/testing use only. Forces the legacy (pre-Next) planning data path. Do not use in production integrations; omit this parameter to use the current, better-performing implementation.", "required": false, "schema": { "type": "string", "enum": [ "legacy" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TPlanningResponse" } } } } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/tracking-positions/": { "post": { "tags": [ "Tracking Position" ], "summary": "Add tracking position", "description": "Add a tracking position for an operator.", "parameters": [ { "name": "operatorId", "in": "query", "description": "Operator the tracking position belongs to. Required unless the driver token already carries an operator claim.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TTrackingPosition" } } } }, "responses": { "200": { "description": "" } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/trace-types": { "get": { "tags": [ "Master Data" ], "summary": "Trace types", "description": "Get the trace types for scanning goods.", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TTraceTypeResponse" } } } } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/packaging": { "get": { "tags": [ "Master Data" ], "summary": "Packaging", "description": "Get the packaging and carriers.", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TPackagingResponse" } } } } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/activity-changes/": { "post": { "tags": [ "Activity Changes" ], "summary": "Store activity change", "description": "Store an activity change for an operator. If a second operator is set (operatorIdSecond > 0), the activity change is also stored for that operator.", "parameters": [ { "name": "operatorId", "in": "query", "description": "Operator the activity change is stored for. Required unless the driver token already carries an operator claim.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TActivityChange" } } } }, "responses": { "200": { "description": "" } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/settings/": { "get": { "tags": [ "Settings" ], "summary": "general mobile settings", "description": "Get general settings from MendriX TMS.", "parameters": [ { "name": "operatorId", "in": "query", "description": "Operator to get the settings for. Required unless the driver token already carries an operator claim.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TSettingsResponse" } } } } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/chat/messages": { "get": { "tags": [ "Chat Messages" ], "summary": "Chat-messages", "description": "Get chat-messages.", "parameters": [ { "name": "operatorId", "in": "query", "description": "Operator to get the chat-messages for. Required unless the driver token already carries an operator claim.", "required": false, "schema": { "type": "string" } }, { "name": "fromMoment", "in": "query", "required": true, "schema": { "format": "ISO 8601", "type": "string" } }, { "name": "toMoment", "in": "query", "required": true, "schema": { "format": "ISO 8601", "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TChatMessageResponse" } } } } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] }, "post": { "tags": [ "Chat Messages" ], "summary": "Send chat-message", "description": "Send a new chat-message.", "parameters": [ { "name": "operatorId", "in": "query", "description": "Operator sending the message. Required unless the driver token already carries an operator claim.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TChatMessage" } } } }, "responses": { "200": { "description": "" } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/activities/": { "get": { "tags": [ "Activities" ], "summary": "Activities", "description": "Get the list of activities available for drivers (MobileEnabled activities only).", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TActivityResponse" } } } } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/completion-statuses": { "get": { "tags": [ "Master Data" ], "summary": "CompletionStatuses", "description": "Get the completion statuses for tasks.", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TCompletionStatusResponse" } } } } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/tasks/": { "get": { "tags": [ "Task" ], "summary": "Tasks", "description": "Get all planned tasks for the operator.", "parameters": [ { "name": "operatorId", "in": "query", "description": "Operator to get the tasks for. Required unless the driver token already carries an operator claim.", "required": false, "schema": { "type": "string" } }, { "name": "ids", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TTaskResponse" } } } } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/clients/packaging-balances": { "get": { "tags": [ "Client" ], "summary": "Packaging balances by client ids", "description": "Get packaging balances by client ids.", "parameters": [ { "name": "operatorId", "in": "query", "description": "Operator to get the packaging balances for. Required unless the driver token already carries an operator claim.", "required": false, "schema": { "type": "string" } }, { "name": "ids", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TPackagingBalanceListClientResponse" } } } } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/vehicles/{id}/refueling-stops": { "post": { "tags": [ "Vehicles" ], "summary": "Refueling stop", "description": "Register a refueling stop for a vehicle.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "operatorId", "in": "query", "description": "Operator registering the refueling stop. Required unless the driver token already carries an operator claim.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TRefuelingStop" } } } }, "responses": { "200": { "description": "" } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/goods/{id}/scan-traces": { "post": { "tags": [ "Good" ], "summary": "Add a scan-trace to a good", "description": "Add a scan-trace to a good.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "operatorId", "in": "query", "description": "Operator adding the scan-trace. Required unless the driver token already carries an operator claim.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TScanTrace" } } } }, "responses": { "200": { "description": "" } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/chat/contacts": { "get": { "tags": [ "Chat Contacts" ], "summary": "Chat-contacts", "description": "Get chat-contacts.", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TChatContactResponse" } } } } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/tasks/packaging-balances": { "get": { "tags": [ "Task" ], "summary": "Packaging balances by task ids", "description": "Get packaging balances by task ids.", "parameters": [ { "name": "operatorId", "in": "query", "description": "Operator to get the packaging balances for. Required unless the driver token already carries an operator claim.", "required": false, "schema": { "type": "string" } }, { "name": "ids", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TPackagingBalanceListTaskResponse" } } } } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/chat/messages/{id}/confirm": { "post": { "tags": [ "Chat Messages" ], "summary": "Confirm chat-message", "description": "Explicitly confirm a chat-message as read.", "parameters": [ { "name": "operatorId", "in": "query", "description": "Operator confirming the message. Required unless the driver token already carries an operator claim.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TChatMessage" } } } }, "responses": { "200": { "description": "" } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/questionnaires/{id}/answers": { "post": { "tags": [ "Questionnaires" ], "summary": "Submit questionnaire response", "description": "Submit a completed questionnaire with answers.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TQuestionnaireAnswers" } } } }, "responses": { "200": { "description": "" } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/settings/version": { "get": { "tags": [ "Settings" ], "summary": "MendriX TMS version", "description": "Get the MendriX TMS version.", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TVersionResponse" } } } } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/devices/{hardwareCode}": { "put": { "tags": [ "Mobile Device" ], "summary": "Update or create mobile device", "description": "Update or create a mobile device information by hardware code.", "parameters": [ { "name": "operatorId", "in": "query", "description": "Operator the device belongs to. Required unless the driver token already carries an operator claim.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TMobileDeviceRequest" } } } }, "responses": { "200": { "description": "" } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/dossier/tasks": { "post": { "tags": [ "Dossier" ], "summary": "Upload file to tasks", "description": "Upload a file to one or more tasks. Headers: ids (CSV), name (string), type (damage|document|other|questionnaire)", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TDossierFileResponse" } } } } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/rides/{id}": { "patch": { "tags": [ "Ride" ], "summary": "Update ride (start or end)", "description": "Update a ride (start or end).", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "operatorId", "in": "query", "description": "Operator performing the update. Required unless the driver token already carries an operator claim.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TRideUpdate" } } } }, "responses": { "200": { "description": "" } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/tasks/{id}": { "patch": { "tags": [ "Task" ], "summary": "Update task", "description": "Update a task, e.g. to start or complete a task.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "operatorId", "in": "query", "description": "Operator performing the update. Required unless the driver token already carries an operator claim.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TTaskUpdate" } } } }, "responses": { "200": { "description": "" } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/questionnaires/": { "get": { "tags": [ "Questionnaires" ], "summary": "Questionnaires", "description": "Get the complete questionnaire JSON.", "parameters": [ { "name": "latest", "in": "query", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TQuestionnaireResponse" } } } } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } }, "/driver-api/settings/push-registrations": { "post": { "tags": [ "Settings" ], "summary": "Refueling stop", "description": "Register a refueling stop for a vehicle.", "parameters": [ { "name": "operatorId", "in": "query", "description": "Operator registering the device. Required unless the driver token already carries an operator claim.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Driver API service - TPushRegistration" } } } }, "responses": { "200": { "description": "" } }, "x-token-types": [ "driver", "apitoken" ], "x-audiences": [ "external", "driver" ] } } }, "components": { "schemas": { "Driver API service - TTrailerResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "type": "object", "properties": { "licensePlate": { "type": "string" }, "id": { "type": "string", "description": "Unique identifier" } } } }, "itemCount": { "type": "integer", "format": "int32" } } } } }, "Driver API service - TTraceTypeResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "percentage": { "type": "integer", "format": "int32" }, "color": { "type": "integer", "format": "int32" }, "id": { "type": "string", "description": "Unique identifier" } } } }, "itemCount": { "type": "integer", "format": "int32" } } } } }, "Driver API service - TPackagingBalanceListClientResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "type": "object", "properties": { "clientId": { "type": "string" }, "packagingBalances": { "type": "array", "items": { "type": "object", "properties": { "packagingId": { "type": "string" }, "balance": { "type": "number", "format": "double" } } } } } } }, "itemCount": { "type": "integer", "format": "int32" } } } } }, "Driver API service - TQuestionnaireAnswers": { "type": "object", "properties": { "triggerQuestionKey": { "type": "string" }, "taskIds": { "type": "array", "items": { "type": "string" } }, "rideId": { "type": "string" }, "goodId": { "type": "string" }, "traceTypeId": { "type": "string" }, "completedAt": { "type": "string", "format": "date-time" }, "answers": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "answerType": { "type": "string" }, "value": { "type": "string" } } } } } }, "Driver API service - TColorProfileSetResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "type": "object", "properties": { "light": { "type": "object", "properties": { "primaryBackground": { "type": "string" }, "primaryText": { "type": "string" }, "secondaryBackground": { "type": "string" }, "secondaryText": { "type": "string" }, "highlight": { "type": "string" } } }, "dark": { "type": "object", "properties": { "primaryBackground": { "type": "string" }, "primaryText": { "type": "string" }, "secondaryBackground": { "type": "string" }, "secondaryText": { "type": "string" }, "highlight": { "type": "string" } } } } } }, "itemCount": { "type": "integer", "format": "int32" } } } } }, "Driver API service - TTaskResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "format": "int32" }, "rideId": { "type": "integer", "format": "int32", "nullable": true }, "trailerId": { "type": "integer", "format": "int32", "nullable": true }, "requested": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "nullable": true }, "end": { "type": "string", "format": "date-time", "nullable": true } } }, "planned": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "nullable": true }, "end": { "type": "string", "format": "date-time", "nullable": true } } }, "type": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "isStart": { "type": "boolean" }, "isEnd": { "type": "boolean" }, "activityId": { "type": "integer", "format": "int32" }, "id": { "type": "string", "description": "Unique identifier" } } }, "cashOnDelivery": { "type": "number", "format": "double" }, "client": { "type": "object", "properties": { "name": { "type": "string" }, "phone": { "type": "string" }, "categories": { "type": "string" }, "id": { "type": "string", "description": "Unique identifier" } } }, "address": { "type": "object", "properties": { "name": { "type": "string" }, "contact": { "type": "string" }, "street": { "type": "string" }, "houseNumber": { "type": "string" }, "postalCode": { "type": "string" }, "premise": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" } } }, "phone": { "type": "string" }, "mobile": { "type": "string" }, "annotation": { "type": "string" }, "location": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } } } } }, "siteLocation": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } } }, "completion": { "type": "object", "properties": { "when": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "nullable": true }, "end": { "type": "string", "format": "date-time", "nullable": true } } }, "completionStatusId": { "type": "integer", "format": "int32", "nullable": true }, "contactName": { "type": "string" }, "comments": { "type": "string" }, "signature": { "type": "string" }, "packagingTransactions": { "type": "array", "items": { "type": "object", "properties": { "packagingId": { "type": "string" }, "collected": { "type": "integer", "format": "int32" }, "delivered": { "type": "integer", "format": "int32" }, "id": { "type": "string", "description": "Unique identifier" } } } }, "location": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } } } } }, "status": { "type": "string", "enum": [ "notStarted", "started", "completed", "cancelled" ] }, "instructions": { "type": "string" }, "information": { "type": "string" }, "referenceInternal": { "type": "string" }, "referenceExternal": { "type": "string" }, "goods": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier" } } } }, "order": { "type": "object", "properties": { "product": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string", "description": "Unique identifier" } } }, "categories": { "type": "string" }, "id": { "type": "string", "description": "Unique identifier" } } }, "taskSettings": { "type": "object", "properties": { "canEditReference": { "type": "boolean" }, "hideAfterMinutes": { "type": "integer", "format": "int32" }, "showPackagingBalancePerAddress": { "type": "boolean" }, "showPackagingBalancePerClient": { "type": "boolean" }, "canEditPackagingTransactions": { "type": "boolean" }, "taskListTemplate": { "type": "string" }, "contactNameMandatory": { "type": "boolean" }, "signatureMandatory": { "type": "boolean" }, "pictureMandatory": { "type": "boolean" }, "chooseCompletionStatusMandatory": { "type": "boolean" }, "scanAllGoodsMandatory": { "type": "boolean" }, "scanAllGoodsNonComplianceAction": { "type": "string", "enum": [ "continue", "warn", "block" ] }, "autoCompleteTaskWhenAllIsScanned": { "type": "boolean" }, "flow": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "enterContactName", "askForSignature", "scanGoods", "takePicture", "registerPackagingTransactions", "handleCashOnDelivery" ] }, "isMandatory": { "type": "boolean" } } } }, "logoId": { "type": "integer", "format": "int32", "nullable": true }, "finalDeliveryDate": { "type": "string", "format": "date-time", "nullable": true } } }, "goodSettings": { "type": "object", "properties": { "canEditAmount": { "type": "boolean" }, "canEditPackaging": { "type": "boolean" }, "defaultTraceTypeId": { "type": "integer", "format": "int32", "nullable": true }, "alternativeTraceTypeIds": { "type": "object", "properties": { "capacity": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } } }, "allTraceTypeIdsValidForCompletion": { "type": "object", "properties": { "capacity": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } } }, "returnTraceTypeId": { "type": "integer", "format": "int32", "nullable": true }, "addGoodToOrderTraceTypeId": { "type": "integer", "format": "int32", "nullable": true } } }, "id": { "type": "string", "description": "Unique identifier" } } } }, "itemCount": { "type": "integer", "format": "int32" } } } } }, "Driver API service - TRideResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "vehicleId": { "type": "string" }, "materialId": { "type": "string" }, "materialId2": { "type": "string" }, "materialId3": { "type": "string" }, "materialIds": { "type": "object", "properties": { "capacity": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } } }, "driverId": { "type": "integer", "format": "int32", "nullable": true }, "coDriverId": { "type": "integer", "format": "int32", "nullable": true }, "notes": { "type": "string" }, "tasks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier" } } } }, "start": { "type": "object", "properties": { "planned": { "type": "string", "format": "date-time" }, "actual": { "type": "string", "format": "date-time", "nullable": true }, "address": { "type": "object", "properties": { "name": { "type": "string" }, "contact": { "type": "string" }, "street": { "type": "string" }, "houseNumber": { "type": "string" }, "postalCode": { "type": "string" }, "premise": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" } } }, "phone": { "type": "string" }, "mobile": { "type": "string" }, "annotation": { "type": "string" }, "location": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } } } } }, "mileage": { "type": "number", "format": "double", "nullable": true } } }, "end": { "type": "object", "properties": { "planned": { "type": "string", "format": "date-time" }, "actual": { "type": "string", "format": "date-time", "nullable": true }, "address": { "type": "object", "properties": { "name": { "type": "string" }, "contact": { "type": "string" }, "street": { "type": "string" }, "houseNumber": { "type": "string" }, "postalCode": { "type": "string" }, "premise": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" } } }, "phone": { "type": "string" }, "mobile": { "type": "string" }, "annotation": { "type": "string" }, "location": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } } } } }, "mileage": { "type": "number", "format": "double", "nullable": true } } }, "settings": { "type": "object", "properties": { "askMileage": { "type": "boolean" } } }, "id": { "type": "string", "description": "Unique identifier" } } } }, "itemCount": { "type": "integer", "format": "int32" } } } } }, "Driver API service - TGoodResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "type": "object", "properties": { "barcode": { "type": "string" }, "articleNumber": { "type": "string" }, "packagingId": { "type": "string" }, "packagingName": { "type": "string" }, "adrUnitOfMeasure": { "type": "string" }, "parts": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "totalWeight": { "type": "number", "format": "double", "nullable": true }, "netWeight": { "type": "number", "format": "double", "nullable": true }, "loadingMeters": { "type": "number", "format": "double" }, "totalVolume": { "type": "number", "format": "double", "nullable": true }, "volumeInLiters": { "type": "number", "format": "double", "nullable": true }, "dimensions": { "type": "object", "properties": { "width": { "type": "number", "format": "double" }, "height": { "type": "number", "format": "double" }, "depth": { "type": "number", "format": "double" } } }, "lastScanTrace": { "type": "object", "properties": { "traceTypeId": { "type": "string" } } }, "packagingTransactions": { "type": "array", "items": { "type": "object", "properties": { "packagingId": { "type": "string" }, "collected": { "type": "integer", "format": "int32" }, "delivered": { "type": "integer", "format": "int32" }, "id": { "type": "string", "description": "Unique identifier" } } } }, "senderAddress": { "type": "object", "properties": { "name": { "type": "string" }, "contact": { "type": "string" }, "street": { "type": "string" }, "houseNumber": { "type": "string" }, "postalCode": { "type": "string" }, "premise": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" } } }, "phone": { "type": "string" }, "mobile": { "type": "string" }, "annotation": { "type": "string" }, "location": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } } } } }, "receiverAddress": { "type": "object", "properties": { "name": { "type": "string" }, "contact": { "type": "string" }, "street": { "type": "string" }, "houseNumber": { "type": "string" }, "postalCode": { "type": "string" }, "premise": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" } } }, "phone": { "type": "string" }, "mobile": { "type": "string" }, "annotation": { "type": "string" }, "location": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } } } } }, "characteristics": { "type": "array", "items": { "type": "string", "enum": [ "age18", "noNextDoor", "confidential", "adr", "dryAmbient", "cool", "freeze", "deepFreeze" ] } }, "adr": { "type": "object", "properties": { "unCode": { "type": "string" }, "importDate": { "type": "string", "format": "date-time" }, "name": { "type": "object", "properties": { "nl": { "type": "string" }, "en": { "type": "string" }, "de": { "type": "string" }, "fr": { "type": "string" } } }, "class": { "type": "string" }, "classification": { "type": "string" }, "packingGroup": { "type": "string" }, "labels": { "type": "string" }, "specialProvisions": { "type": "string" }, "transportationCategory": { "type": "integer", "format": "int32" }, "tunnelCode": { "type": "string" }, "dangerCode": { "type": "string" }, "multiplyFactor": { "type": "integer", "format": "int32" }, "id": { "type": "string", "description": "Unique identifier" } } }, "counterPartTaskIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "id": { "type": "string", "description": "Unique identifier" } } } }, "itemCount": { "type": "integer", "format": "int32" } } } } }, "Driver API service - TLogoResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "type": "object", "properties": { "base64": { "type": "string" }, "imageType": { "type": "string", "enum": [ "png", "jpeg", "gif", "bmp", "svg" ] }, "id": { "type": "string", "description": "Unique identifier" } } } }, "itemCount": { "type": "integer", "format": "int32" } } } } }, "Driver API service - TTrackingPosition": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" }, "moment": { "type": "string", "format": "date-time" }, "speed": { "type": "number", "format": "double" }, "direction": { "type": "number", "format": "double" }, "rideId": { "type": "integer", "format": "int32", "nullable": true }, "operatorId": { "type": "string" }, "hardwareCode": { "type": "string" } } }, "Driver API service - TPushRegistration": { "type": "object", "properties": { "token": { "type": "string" }, "platform": { "type": "string", "enum": [ "android", "ios" ] }, "company": { "type": "string" }, "hardwareCode": { "type": "string" } } }, "Driver API service - TChatContactResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string", "description": "Unique identifier" } } } }, "itemCount": { "type": "integer", "format": "int32" } } } } }, "Driver API service - TVehicleResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "brand": { "type": "string" }, "model": { "type": "string" }, "mileage": { "type": "integer", "format": "int32" }, "licensePlate": { "type": "string" }, "categories": { "type": "string" }, "id": { "type": "string", "description": "Unique identifier" } } } }, "itemCount": { "type": "integer", "format": "int32" } } } } }, "Driver API service - TActivityChange": { "type": "object", "properties": { "activityId": { "type": "integer", "format": "int32" }, "moment": { "type": "string" }, "floatingBeforeMoment": { "type": "boolean" }, "explicitChosen": { "type": "boolean" }, "operatorId": { "type": "string" }, "secondOperatorId": { "type": "integer", "format": "int32", "nullable": true }, "mobileDeviceCode": { "type": "string" }, "orderedBy": { "type": "integer", "format": "int64", "nullable": true }, "shiftBeginNew": { "type": "boolean" }, "taskId": { "type": "integer", "format": "int32", "nullable": true }, "rideId": { "type": "integer", "format": "int32", "nullable": true }, "vehicleId": { "type": "integer", "format": "int32", "nullable": true }, "position": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } } } } }, "Driver API service - TActivityResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "nameEN": { "type": "string" }, "color": { "type": "integer", "format": "int32" }, "orderedBy": { "type": "integer", "format": "int32" }, "dynafleetActivityName": { "type": "string" }, "flagProfit": { "type": "boolean" }, "flagWorked": { "type": "boolean" }, "flagDriving": { "type": "boolean" }, "flagShiftEnding": { "type": "boolean" }, "flagIllness": { "type": "boolean" }, "flagVacation": { "type": "boolean" }, "flagOutOfOfficeExtraCharge": { "type": "boolean" }, "flagNightExtraCharge": { "type": "boolean" }, "id": { "type": "string", "description": "Unique identifier" } } } }, "itemCount": { "type": "integer", "format": "int32" } } } } }, "Driver API service - TPlanningResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "type": "object", "properties": { "tasks": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "format": "int32" }, "rideId": { "type": "integer", "format": "int32", "nullable": true }, "trailerId": { "type": "integer", "format": "int32", "nullable": true }, "requested": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "nullable": true }, "end": { "type": "string", "format": "date-time", "nullable": true } } }, "planned": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "nullable": true }, "end": { "type": "string", "format": "date-time", "nullable": true } } }, "type": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "isStart": { "type": "boolean" }, "isEnd": { "type": "boolean" }, "activityId": { "type": "integer", "format": "int32" }, "id": { "type": "string", "description": "Unique identifier" } } }, "cashOnDelivery": { "type": "number", "format": "double" }, "client": { "type": "object", "properties": { "name": { "type": "string" }, "phone": { "type": "string" }, "categories": { "type": "string" }, "id": { "type": "string", "description": "Unique identifier" } } }, "address": { "type": "object", "properties": { "name": { "type": "string" }, "contact": { "type": "string" }, "street": { "type": "string" }, "houseNumber": { "type": "string" }, "postalCode": { "type": "string" }, "premise": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" } } }, "phone": { "type": "string" }, "mobile": { "type": "string" }, "annotation": { "type": "string" }, "location": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } } } } }, "siteLocation": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } } }, "completion": { "type": "object", "properties": { "when": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "nullable": true }, "end": { "type": "string", "format": "date-time", "nullable": true } } }, "completionStatusId": { "type": "integer", "format": "int32", "nullable": true }, "contactName": { "type": "string" }, "comments": { "type": "string" }, "signature": { "type": "string" }, "packagingTransactions": { "type": "array", "items": { "type": "object", "properties": { "packagingId": { "type": "string" }, "collected": { "type": "integer", "format": "int32" }, "delivered": { "type": "integer", "format": "int32" }, "id": { "type": "string", "description": "Unique identifier" } } } }, "location": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } } } } }, "status": { "type": "string", "enum": [ "notStarted", "started", "completed", "cancelled" ] }, "instructions": { "type": "string" }, "information": { "type": "string" }, "referenceInternal": { "type": "string" }, "referenceExternal": { "type": "string" }, "goods": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier" } } } }, "order": { "type": "object", "properties": { "product": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string", "description": "Unique identifier" } } }, "categories": { "type": "string" }, "id": { "type": "string", "description": "Unique identifier" } } }, "taskSettings": { "type": "object", "properties": { "canEditReference": { "type": "boolean" }, "hideAfterMinutes": { "type": "integer", "format": "int32" }, "showPackagingBalancePerAddress": { "type": "boolean" }, "showPackagingBalancePerClient": { "type": "boolean" }, "canEditPackagingTransactions": { "type": "boolean" }, "taskListTemplate": { "type": "string" }, "contactNameMandatory": { "type": "boolean" }, "signatureMandatory": { "type": "boolean" }, "pictureMandatory": { "type": "boolean" }, "chooseCompletionStatusMandatory": { "type": "boolean" }, "scanAllGoodsMandatory": { "type": "boolean" }, "scanAllGoodsNonComplianceAction": { "type": "string", "enum": [ "continue", "warn", "block" ] }, "autoCompleteTaskWhenAllIsScanned": { "type": "boolean" }, "flow": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "enterContactName", "askForSignature", "scanGoods", "takePicture", "registerPackagingTransactions", "handleCashOnDelivery" ] }, "isMandatory": { "type": "boolean" } } } }, "logoId": { "type": "integer", "format": "int32", "nullable": true }, "finalDeliveryDate": { "type": "string", "format": "date-time", "nullable": true } } }, "goodSettings": { "type": "object", "properties": { "canEditAmount": { "type": "boolean" }, "canEditPackaging": { "type": "boolean" }, "defaultTraceTypeId": { "type": "integer", "format": "int32", "nullable": true }, "alternativeTraceTypeIds": { "type": "object", "properties": { "capacity": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } } }, "allTraceTypeIdsValidForCompletion": { "type": "object", "properties": { "capacity": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } } }, "returnTraceTypeId": { "type": "integer", "format": "int32", "nullable": true }, "addGoodToOrderTraceTypeId": { "type": "integer", "format": "int32", "nullable": true } } }, "id": { "type": "string", "description": "Unique identifier" } } } }, "rides": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "vehicleId": { "type": "string" }, "materialId": { "type": "string" }, "materialId2": { "type": "string" }, "materialId3": { "type": "string" }, "materialIds": { "type": "object", "properties": { "capacity": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } } }, "driverId": { "type": "integer", "format": "int32", "nullable": true }, "coDriverId": { "type": "integer", "format": "int32", "nullable": true }, "notes": { "type": "string" }, "tasks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier" } } } }, "start": { "type": "object", "properties": { "planned": { "type": "string", "format": "date-time" }, "actual": { "type": "string", "format": "date-time", "nullable": true }, "address": { "type": "object", "properties": { "name": { "type": "string" }, "contact": { "type": "string" }, "street": { "type": "string" }, "houseNumber": { "type": "string" }, "postalCode": { "type": "string" }, "premise": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" } } }, "phone": { "type": "string" }, "mobile": { "type": "string" }, "annotation": { "type": "string" }, "location": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } } } } }, "mileage": { "type": "number", "format": "double", "nullable": true } } }, "end": { "type": "object", "properties": { "planned": { "type": "string", "format": "date-time" }, "actual": { "type": "string", "format": "date-time", "nullable": true }, "address": { "type": "object", "properties": { "name": { "type": "string" }, "contact": { "type": "string" }, "street": { "type": "string" }, "houseNumber": { "type": "string" }, "postalCode": { "type": "string" }, "premise": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" } } }, "phone": { "type": "string" }, "mobile": { "type": "string" }, "annotation": { "type": "string" }, "location": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } } } } }, "mileage": { "type": "number", "format": "double", "nullable": true } } }, "settings": { "type": "object", "properties": { "askMileage": { "type": "boolean" } } }, "id": { "type": "string", "description": "Unique identifier" } } } }, "goods": { "type": "array", "items": { "type": "object", "properties": { "barcode": { "type": "string" }, "articleNumber": { "type": "string" }, "packagingId": { "type": "string" }, "packagingName": { "type": "string" }, "adrUnitOfMeasure": { "type": "string" }, "parts": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "totalWeight": { "type": "number", "format": "double", "nullable": true }, "netWeight": { "type": "number", "format": "double", "nullable": true }, "loadingMeters": { "type": "number", "format": "double" }, "totalVolume": { "type": "number", "format": "double", "nullable": true }, "volumeInLiters": { "type": "number", "format": "double", "nullable": true }, "dimensions": { "type": "object", "properties": { "width": { "type": "number", "format": "double" }, "height": { "type": "number", "format": "double" }, "depth": { "type": "number", "format": "double" } } }, "lastScanTrace": { "type": "object", "properties": { "traceTypeId": { "type": "string" } } }, "packagingTransactions": { "type": "array", "items": { "type": "object", "properties": { "packagingId": { "type": "string" }, "collected": { "type": "integer", "format": "int32" }, "delivered": { "type": "integer", "format": "int32" }, "id": { "type": "string", "description": "Unique identifier" } } } }, "senderAddress": { "type": "object", "properties": { "name": { "type": "string" }, "contact": { "type": "string" }, "street": { "type": "string" }, "houseNumber": { "type": "string" }, "postalCode": { "type": "string" }, "premise": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" } } }, "phone": { "type": "string" }, "mobile": { "type": "string" }, "annotation": { "type": "string" }, "location": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } } } } }, "receiverAddress": { "type": "object", "properties": { "name": { "type": "string" }, "contact": { "type": "string" }, "street": { "type": "string" }, "houseNumber": { "type": "string" }, "postalCode": { "type": "string" }, "premise": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" } } }, "phone": { "type": "string" }, "mobile": { "type": "string" }, "annotation": { "type": "string" }, "location": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } } } } }, "characteristics": { "type": "array", "items": { "type": "string", "enum": [ "age18", "noNextDoor", "confidential", "adr", "dryAmbient", "cool", "freeze", "deepFreeze" ] } }, "adr": { "type": "object", "properties": { "unCode": { "type": "string" }, "importDate": { "type": "string", "format": "date-time" }, "name": { "type": "object", "properties": { "nl": { "type": "string" }, "en": { "type": "string" }, "de": { "type": "string" }, "fr": { "type": "string" } } }, "class": { "type": "string" }, "classification": { "type": "string" }, "packingGroup": { "type": "string" }, "labels": { "type": "string" }, "specialProvisions": { "type": "string" }, "transportationCategory": { "type": "integer", "format": "int32" }, "tunnelCode": { "type": "string" }, "dangerCode": { "type": "string" }, "multiplyFactor": { "type": "integer", "format": "int32" }, "id": { "type": "string", "description": "Unique identifier" } } }, "counterPartTaskIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "id": { "type": "string", "description": "Unique identifier" } } } } } } }, "itemCount": { "type": "integer", "format": "int32" } } } } }, "Driver API service - TPackagingBalanceListTaskResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "type": "object", "properties": { "taskId": { "type": "string" }, "packagingBalances": { "type": "array", "items": { "type": "object", "properties": { "packagingId": { "type": "string" }, "balance": { "type": "number", "format": "double" } } } } } } }, "itemCount": { "type": "integer", "format": "int32" } } } } }, "Driver API service - TContactResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "number": { "type": "string" } } } }, "itemCount": { "type": "integer", "format": "int32" } } } } }, "Driver API service - TTaskUpdate": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "notStarted", "started", "completed", "cancelled" ] }, "referenceInternal": { "type": "string", "nullable": true }, "referenceExternal": { "type": "string", "nullable": true }, "completion": { "type": "object", "properties": { "when": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time", "nullable": true }, "end": { "type": "string", "format": "date-time", "nullable": true } } }, "completionStatusId": { "type": "integer", "format": "int32", "nullable": true }, "contactName": { "type": "string", "nullable": true }, "comments": { "type": "string", "nullable": true }, "signature": { "type": "string", "nullable": true }, "packagingTransactions": { "type": "array", "items": { "type": "object", "properties": { "packagingId": { "type": "string" }, "collected": { "type": "integer", "format": "int32" }, "delivered": { "type": "integer", "format": "int32" }, "id": { "type": "string", "description": "Unique identifier" } } } }, "location": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } } } } }, "updatedGoods": { "type": "array", "items": { "type": "object", "properties": { "packagingId": { "type": "integer", "format": "int32", "nullable": true }, "parts": { "type": "integer", "format": "int32", "nullable": true }, "characteristics": { "type": "array", "items": { "type": "string", "enum": [ "age18", "noNextDoor", "confidential", "adr", "dryAmbient", "cool", "freeze", "deepFreeze" ] } }, "id": { "type": "string", "description": "Unique identifier" } } } }, "trailerId": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "string", "description": "Unique identifier" } } }, "Driver API service - TRideUpdate": { "type": "object", "properties": { "start": { "type": "object", "properties": { "actual": { "type": "string", "format": "date-time" }, "mileage": { "type": "number", "format": "double", "nullable": true } } }, "end": { "type": "object", "properties": { "actual": { "type": "string", "format": "date-time" }, "mileage": { "type": "number", "format": "double", "nullable": true } } }, "id": { "type": "string", "description": "Unique identifier" } } }, "Driver API service - TMutationResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "type": "object", "properties": { "operatorId": { "type": "integer", "format": "int32" }, "status": { "type": "string", "enum": [ "ok", "fail" ] }, "processedAt": { "type": "string", "format": "date-time" }, "id": { "type": "string", "description": "Unique identifier" } } } }, "itemCount": { "type": "integer", "format": "int32" } } } } }, "Driver API service - TNewGood": { "type": "object", "properties": { "barcode": { "type": "string" }, "taskId": { "type": "string" }, "scanTrace": { "type": "object", "properties": { "traceTypeId": { "type": "string" }, "moment": { "type": "string", "format": "date-time" }, "location": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } } } } } } }, "Driver API service - TScanTrace": { "type": "object", "properties": { "traceTypeId": { "type": "string" }, "moment": { "type": "string", "format": "date-time" }, "location": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } } } } }, "Driver API service - TSettingsResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "type": "object", "properties": { "chatEnabled": { "type": "boolean" }, "consolidateTasksEnabled": { "type": "boolean" }, "alwaysHideCompletedTasks": { "type": "boolean" }, "taskOrderIsMandatory": { "type": "boolean" }, "trackingEnabled": { "type": "boolean" }, "rememberPassword": { "type": "boolean" }, "taskConsolidationFields": { "type": "object", "properties": { "capacity": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } } }, "taskListTemplate": { "type": "string" }, "pictureSettings": { "type": "object", "properties": { "targetWidth": { "type": "integer", "format": "int32" }, "targetHeight": { "type": "integer", "format": "int32" }, "quality": { "type": "integer", "format": "int32" } } }, "defaultVehicleId": { "type": "integer", "format": "int32", "nullable": true }, "operatorId": { "type": "integer", "format": "int32", "nullable": true }, "depotId": { "type": "integer", "format": "int32", "nullable": true }, "locationUpdatesEnabled": { "type": "boolean" }, "locationUpdatesIntervalSeconds": { "type": "integer", "format": "int32" }, "logoId": { "type": "integer", "format": "int32", "nullable": true }, "scanUnknownBarcodesAsArticleNumbers": { "type": "boolean" }, "scanWithoutNewLineCharacter": { "type": "boolean" }, "articleNumberIdentifierMatchPattern": { "type": "string" }, "depotLoadScanningEnabled": { "type": "boolean" }, "depotPreloadingEnabled": { "type": "boolean" }, "defaultPackageId": { "type": "integer", "format": "int32", "nullable": true }, "devicesArePersonal": { "type": "boolean" }, "workHoursSettings": { "type": "object", "properties": { "registerActivitiesEnabled": { "type": "boolean" }, "loginModeForShiftNextDay": { "type": "string", "enum": [ "askUser", "startNewShift", "continueShift" ] }, "registerSecondOperator": { "type": "boolean" }, "activityLoadId": { "type": "integer", "format": "int32" }, "activityUnloadId": { "type": "integer", "format": "int32" }, "activityDriveId": { "type": "integer", "format": "int32" }, "drivingDetectionDelaySeconds": { "type": "integer", "format": "int32" }, "stoppedDetectionDelaySeconds": { "type": "integer", "format": "int32" }, "minimalDrivingSpeedMps": { "type": "integer", "format": "int32" }, "durationForAverageDrivingSpeedSeconds": { "type": "integer", "format": "int32" }, "minimalDrivingDistanceMeters": { "type": "integer", "format": "int32" }, "stopConfirmSeconds": { "type": "integer", "format": "int32" }, "driveConfirmSeconds": { "type": "integer", "format": "int32" }, "minimalDrivingSpeedKmh": { "type": "integer", "format": "int32" } } }, "allowOperatorToCancelTasks": { "type": "boolean" }, "taskTypes": { "type": "object", "properties": { "ownsObjects": { "type": "boolean" }, "capacity": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } } }, "dossiersAccessEnabled": { "type": "boolean" }, "categories": { "type": "string" } } } }, "itemCount": { "type": "integer", "format": "int32" } } } } }, "Driver API service - TPackagingResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "price": { "type": "number", "format": "double", "nullable": true }, "id": { "type": "string", "description": "Unique identifier" } } } }, "itemCount": { "type": "integer", "format": "int32" } } } } }, "Driver API service - TMobileDeviceRequest": { "type": "object", "properties": { "pushRegistrationToken": { "type": "string" }, "platform": { "type": "string" }, "operatingSystemVersion": { "type": "string" }, "brand": { "type": "string" }, "model": { "type": "string" }, "appVersion": { "type": "string" } } }, "Driver API service - TDossierFolderResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "modified": { "type": "string", "format": "date-time" }, "size": { "type": "object", "properties": { "size": { "type": "integer", "format": "int64" } } }, "type": { "type": "string", "enum": [ "file", "directory" ] }, "name": { "type": "object", "properties": {} }, "id": { "type": "string", "description": "Unique identifier" } } } }, "type": { "type": "string", "enum": [ "file", "directory" ] }, "name": { "type": "object", "properties": {} }, "id": { "type": "string", "description": "Unique identifier" } } } }, "itemCount": { "type": "integer", "format": "int32" } } } } }, "Driver API service - TChatMessageResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" }, "contactId": { "type": "string" }, "origin": { "type": "string", "enum": [ "device", "backend" ] }, "momentTransferred": { "type": "string", "format": "date-time" }, "momentConfirmed": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "string", "description": "Unique identifier" } } } }, "itemCount": { "type": "integer", "format": "int32" } } } } }, "Driver API service - TChatMessage": { "type": "object", "properties": { "message": { "type": "string" }, "contactId": { "type": "string" }, "origin": { "type": "string", "enum": [ "device", "backend" ] }, "momentTransferred": { "type": "string", "format": "date-time" }, "momentConfirmed": { "type": "string", "format": "date-time", "nullable": true }, "id": { "type": "string", "description": "Unique identifier" } } }, "Driver API service - TGetProcessedMutationIdsRequestBody": { "type": "object", "properties": { "mutationIds": { "type": "object", "properties": { "capacity": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } } } } }, "Driver API service - TDossierFileResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "type": "object", "properties": { "modified": { "type": "string", "format": "date-time" }, "size": { "type": "object", "properties": { "size": { "type": "integer", "format": "int64" } } }, "type": { "type": "string", "enum": [ "file", "directory" ] }, "name": { "type": "object", "properties": {} }, "id": { "type": "string", "description": "Unique identifier" } } } }, "itemCount": { "type": "integer", "format": "int32" } } } } }, "Driver API service - TRefuelingStop": { "type": "object", "properties": { "operatorId": { "type": "string" }, "vehicleId": { "type": "string" }, "moment": { "type": "string", "format": "date-time" }, "cost": { "type": "number", "format": "double" }, "quantity": { "type": "number", "format": "double" }, "mileage": { "type": "number", "format": "double" }, "remarks": { "type": "string" }, "location": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double" }, "longitude": { "type": "number", "format": "double" } } } } }, "Driver API service - TCompletionStatusResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "success": { "type": "boolean" }, "id": { "type": "string", "description": "Unique identifier" } } } }, "itemCount": { "type": "integer", "format": "int32" } } } } }, "Driver API service - TQuestionnaireResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "type": "object", "properties": { "questionnaire": { "type": "object", "properties": {} }, "createdAt": { "type": "string", "format": "date-time" }, "sequence": { "type": "integer", "format": "int64" }, "id": { "type": "string", "description": "Unique identifier" } } } }, "itemCount": { "type": "integer", "format": "int32" } } } } }, "Driver API service - TVersionResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "string" } } } }, "itemCount": { "type": "integer", "format": "int32" } } } } } }, "responses": {} }, "x-tagGroups": [ { "name": "Driver API", "tags": [ "Activities", "Activity Changes", "Chat Contacts", "Chat Messages", "Client", "Dossier", "Get Processed Mutations", "Good", "Master Data", "Mobile Device", "Planning", "Questionnaires", "Ride", "Settings", "Task", "Tracking Position", "Trailers", "Vehicles" ] } ] }