Download OpenAPI specification:
This API allows users to access Tecaser API!
Soft deletes a comment. The comment is marked as deleted but not physically removed.
Authorization: Only the comment author can delete their comment.
Deleted comments:
GDPR Exception: If your organisation is deleted, all comments are immediately physically deleted regardless of the 5-year retention period.
Behavior:
Business Rules:
required | object (CommentId) Comment ID |
| version required | integer <int64> Current version of the comment for optimistic locking |
required | object (OrganisationId) Organisation UUID from header |
{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}Edits an existing comment's content.
Authorization: Only the comment author can edit their comment.
Behavior:
Optimistic Locking: If the comment was modified by another user since you last fetched it:
Business Rules:
required | object (CommentId) Comment ID |
required | object (OrganisationId) Organisation UUID from header |
| content required | string [ 1 .. 10000 ] characters Updated comment text content |
| version required | integer <int64> Current version number for optimistic locking (prevents concurrent modification conflicts) |
{- "content": "Updated: Authentication now uses OAuth2 with PKCE extension for enhanced security",
- "version": 2
}{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}Adds a new comment to any resource (task, vehicle, maintenance order, fuel record, etc.).
Behavior:
Business Rules:
Context Types:
task: Kanban taskvehicle: Fleet vehiclemaintenance-order: Maintenance work orderfuel-record: Fuel refueling recordWorkflow:
| contextType required | string (ContextType) Enum: "task" "vehicle" "maintenance-order" "fuel-record" "task" "vehicle" "maintenance-order" "fuel-record" Example: task Type of parent resource |
required | object (ContextId) Example: 660e8400-e29b-41d4-a716-446655440000 Parent resource identifier |
| organisation-id required | string <uuid> Organisation UUID from header |
| content required | string [ 1 .. 10000 ] characters Comment text content (plain text only) |
{- "content": "Updated the authentication logic to use OAuth2 with refresh token rotation"
}{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}Creates a new task in your organisation's Kanban board.
Behavior:
Business Rules:
Workflow:
| organisation-id required | string <uuid> Organisation UUID from header |
| assignedUserId | string <uuid> UUID of user to assign this task to. Constraints:
Use case: Assign tasks to team members for clear ownership |
| description | string [ 0 .. 10000 ] characters Detailed task description (optional). Provide additional context, requirements, acceptance criteria, or any other information that helps understand what needs to be done. Constraints:
Formatting: Plain text or markdown |
| flagged | boolean Flag indicating if task is marked as important/priority. Purpose: Similar to starring/flagging emails - marks tasks that need special attention. Default: false (new tasks are not flagged) Visual representation: Often shown as a star or flag icon in UI |
| status | string (TaskStatus) Enum: "BACKLOG" "TO_DO" "IN_PROGRESS" "DONE" "CLOSED" "CANCELLED" "BACKLOG" "TO_DO" "IN_PROGRESS" "DONE" "CANCELLED" Current status of the task in the Kanban workflow. Available statuses:
|
| title required | string [ 1 .. 500 ] characters Task title. Brief description of what needs to be done. Constraints:
Examples:
|
{- "assignedUserId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
- "description": "Add OAuth2 authentication with Google and GitHub providers. Include refresh token rotation and session management.",
- "flagged": true,
- "status": "IN_PROGRESS",
- "title": "Implement user authentication"
}{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}Move task to canceled. The task is marked as CANCELED but not physically removed.
CANCELED tasks:
GDPR Exception: If your organisation is deleted, all tasks are immediately physically deleted regardless of the 5-year retention period.
Behavior:
Business Rules:
Recovery: CANCELED tasks can be undeleted by moving to other state.
| taskId required | string <uuid> Task ID |
| version required | integer <int64> Current version of the task for optimistic locking |
| organisation-id required | string <uuid> |
{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}Updates task properties: title, description, assignedUserId, and flagged status.
Important: This endpoint CANNOT change task status or position. Use PUT /api/v0.1/kanban/task/{id}/move to change status or position.
Behavior:
Optimistic Locking: If the task was modified by another user since you last fetched it:
Business Rules:
| taskId required | string <uuid> Task ID |
| organisation-id required | string <uuid> |
| assignedUserId | string <uuid> New assigned user UUID (optional - only if you want to change assignment). Constraints:
Omit this field if you don't want to change the assignment. Set to null to unassign the task. |
| description | string [ 0 .. 10000 ] characters New task description (optional - only if you want to change it). Constraints:
Omit this field if you don't want to change the description. Set to empty string to clear the description. |
| flagged required | boolean New flagged status (optional - only if you want to toggle the flag). Omit this field if you don't want to change the flagged status. Set to true to flag the task as important. Set to false to unflag the task. |
| title required | string [ 1 .. 500 ] characters New task title (optional - only if you want to change it). Constraints:
Omit this field if you don't want to change the title. |
| version required | integer <int64> >= 1 Current version number for optimistic locking. How it works:
Required: This field is mandatory for all update operations Example: If the task's current version is 5, provide 5 here. If successful, the task will be updated to version 6. |
{- "assignedUserId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
- "description": "Add OAuth2 with Google, GitHub, and Microsoft providers. Implement MFA support.",
- "flagged": true,
- "title": "Implement OAuth2 authentication with MFA",
- "version": 5
}{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}Moves a task to a different status column and/or changes its position within a status.
This is the ONLY endpoint that can change task status and position.
Behavior:
Position Reordering: When you move a task:
KanbanBoardTaskMoved eventsExample: Given tasks in IN_PROGRESS: [A(0), B(1), C(2), D(3)] Moving A to position 2 results in: [B(0), C(1), A(2), D(3)]
Event Broadcasting:
This operation emits KanbanBoardTaskMoved domain events for every task whose position changed.
Subscribers (WebSocket, SSE, projection handlers) receive updates for all affected tasks.
Status Transitions: All transitions are allowed between any statuses:
Typical Workflow:
Business Rules:
| taskId required | string <uuid> Task ID |
| organisation-id required | string <uuid> |
| newPosition | integer <int32> >= 0 Target position within the status column (0-based). Behavior:
Position Reordering: When you specify a position:
Constraints:
Examples:
|
| newStatus required | string (TaskStatus) Enum: "BACKLOG" "TO_DO" "IN_PROGRESS" "DONE" "CLOSED" "CANCELLED" "BACKLOG" "TO_DO" "IN_PROGRESS" "DONE" "CANCELLED" Current status of the task in the Kanban workflow. Available statuses:
|
| version required | integer <int64> >= 1 Current version number for optimistic locking. How it works:
Required: This field is mandatory for all move operations Example: If the task's current version is 7, provide 7 here. If successful, the task will be updated to version 8. |
{- "newPosition": 2,
- "newStatus": "IN_PROGRESS",
- "version": 7
}{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}Creates a new task in your organisation's Kanban board.
Behavior:
Business Rules:
Image attachment (optional):
POST /api/v0.1/image with responsibleService: KANBAN_TASKimageId valuesimageIds field of this request
Images not confirmed via imageIds will be removed by the background housekeeping job.Workflow:
| organisation-id required | string <uuid> Organisation UUID from header |
| assignedUserId | string <uuid> UUID of user to assign this task to. Constraints:
Use case: Assign tasks to team members for clear ownership |
| description | string [ 0 .. 10000 ] characters Detailed task description (optional). Provide additional context, requirements, acceptance criteria, or any other information that helps understand what needs to be done. Constraints:
Formatting: Plain text or markdown |
| flagged | boolean Flag indicating if task is marked as important/priority. Purpose: Similar to starring/flagging emails - marks tasks that need special attention. Default: false (new tasks are not flagged) Visual representation: Often shown as a star or flag icon in UI |
| imageIds | Array of strings <uuid> [ items <uuid > ] List of image IDs to attach to this task (optional). Two-step upload flow:
Images uploaded but not included here will be deleted by the background housekeeping job. |
| status | string (TaskStatus) Enum: "BACKLOG" "TO_DO" "IN_PROGRESS" "DONE" "CLOSED" "CANCELLED" "BACKLOG" "TO_DO" "IN_PROGRESS" "DONE" "CANCELLED" Current status of the task in the Kanban workflow. Available statuses:
|
| title required | string [ 1 .. 500 ] characters Task title. Brief description of what needs to be done. Constraints:
Examples:
|
{- "assignedUserId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
- "description": "Add OAuth2 authentication with Google and GitHub providers. Include refresh token rotation and session management.",
- "flagged": true,
- "imageIds": [
- "550e8400-e29b-41d4-a716-446655440000"
], - "status": "IN_PROGRESS",
- "title": "Implement user authentication"
}{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}Move task to cancelled. The task is marked as CANCELLED but not physically removed.
CANCELLED tasks:
GDPR Exception: If your organisation is deleted, all tasks are immediately physically deleted regardless of the 5-year retention period.
Behavior:
Business Rules:
Recovery: CANCELLED tasks can be undeleted by moving to other state.
| taskId required | string <uuid> Task ID |
| version required | integer <int64> Current version of the task for optimistic locking |
| organisation-id required | string <uuid> |
{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}Updates task properties: title, description, assignedUserId, and flagged status.
Important: This endpoint CANNOT change task status or position. Use PUT /api/v0.2/kanban/task/{id}/move to change status or position.
Behavior:
Optimistic Locking: If the task was modified by another user since you last fetched it:
Business Rules:
Image attachment (optional):
POST /api/v0.1/image with responsibleService: KANBAN_TASKimageId valuesimageIds field of this request
Only newly uploaded (unconfirmed) images need to be listed - existing confirmed images are unaffected.
Images uploaded but not included here will be removed by the background housekeeping job.| taskId required | string <uuid> Task ID |
| organisation-id required | string <uuid> |
| assignedUserId | string <uuid> New assigned user UUID (optional - only if you want to change assignment). Constraints:
Omit this field if you don't want to change the assignment. Set to null to unassign the task. |
| description | string [ 0 .. 10000 ] characters New task description (optional - only if you want to change it). Constraints:
Omit this field if you don't want to change the description. Set to empty string to clear the description. |
| flagged required | boolean New flagged status (optional - only if you want to toggle the flag). Omit this field if you don't want to change the flagged status. Set to true to flag the task as important. Set to false to unflag the task. |
| imageIds | Array of strings <uuid> [ items <uuid > ] List of new image IDs to attach to this task (optional). Two-step upload flow:
Images uploaded but not included here will be deleted by the background housekeeping job. Only newly uploaded (unconfirmed) images need to be listed here - existing confirmed images are unaffected. |
| title required | string [ 1 .. 500 ] characters New task title (optional - only if you want to change it). Constraints:
Omit this field if you don't want to change the title. |
| version required | integer <int64> >= 1 Current version number for optimistic locking. How it works:
Required: This field is mandatory for all update operations Example: If the task's current version is 5, provide 5 here. If successful, the task will be updated to version 6. |
{- "assignedUserId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
- "description": "Add OAuth2 with Google, GitHub, and Microsoft providers. Implement MFA support.",
- "flagged": true,
- "imageIds": [
- "550e8400-e29b-41d4-a716-446655440000"
], - "title": "Implement OAuth2 authentication with MFA",
- "version": 5
}{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}Moves a task to a different status column and/or changes its position within a status.
This is the ONLY endpoint that can change task status and position.
Behavior:
Position Reordering: When you move a task:
KanbanBoardTaskMoved eventsExample: Given tasks in IN_PROGRESS: [A(0), B(1), C(2), D(3)] Moving A to position 2 results in: [B(0), C(1), A(2), D(3)]
Event Broadcasting:
This operation emits KanbanBoardTaskMoved domain events for every task whose position changed.
Subscribers (WebSocket, SSE, projection handlers) receive updates for all affected tasks.
Status Transitions: All transitions are allowed between any statuses:
Typical Workflow:
Business Rules:
| taskId required | string <uuid> Task ID |
| organisation-id required | string <uuid> |
| newPosition | integer <int32> >= 0 Target position within the status column (0-based). Behavior:
Position Reordering: When you specify a position:
Constraints:
Examples:
|
| newStatus required | string (TaskStatus) Enum: "BACKLOG" "TO_DO" "IN_PROGRESS" "DONE" "CLOSED" "CANCELLED" "BACKLOG" "TO_DO" "IN_PROGRESS" "DONE" "CANCELLED" Current status of the task in the Kanban workflow. Available statuses:
|
| version required | integer <int64> >= 1 Current version number for optimistic locking. How it works:
Required: This field is mandatory for all move operations Example: If the task's current version is 7, provide 7 here. If successful, the task will be updated to version 8. |
{- "newPosition": 2,
- "newStatus": "IN_PROGRESS",
- "version": 7
}{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}| organisation-id required | string <uuid> |
| incompleteness | boolean |
Array of objects (RefuelingRequestBatch) |
{- "incompleteness": true,
- "refuelings": [
- {
- "amount": 123,
- "comment": "Good price",
- "country": "AT",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "currency": "CZK",
- "distance": 234000,
- "driverName": "John Smith",
- "fuel": "PETROL",
- "fuelSupplierId": "c4290fb9-d99e-4408-8acf-d733761ada33",
- "fullRefueling": true,
- "invoiceNumber": "123/2024",
- "operationDate": "2024-03-12",
- "operationTime": "12:01:02",
- "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
- "refuelingId": "472a8ee6-eb9c-4aa4-a142-61abdab47cb3",
- "stationName": "Orlen, Krakowska Street",
- "unitPrice": 1.23,
- "unitPriceStation": 1.23,
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleId": { }
}
]
}[- {
- "batchStatus": "OK",
- "index": 0,
- "message": "string"
}
]| vehicleId required | object (VehicleId) |
| from required | string <date> |
| to required | string <date> |
| fuel required | string (Fuel) Enum: "PETROL" "DIESEL" "AD_BLUE" "COMPRESSED_NATURAL_GAS" "LIQUEFIED_PETROLEUM_GAS" "HYDROGEN" "ELECTRIC" Example: fuel=PETROL Fuel type |
| organisation-id required | string <uuid> |
[- {
- "amount": 0.1,
- "distance": 0,
- "operationDateBegin": "2019-08-24",
- "operationDateEnd": "2019-08-24"
}
][- {
- "amount": 123,
- "comment": "Good price",
- "country": "AT",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "currency": "CZK",
- "distance": 234000,
- "driverName": "John Smith",
- "fuel": "PETROL",
- "fuelSupplierId": "c4290fb9-d99e-4408-8acf-d733761ada33",
- "fulfillment": true,
- "fullRefueling": true,
- "invoiceNumber": "123/2024",
- "operationDate": "2024-03-12",
- "operationTime": "12:01:02",
- "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
- "refuelingId": "472a8ee6-eb9c-4aa4-a142-61abdab47cb3",
- "stationName": "Orlen, Krakowska Street",
- "unitPrice": 1.23,
- "unitPriceStation": 1.23,
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}
]| organisation-id required | string <uuid> |
| amount required | number <double> Amount of fuel |
| comment | string Additional information about refuelling |
| country | string (Country) Enum: "AT" "BE" "CZ" "DE" "DK" "ES" "FI" "FR" "HR" "GB" "GR" "HU" "IT" "LT" "NO" "NL" "PL" "PT" "RO" "SE" "SI" "SK" "TR" "UA" "US" |
| currency | string (Currency) Enum: "CZK" "EUR" "GBP" "HUF" "PLN" "RON" "UAH" "USD" |
| distance required | integer <int32> Vehicle distance |
| driverName | string The name of the driver |
| fuel required | string (Fuel) Enum: "PETROL" "DIESEL" "AD_BLUE" "COMPRESSED_NATURAL_GAS" "LIQUEFIED_PETROLEUM_GAS" "HYDROGEN" "ELECTRIC" Fuel type |
| fuelSupplierId | string <uuid> Fuel supplier |
| fullRefueling required | boolean Mark this refueling as true if the tank was filled to its maximum capacity. This helps improve fuel consumption accuracy and detect anomalies. |
| invoiceNumber | string The purchase invoice number |
| operationDate required | string <date> Operation date |
| operationTime | string Operation time |
| stationName | string The name of the tank station |
| unitPrice | number The unit price of the fuel |
| unitPriceStation | number The unit price of the fuel at the station |
| vehicleId required | object (VehicleId) |
{- "amount": 123,
- "comment": "Good price",
- "country": "AT",
- "currency": "CZK",
- "distance": 234000,
- "driverName": "John Smith",
- "fuel": "PETROL",
- "fuelSupplierId": "c4290fb9-d99e-4408-8acf-d733761ada33",
- "fullRefueling": true,
- "invoiceNumber": "123/2024",
- "operationDate": "2024-03-12",
- "operationTime": "12:01:02",
- "stationName": "Orlen, Krakowska Street",
- "unitPrice": 1.23,
- "unitPriceStation": 1.23,
- "vehicleId": { }
}{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}| refuelingId required | string <uuid> |
| organisation-id required | string <uuid> |
{- "amount": 123,
- "comment": "Good price",
- "country": "AT",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "currency": "CZK",
- "distance": 234000,
- "driverName": "John Smith",
- "fuel": "PETROL",
- "fuelSupplierId": "c4290fb9-d99e-4408-8acf-d733761ada33",
- "fulfillment": true,
- "fullRefueling": true,
- "invoiceNumber": "123/2024",
- "operationDate": "2024-03-12",
- "operationTime": "12:01:02",
- "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
- "refuelingId": "472a8ee6-eb9c-4aa4-a142-61abdab47cb3",
- "stationName": "Orlen, Krakowska Street",
- "unitPrice": 1.23,
- "unitPriceStation": 1.23,
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}| refuelingId required | string <uuid> |
| organisation-id required | string <uuid> |
| amount required | number <double> Amount of fuel |
| comment | string Additional information about refuelling |
| country | string (Country) Enum: "AT" "BE" "CZ" "DE" "DK" "ES" "FI" "FR" "HR" "GB" "GR" "HU" "IT" "LT" "NO" "NL" "PL" "PT" "RO" "SE" "SI" "SK" "TR" "UA" "US" |
| currency | string (Currency) Enum: "CZK" "EUR" "GBP" "HUF" "PLN" "RON" "UAH" "USD" |
| distance required | integer <int32> Vehicle distance |
| driverName | string The name of the driver |
| fuel required | string (Fuel) Enum: "PETROL" "DIESEL" "AD_BLUE" "COMPRESSED_NATURAL_GAS" "LIQUEFIED_PETROLEUM_GAS" "HYDROGEN" "ELECTRIC" Fuel type |
| fuelSupplierId | string <uuid> Fuel supplier |
| fullRefueling required | boolean Mark this refueling as true if the tank was filled to its maximum capacity. This helps improve fuel consumption accuracy and detect anomalies. |
| invoiceNumber | string The purchase invoice number |
| operationDate required | string <date> Operation date |
| operationTime | string Operation time |
| stationName | string The name of the tank station |
| unitPrice | number The unit price of the fuel |
| unitPriceStation | number The unit price of the fuel at the station |
| vehicleId required | object (VehicleId) |
{- "amount": 123,
- "comment": "Good price",
- "country": "AT",
- "currency": "CZK",
- "distance": 234000,
- "driverName": "John Smith",
- "fuel": "PETROL",
- "fuelSupplierId": "c4290fb9-d99e-4408-8acf-d733761ada33",
- "fullRefueling": true,
- "invoiceNumber": "123/2024",
- "operationDate": "2024-03-12",
- "operationTime": "12:01:02",
- "stationName": "Orlen, Krakowska Street",
- "unitPrice": 1.23,
- "unitPriceStation": 1.23,
- "vehicleId": { }
}{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}| vehicleId required | object (VehicleId) |
| from required | string <date> |
| to required | string <date> |
| fuel required | string (Fuel) Enum: "PETROL" "DIESEL" "AD_BLUE" "COMPRESSED_NATURAL_GAS" "LIQUEFIED_PETROLEUM_GAS" "HYDROGEN" "ELECTRIC" Example: fuel=PETROL Fuel type |
| organisation-id required | string <uuid> |
{- "odometers": [
- {
- "odometer": 0,
- "operationTimestamp": "2019-08-24T14:15:22Z"
}
], - "refuelings": [
- {
- "amount": 0.1,
- "fuel": "PETROL",
- "operationDate": "2019-08-24T14:15:22Z"
}
], - "tankLevels": [
- {
- "level": 0.1,
- "unit": "PERCENT"
}
]
}Returns all pending invitations for the current organisation. Requires manager privileges.
Invitation list
[- {
- "invitationId": "7e972f0a-62f6-496f-b9b6-3f610c8cb622",
- "email": "o1u10@example.com",
- "invitedByUser": "a25f2907-9940-4070-9e84-f55d16bfd98a",
- "createdTimestamp": "2024-01-15T10:30:00"
}
]Creates a new invitation and sends an email to the invitee. Requires manager privileges.
| createdTimestamp | string <date-time> |
string | |
| invitationId | string <uuid> |
| invitedByUser | string <uuid> |
{- "createdTimestamp": "2019-08-24T14:15:22Z",
- "email": "string",
- "invitationId": "550a4884-8473-4f2e-a6cf-551c16767d59",
- "invitedByUser": "10957437-f7aa-4d04-927c-ea43f27b0b5d"
}Created invitation
{- "invitationId": "7e972f0a-62f6-496f-b9b6-3f610c8cb622",
- "email": "test1@ex.com",
- "invitedByUser": "a25f2907-9940-4070-9e84-f55d16bfd98a",
- "createdTimestamp": "2024-01-15T10:30:00"
}Returns a specific invitation by its ID. Requires manager privileges.
| invitationId required | string <uuid> Invitation ID |
Single invitation
{- "invitationId": "7e972f0a-62f6-496f-b9b6-3f610c8cb622",
- "email": "o1u10@example.com",
- "invitedByUser": "a25f2907-9940-4070-9e84-f55d16bfd98a",
- "createdTimestamp": "2024-01-15T10:30:00"
}| maintenanceId required | string <uuid> |
| createDateTime | string <date-time> |
| distance | integer <int64> |
| distanceUnit | string (WorkUnit) Enum: "KILOMETER" "MILE" "HOUR" |
| id | string <uuid> |
| image | string |
Array of objects (MaintenanceItemValueDTO) | |
| operationDate | string <date> |
| remarks required | string non-empty |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
| userId | string <uuid> |
| vehicleId | string <uuid> |
{- "createDateTime": "2019-08-24T14:15:22Z",
- "distance": 0,
- "distanceUnit": "KILOMETER",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "image": "string",
- "maintenanceItems": [
- {
- "booleanValue": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "maintenanceItemId": "10be3182-291a-4dc6-bf71-aabafed209f8",
- "multipleValue": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "singleValue": "d27d5344-a56e-44a6-ab6f-6ec776611635"
}
], - "operationDate": "2019-08-24",
- "remarks": "string",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}{ }[- {
- "createDateTime": "2019-08-24T14:15:22Z",
- "distance": 0,
- "distanceUnit": "KILOMETER",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "image": "string",
- "maintenanceItems": [
- {
- "booleanValue": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "maintenanceItemId": "10be3182-291a-4dc6-bf71-aabafed209f8",
- "multipleValue": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "singleValue": "d27d5344-a56e-44a6-ab6f-6ec776611635"
}
], - "operationDate": "2019-08-24",
- "remarks": "string",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}
]| vehicleId required | string <uuid> |
| file | string <binary> |
required | object (MaintenanceDTO) |
{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}| vehicleId required | string <uuid> |
| createDateTime | string <date-time> |
| distance | integer <int64> |
| distanceUnit | string (WorkUnit) Enum: "KILOMETER" "MILE" "HOUR" |
| id | string <uuid> |
| image | string |
Array of objects (MaintenanceItemValueDTO) | |
| operationDate | string <date> |
| remarks required | string non-empty |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
| userId | string <uuid> |
| vehicleId | string <uuid> |
{- "createDateTime": "2019-08-24T14:15:22Z",
- "distance": 0,
- "distanceUnit": "KILOMETER",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "image": "string",
- "maintenanceItems": [
- {
- "booleanValue": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "maintenanceItemId": "10be3182-291a-4dc6-bf71-aabafed209f8",
- "multipleValue": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "singleValue": "d27d5344-a56e-44a6-ab6f-6ec776611635"
}
], - "operationDate": "2019-08-24",
- "remarks": "string",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}Returns a specific maintenance record by its ID
| maintenanceId required | string <uuid> Maintenance ID |
Maintenance response
{- "id": "fced9478-dbec-40df-8bc9-9f0382d73da8",
- "vehicleId": "a25f2907-9940-4070-9e84-f55d16bfd98a",
- "operationDate": "2019-11-12",
- "createDateTime": "2021-07-24T18:05:03",
- "updateDateTime": "2021-07-24T18:05:03",
- "userId": "e65f2907-9940-4070-9e84-f55d16bfd98e",
- "updateUserId": "e65f2907-9940-4070-9e84-f55d16bfd98f",
- "distance": 200,
- "distanceUnit": "KILOMETER",
- "remarks": "Brak uwag",
- "maintenanceItems": [
- {
- "id": "b1c2d3e4-1111-4070-9e84-f55d16bfd001",
- "maintenanceItemId": "dc7c8573-3945-424a-a30f-eaf4fc32b700",
- "booleanValue": true,
- "singleValue": null,
- "multipleValue": null
}, - {
- "id": "b1c2d3e4-2222-4070-9e84-f55d16bfd002",
- "maintenanceItemId": "fec57979-df19-4adb-ae19-a583ce55519c",
- "booleanValue": true,
- "singleValue": null,
- "multipleValue": null
}
]
}| maintenanceId required | string <uuid> |
| file | string <binary> |
required | object (MaintenanceDTO) |
{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}Returns a list of maintenance items configured for a specific vehicle
| vehicleId required | string <uuid> Vehicle ID |
Maintenance items list
[- {
- "id": "dc7c8573-3945-424a-a30f-eaf4fc32b700",
- "name": "Olej",
- "description": "Wymiana oleju",
- "distanceInterval": 60000,
- "distanceConfigurable": true,
- "timeInterval": null,
- "timeIntervalConfigurable": false,
- "enable": true,
- "type": "Boolean",
- "category": "ENGINE_OIL"
}, - {
- "id": "fec57979-df19-4adb-ae19-a583ce55519c",
- "name": "Klocki hamulcowe 1",
- "description": "Wymiana klocki hamulcowe 1",
- "distanceInterval": null,
- "distanceConfigurable": false,
- "timeInterval": null,
- "timeIntervalConfigurable": false,
- "enable": true,
- "type": "Boolean",
- "category": "BREAK"
}, - {
- "id": "3a519994-5380-4d89-88cc-5301a6438b53",
- "name": "Filtr powietrza",
- "description": "Wymiana Filtr powietrza",
- "distanceInterval": null,
- "distanceConfigurable": false,
- "timeInterval": null,
- "timeIntervalConfigurable": false,
- "enable": true,
- "type": "Boolean",
- "category": "ENGINE"
}, - {
- "id": "c156569f-d41a-4ec3-8ae6-3c0925f237e2",
- "name": "Klimatyzacja",
- "description": "Wymiana Klimatyzacja",
- "distanceInterval": null,
- "distanceConfigurable": false,
- "timeInterval": null,
- "timeIntervalConfigurable": false,
- "enable": true,
- "type": "Boolean",
- "category": "AIR_CONDITION"
}, - {
- "id": "182f2c02-43f3-44cc-bf56-d3a01bbfbb9d",
- "name": "Opony 1",
- "description": "Wymiana opony 1",
- "distanceInterval": null,
- "distanceConfigurable": false,
- "timeInterval": null,
- "timeIntervalConfigurable": false,
- "enable": true,
- "type": "Boolean",
- "category": "TYRE"
}
]Retrieves paginated analytics data with optional filtering.
Features:
page and size parametersentity parametercolumns parameterEntity Types:
MAINTENANCE: Maintenance activitiesDUTY: Duty-related activitiesVEHICLE: Vehicle updatesTASK: Task activitiesLOGIN/LOGOUT: User session activitiesFiltering:
entity=MAINTENANCE to show only maintenance recordsentity=!MAINTENANCE to exclude maintenance records| filter | Array of strings Example: filter=activity:!CREATED Filter field. Use ! for exclusion. |
| columns | Array of strings Default: "timestamp&columns=entity&columns=activityType&columns=userId" Example: columns=name,description Comma-separated list of columns to display. Available: entity, name, description, status, createdTimestamp, updatedTimestamp Example: Leave empty for default column configuration. |
| sort | string Default: "+timestamp" Example: sort=name,description Comma-separated list of fields to define the sort order. To indicate sorting direction, fields may be prefixed with + (ascending) or - (descending). Available: entity, name, description, status, createdTimestamp, updatedTimestamp Example: Leave empty for default field sort order. |
| register required | string (RegisterType) Enum: "EVENTS" "PROJECTION" Example: register=EVENTS Filter by register. Example: |
| organisation-id required | string <uuid> Example: 550e8400-e29b-41d4-a716-446655440000 Organisation ID for which to retrieve analytics |
{- "_links": {
- "self": {
- "href": "/api/v0.1/analytics?page=0"
}, - "next": {
- "href": "/api/v0.1/analytics?page=1"
}
}, - "_templates": {
- "property1": {
- "columns": [
- {
- "_links": {
- "show": {
- "href": "/api/v0.1/analytics?columns=name,description"
}
}, - "filter": true,
- "name": "name",
- "prompt": "Name",
- "show": true,
- "sort": "DESCENDING",
- "sortable": true,
- "type": "string"
}
], - "filters": [
- {
- "_links": {
- "self": {
- "href": "/api/v0.1/analytics?entity=MAINTENANCE"
}, - "filter_exclude": {
- "href": "/api/v0.1/analytics"
}
}, - "name": "entity",
- "type": "SELECTED",
- "value": "MAINTENANCE"
}
]
}, - "property2": {
- "columns": [
- {
- "_links": {
- "show": {
- "href": "/api/v0.1/analytics?columns=name,description"
}
}, - "filter": true,
- "name": "name",
- "prompt": "Name",
- "show": true,
- "sort": "DESCENDING",
- "sortable": true,
- "type": "string"
}
], - "filters": [
- {
- "_links": {
- "self": {
- "href": "/api/v0.1/analytics?entity=MAINTENANCE"
}, - "filter_exclude": {
- "href": "/api/v0.1/analytics"
}
}, - "name": "entity",
- "type": "SELECTED",
- "value": "MAINTENANCE"
}
]
}
}, - "content": {
- "barChart": [
- {
- "label": "Mon",
- "value": 12
}
], - "data": [
- {
- "cells": [
- {
- "_links": {
- "filter_exclude": {
- "href": "/api/v0.1/analytics?entity=MAINTENANCE"
}, - "filter_include": {
- "href": "/api/v0.1/analytics?entity=MAINTENANCE"
}, - "self": {
- "href": "/api/v0.1/analytics?entity=MAINTENANCE"
}
}, - "arrayValue": "MAINTENANCE",
- "column": "Oil change - BMW X3",
- "value": "MAINTENANCE"
}
], - "id": "a1b2c3d4-1111-4070-9e84-f55d16bfd001",
- "timestamp": "2019-08-24T14:15:22Z"
}
]
}, - "page": {
- "number": 0,
- "size": 20,
- "totalElements": 50,
- "totalPages": 3
}
}| register | string (RegisterType) Enum: "EVENTS" "PROJECTION" |
| organisation-id required | string <uuid> |
[- {
- "calculatedFieldId": "bbe9afeb-41cd-4504-bd3f-bb794ec6f8c5",
- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
- "description": "string",
- "name": "string",
- "organisationId": {
- "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5"
}, - "register": "string",
- "script": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e"
}
]| register | string (RegisterType) Enum: "EVENTS" "PROJECTION" |
| organisation-id required | string <uuid> |
| description required | string non-empty Human-readable label shown in the UI |
| name required | string non-empty Field name used as column identifier |
| script required | string non-empty JavaScript expression evaluated per row |
{- "description": "Cost per km",
- "name": "costPerKm",
- "script": "totalCost / distanceValue"
}{- "calculatedFieldId": "bbe9afeb-41cd-4504-bd3f-bb794ec6f8c5",
- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
- "description": "string",
- "name": "string",
- "organisationId": {
- "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5"
}, - "register": "string",
- "script": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e"
}| calculatedFieldId required | string <uuid> |
| organisation-id required | string <uuid> |
{- "calculatedFieldId": "bbe9afeb-41cd-4504-bd3f-bb794ec6f8c5",
- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
- "description": "string",
- "name": "string",
- "organisationId": {
- "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5"
}, - "register": "string",
- "script": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e"
}| calculatedFieldId required | string <uuid> |
| register | string (RegisterType) Enum: "EVENTS" "PROJECTION" |
| organisation-id required | string <uuid> |
| description required | string non-empty Human-readable label shown in the UI |
| name required | string non-empty Field name used as column identifier |
| script required | string non-empty JavaScript expression evaluated per row |
{- "description": "Cost per km",
- "name": "costPerKm",
- "script": "totalCost / distanceValue"
}{- "calculatedFieldId": "bbe9afeb-41cd-4504-bd3f-bb794ec6f8c5",
- "createdAt": "2019-08-24T14:15:22Z",
- "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
- "description": "string",
- "name": "string",
- "organisationId": {
- "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5"
}, - "register": "string",
- "script": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedBy": "b0efe45f-0520-4e21-90f0-7e35f137732e"
}Creates user if not exists and returns user information including account deletion eligibility
User is member of a corporate organisation or not owner of private organisation
{- "userId": "e65f2907-9940-4070-9e84-f55d16bfd98f",
- "imageId": null,
- "canDeleteAccount": false
}Sets the current user's profile image, or removes the existing one.
Only one profile image is supported per user. Calling this endpoint with a new imageId replaces the previous one. Calling with a null imageId removes the current profile image without setting a new one.
Two-step flow (same pattern as kanban task attachments):
POST /api/v0.1/image with responsibleService: USER_PROFILE -> receive imageIdimageId to claim ownershipRemove:
Send { "imageId": null } to remove the existing profile image without uploading a new one.
Business Rules:
imageId is provided, it must reference an unconfirmed image with responsibleService: USER_PROFILE| imageId | string or null <uuid> ID of the previously uploaded image to claim as profile image; null to remove the existing image |
{- "imageId": "bbefe473-c66a-4040-85cf-1c7e6f0b3830"
}{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}Returns user information for a specific user within the same organisation
| userId required | string <uuid> User ID |
Active user with phone
{- "userId": "e65f2907-9940-4070-9e84-f55d16bfd98f",
- "firstName": "u2",
- "lastName": "o1",
- "email": "o1u2@example.com",
- "phone": "+48123456789"
}Returns beacons across all organisations the caller belongs to. Filters narrow the result; values that don't match a membership are silently dropped to avoid leaking existence across tenants.
| organisationId | Array of strings <uuid> [ items <uuid > ] |
| vehicleId | string <uuid> |
| proximityUuid | string <uuid> |
| seenSince | string <date-time> |
| page | integer <int32> >= 0 Default: 0 |
| size | integer <int32> [ 1 .. 200 ] Default: 50 |
| sort | Array of strings |
{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}Registers a long-lived beacon. The beacon's owning organisation is copied from the assigned vehicle at registration time and remains stable even if the vehicle is later reassigned across organisations.
Multi-tenancy rule: assignedVehicleId must belong to one of the caller's organisations. If not, the server returns 404 rather than 403 to avoid leaking vehicle existence across tenants.
Uniqueness: the tuple (organisationId, proximityUuid, major, minor) is unique. Re-registering the same advertisement triple within the same organisation returns 409 Conflict.
| assignedVehicleId required | string <uuid> Vehicle the beacon is physically attached to. Must belong to one of the caller's organisations - otherwise the request returns 404 (the project's pattern is to hide existence on cross-tenant lookups). |
| label required | string [ 0 .. 200 ] characters Human-readable label shown in the mobile UI. |
| major required | integer <int32> [ 0 .. 65535 ] iBeacon major value (0-65535). |
| minor required | integer <int32> [ 0 .. 65535 ] iBeacon minor value (0-65535). |
| proximityUuid required | string <uuid> iBeacon proximity UUID from the advertisement. |
| txPower | integer or null <int32> Calibrated RSSI measured at one meter, in dBm. Used by the iOS app to convert RSSI to distance. |
| vendor | string or null [ 0 .. 100 ] characters Optional vendor / brand of the beacon hardware. |
{- "assignedVehicleId": "a1b2c3d4-1234-5678-9abc-def012345678",
- "label": "Trailer TR-505",
- "major": 1001,
- "minor": 1,
- "proximityUuid": "e2c56db5-dffb-48d2-b060-d0f5a71096e0",
- "txPower": -59,
- "vendor": "Estimote"
}{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}Uploads an image and returns a provisional imageId. The image is not yet confirmed and will be removed by a background housekeeping job if it is never claimed.
Two-step confirmation flow:
imageIdimageId to the relevant domain endpoint (e.g. POST /api/v0.3/organisation) which calls confirmOwnership internally to make the image permanent.responsibleService declares which domain the image belongs to:
ORGANISATION - organisation logoMAINTENANCE - maintenance record attachmentTASK - maintenance request attachmentKANBAN_TASK - kanban board task attachmentDUTY - duty record attachmentUSER_PROFILE - user profile imageVEHICLE - vehicle attachmentrequired | object (OrganisationId) Organisation ID |
| file required | string <binary> Image file binary |
required | object (ImageCreateRequest) Image metadata |
{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}Returns the raw image bytes. If both width and height are provided the image is resized before being returned.
Responses include a strong ETag derived from the image ID and requested dimensions. Clients should send If-None-Match on subsequent requests to receive a 304 Not Modified without re-downloading the body. Image content is immutable, so the response is safe to cache for up to one year (Cache-Control: private, max-age=31536000, immutable).
| imageId required | string <uuid> Image ID |
| width | integer <int32> Target width in pixels for resizing (requires height) |
| height | integer <int32> Target height in pixels for resizing (requires width) |
required | object (OrganisationId) Organisation ID |
| If-None-Match | string Conditional GET - supply the ETag received in a previous response |
{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}Deprecated. This endpoint will be removed in a future version.
Image replacement is no longer supported. The intended workflow is:
POST /api/v0.1/image to receive a new imageId.imageId to the domain endpoint (e.g. the kanban task update) which confirms ownership of the new image.| imageId required | string <uuid> Image ID |
required | object (OrganisationId) Organisation ID |
| file required | string <binary> Replacement image file binary |
{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}Returns monthly mileage data grouped by month with year columns showing total mileage for the organisation's fleet
| organisation-id required | string <uuid> Organisation ID |
Monthly mileage report
[- {
- "2022": 3440,
- "2023": 5873,
- "2024": 8306,
- "month": 1
}, - {
- "2022": 3626,
- "2023": 6060,
- "2024": 8500,
- "month": 2
}, - {
- "2022": 3833,
- "2023": 6266,
- "2024": 8706,
- "month": 3
}, - {
- "2022": 4033,
- "2023": 6466,
- "2024": 8906,
- "month": 4
}, - {
- "2022": 4240,
- "2023": 6673,
- "2024": 9113,
- "month": 5
}, - {
- "2022": 4440,
- "2023": 6873,
- "2024": 9313,
- "month": 6
}, - {
- "2022": 4646,
- "2023": 7080,
- "2024": 9520,
- "month": 7
}, - {
- "2022": 4853,
- "2023": 7286,
- "2024": 9726,
- "month": 8
}, - {
- "2022": 5053,
- "2023": 7486,
- "2024": 9926,
- "month": 9
}, - {
- "2022": 5260,
- "2023": 7693,
- "2024": 10133,
- "month": 10
}, - {
- "2021": 3026,
- "2022": 5460,
- "2023": 7893,
- "2024": 10333,
- "month": 11
}, - {
- "2021": 3233,
- "2022": 5666,
- "2023": 8100,
- "month": 12
}
]Retrieves a paginated list of tasks for your organisation in HAL+JSON format.
Response Format (HAL+JSON):
_embedded.tasks: Array of task objects_links: Hypermedia links (self, next, prev, last, create)page: Pagination metadataEach task includes:
_links object with available actions based on task stateHATEOAS Links: Each task includes state-driven links showing available actions:
self: Link to task details with full event historyupdate: Link to update task propertiesmove: Link to move task to different statusdelete: Link to soft delete task (includes version)flag/unflag: Toggle flag based on current statereopen: For DONE/CLOSED/CANCELLED tasksFiltering: Combine multiple filters to narrow results:
?status=IN_PROGRESS?assignedUserId=uuid?flagged=true?deleted=truePagination:
page parameter for page number (0-based)size parameter for page size (max: 100)sort for ordering (e.g., position,asc or createdAt,desc)Position Ordering:
position,asc to get tasks in display order for Kanban columnsPerformance: This endpoint is optimized for list views and does NOT include event history. To get full event history, use GET /api/v0.1/kanban/task/{id}.
Use Cases:
?status=IN_PROGRESS&sort=position,asc?assignedUserId={userId}?flagged=true?sort=createdAt,desc&size=10?deleted=true (for admin/recovery)| status | string Enum: "BACKLOG" "TO_DO" "IN_PROGRESS" "DONE" "CLOSED" "CANCELLED" Filter by task status |
| assignedUserId | string <uuid> Filter by assigned user UUID |
| flagged | boolean Filter by flagged status |
required | object (Pageable) |
| organisation-id required | string <uuid> Organisation UUID from header |
{- "_embedded": {
- "tasks": [
- {
- "contextId": "uuid-123",
- "title": "Implement authentication",
- "status": "IN_PROGRESS",
- "version": 5,
- "_links": {
- "self": {
- "href": "/api/v0.1/kanban/task/uuid-123"
}, - "update": {
- "href": "/api/v0.1/kanban/task/uuid-123",
- "method": "PUT"
}
}
}
]
}, - "_links": {
- "self": {
- "href": "/api/v0.1/kanban/task?page=0&size=20"
}, - "next": {
- "href": "/api/v0.1/kanban/task?page=1&size=20"
}
}, - "page": {
- "size": 20,
- "totalElements": 42,
- "totalPages": 3,
- "number": 0
}
}Retrieves metadata needed to create a new task in HAL+JSON format.
Response includes:
HATEOAS Links:
self: Link to this metadata endpointcreate: Link to create new task (POST /api/v0.1/kanban/task)members: Link to get organization members for assignment (GET /api/v0.2/member/)Use Cases:
Client Workflow:
members link to fetch assignable userscreate link to POST new taskStatus Options: Each status includes:
value: Enum value (e.g., "BACKLOG", "TO_DO")description: Human-readable explanationisDefault: Whether this is the default status (BACKLOG = true)| organisation-id required | string <uuid> Organisation UUID from header |
{- "availableStatuses": [
- {
- "value": "BACKLOG",
- "description": "Task is planned but not yet ready to work on",
- "isDefault": true
}, - {
- "value": "TO_DO",
- "description": "Task is ready to be picked up",
- "isDefault": false
}, - {
- "value": "IN_PROGRESS",
- "description": "Someone is currently working on this task",
- "isDefault": false
}, - {
- "value": "DONE",
- "description": "Task is completed",
- "isDefault": false
}, - {
- "value": "CLOSED",
- "description": "Task is completed and approved",
- "isDefault": false
}, - {
- "value": "CANCELLED",
- "description": "Task was cancelled and won't be completed",
- "isDefault": false
}
], - "_links": {
- "self": {
- "href": "/api/v0.1/kanban/task/new"
}, - "create": {
- "href": "/api/v0.1/kanban/task",
- "method": "POST",
- "title": "Create new task"
}, - "members": {
- "href": "/api/v0.2/member/",
- "method": "GET",
- "title": "Get assignable users"
}
}
}Retrieves a single task with its complete event history in HAL+JSON format.
Response includes:
_links: HATEOAS links for all available actions_embedded.events: Complete event history (audit log)Event History: Shows every change made to the task since creation. Event types are sealed:
Event Fields:
HATEOAS Links:
The _links object shows ALL available actions based on current state:
Query Parameters:
includeHistory: Set to false to exclude event history (default: true)historySortOrder: Sort events by timestamp (asc or desc, default: desc)Use Cases:
?includeHistory=false for faster responsePerformance Note: Including event history requires joining with event store. For list views, use GET /api/v0.1/kanban/task instead (no history).
| taskId required | string <uuid> Task ID |
| includeHistory | boolean Default: true Include event history (default: true) |
| organisation-id required | string <uuid> Organisation UUID from header |
Task Detail with Comments Links
{- "contextId": "123e4567-e89b-12d3-a456-426614174000",
- "title": "Implement dark mode",
- "description": "Add dark mode toggle to application settings",
- "assignedUserId": "987fcdeb-51a2-43f1-9876-fedcba987654",
- "status": "IN_PROGRESS",
- "position": 2,
- "taskNumber": 42,
- "flagged": true,
- "version": 3,
- "createdAt": "2025-01-15T10:30:00Z",
- "updatedAt": "2025-01-16T14:20:00Z",
- "_links": {
- "self": {
- "href": "/api/v0.1/kanban/task/123e4567-e89b-12d3-a456-426614174000"
}, - "collection": {
- "href": "/api/v0.1/kanban/task",
- "title": "All tasks"
}, - "update": {
- "href": "/api/v0.1/kanban/task/123e4567-e89b-12d3-a456-426614174000",
- "method": "PUT",
- "title": "Update task properties"
}, - "move": {
- "href": "/api/v0.1/kanban/task/123e4567-e89b-12d3-a456-426614174000/move",
- "method": "PUT",
- "title": "Move task to different status"
}, - "delete": {
- "href": "/api/v0.1/kanban/task/123e4567-e89b-12d3-a456-426614174000?version=3",
- "method": "DELETE",
- "title": "Soft delete task"
}, - "move-to-backlog": {
- "href": "/api/v0.1/kanban/task/123e4567-e89b-12d3-a456-426614174000/move",
- "method": "PUT",
- "title": "Move to Backlog"
}, - "move-to-todo": {
- "href": "/api/v0.1/kanban/task/123e4567-e89b-12d3-a456-426614174000/move",
- "method": "PUT",
- "title": "Move to To Do"
}, - "move-to-done": {
- "href": "/api/v0.1/kanban/task/123e4567-e89b-12d3-a456-426614174000/move",
- "method": "PUT",
- "title": "Move to Done"
}, - "move-to-closed": {
- "href": "/api/v0.1/kanban/task/123e4567-e89b-12d3-a456-426614174000/move",
- "method": "PUT",
- "title": "Move to Closed"
}, - "move-to-cancelled": {
- "href": "/api/v0.1/kanban/task/123e4567-e89b-12d3-a456-426614174000/move",
- "method": "PUT",
- "title": "Move to Cancelled"
}, - "unflag": {
- "href": "/api/v0.1/kanban/task/123e4567-e89b-12d3-a456-426614174000",
- "method": "PUT",
- "title": "Unflag task"
}, - "members": {
- "href": "/api/v0.2/member",
- "method": "GET",
- "title": "Get assignable users"
}, - "comments": {
- "href": "/api/v0.1/kanban/task/123e4567-e89b-12d3-a456-426614174000/comment",
- "method": "GET",
- "title": "Get all comments for this task"
}, - "add-comment": {
- "href": "/api/v0.1/kanban/task/123e4567-e89b-12d3-a456-426614174000/comment",
- "method": "POST",
- "title": "Add a comment to this task"
}
}, - "_embedded": {
- "events": [
- {
- "eventId": "evt-001",
- "eventType": "TASK_CREATED",
- "timestamp": "2025-01-15T10:30:00Z",
- "userId": "user-123",
- "payload": {
- "title": "Implement dark mode",
- "status": "BACKLOG"
}
}
]
}
}Retrieves a paginated list of tasks for your organisation in HAL+JSON format.
Response Format (HAL+JSON):
_embedded.tasks: Array of task objects_links: Hypermedia links (self, next, prev, last, create)page: Pagination metadataEach task includes:
_links object with available actions based on task stateHATEOAS Links: Each task includes state-driven links showing available actions:
self: Link to task details with full event historyupdate: Link to update task propertiesmove: Link to move task to different statusdelete: Link to soft delete task (includes version)flag/unflag: Toggle flag based on current statereopen: For DONE/CLOSED/CANCELLED tasksFiltering: Combine multiple filters to narrow results:
?status=IN_PROGRESS?assignedUserId=uuid?flagged=true?deleted=truePagination:
page parameter for page number (0-based)size parameter for page size (max: 100)sort for ordering (e.g., position,asc or createdAt,desc)Position Ordering:
position,asc to get tasks in display order for Kanban columnsPerformance: This endpoint is optimized for list views and does NOT include event history. To get full event history, use GET /api/v0.2/kanban/task/{id}.
Use Cases:
?status=IN_PROGRESS&sort=position,asc?assignedUserId={userId}?flagged=true?sort=createdAt,desc&size=10?deleted=true (for admin/recovery)| status | string Enum: "BACKLOG" "TO_DO" "IN_PROGRESS" "DONE" "CLOSED" "CANCELLED" Filter by task status |
| assignedUserId | string <uuid> Filter by assigned user UUID |
| flagged | boolean Filter by flagged status |
required | object (Pageable) |
| organisation-id required | string <uuid> Organisation UUID from header |
{- "_embedded": {
- "tasks": [
- {
- "contextId": "uuid-123",
- "title": "Implement authentication",
- "status": "IN_PROGRESS",
- "version": 5,
- "imageIds": [
- "550e8400-e29b-41d4-a716-446655440000"
], - "_links": {
- "self": {
- "href": "/api/v0.2/kanban/task/uuid-123"
}, - "update": {
- "href": "/api/v0.2/kanban/task/uuid-123",
- "method": "PUT"
}
}
}
]
}, - "_links": {
- "self": {
- "href": "/api/v0.2/kanban/task?page=0&size=20"
}, - "next": {
- "href": "/api/v0.2/kanban/task?page=1&size=20"
}
}, - "page": {
- "size": 20,
- "totalElements": 42,
- "totalPages": 3,
- "number": 0
}
}Retrieves metadata needed to create a new task in HAL+JSON format.
Response includes:
HATEOAS Links:
self: Link to this metadata endpointcreate: Link to create new task (POST /api/v0.2/kanban/task)members: Link to get organization members for assignment (GET /api/v0.2/member/)Use Cases:
Client Workflow:
members link to fetch assignable userscreate link to POST new taskStatus Options: Each status includes:
value: Enum value (e.g., "BACKLOG", "TO_DO")description: Human-readable explanationisDefault: Whether this is the default status (BACKLOG = true)| organisation-id required | string <uuid> Organisation UUID from header |
{- "availableStatuses": [
- {
- "value": "BACKLOG",
- "description": "Task is planned but not yet ready to work on",
- "isDefault": true
}, - {
- "value": "TO_DO",
- "description": "Task is ready to be picked up",
- "isDefault": false
}, - {
- "value": "IN_PROGRESS",
- "description": "Someone is currently working on this task",
- "isDefault": false
}, - {
- "value": "DONE",
- "description": "Task is completed",
- "isDefault": false
}, - {
- "value": "CLOSED",
- "description": "Task is completed and approved",
- "isDefault": false
}, - {
- "value": "CANCELLED",
- "description": "Task was cancelled and won't be completed",
- "isDefault": false
}
], - "_links": {
- "self": {
- "href": "/api/v0.2/kanban/task/new"
}, - "create": {
- "href": "/api/v0.2/kanban/task",
- "method": "POST",
- "title": "Create new task"
}, - "members": {
- "href": "/api/v0.2/member/",
- "method": "GET",
- "title": "Get assignable users"
}
}
}Retrieves a single task with its complete event history in HAL+JSON format.
Response includes:
imageIds: List of confirmed image IDs - fetch each via GET /api/v0.2/image/{imageId}_links: HATEOAS links for all available actions_embedded.events: Complete event history (audit log)Event History: Shows every change made to the task since creation. Event types are sealed:
Event Fields:
HATEOAS Links:
The _links object shows ALL available actions based on current state:
Query Parameters:
includeHistory: Set to false to exclude event history (default: true)historySortOrder: Sort events by timestamp (asc or desc, default: desc)Use Cases:
?includeHistory=false for faster responsePerformance Note: Including event history requires joining with event store. For list views, use GET /api/v0.2/kanban/task instead (no history).
| taskId required | string <uuid> Task ID |
| includeHistory | boolean Default: true Include event history (default: true) |
| organisation-id required | string <uuid> Organisation UUID from header |
Task Detail with Comments Links
{- "contextId": "123e4567-e89b-12d3-a456-426614174000",
- "title": "Implement dark mode",
- "description": "Add dark mode toggle to application settings",
- "assignedUserId": "987fcdeb-51a2-43f1-9876-fedcba987654",
- "status": "IN_PROGRESS",
- "position": 2,
- "taskNumber": 42,
- "flagged": true,
- "version": 3,
- "imageIds": [
- "550e8400-e29b-41d4-a716-446655440000"
], - "createdAt": "2025-01-15T10:30:00Z",
- "updatedAt": "2025-01-16T14:20:00Z",
- "_links": {
- "self": {
- "href": "/api/v0.2/kanban/task/123e4567-e89b-12d3-a456-426614174000"
}, - "collection": {
- "href": "/api/v0.2/kanban/task",
- "title": "All tasks"
}, - "update": {
- "href": "/api/v0.2/kanban/task/123e4567-e89b-12d3-a456-426614174000",
- "method": "PUT",
- "title": "Update task properties"
}, - "move": {
- "href": "/api/v0.2/kanban/task/123e4567-e89b-12d3-a456-426614174000/move",
- "method": "PUT",
- "title": "Move task to different status"
}, - "delete": {
- "href": "/api/v0.2/kanban/task/123e4567-e89b-12d3-a456-426614174000?version=3",
- "method": "DELETE",
- "title": "Soft delete task"
}, - "move-to-backlog": {
- "href": "/api/v0.2/kanban/task/123e4567-e89b-12d3-a456-426614174000/move",
- "method": "PUT",
- "title": "Move to Backlog"
}, - "move-to-todo": {
- "href": "/api/v0.2/kanban/task/123e4567-e89b-12d3-a456-426614174000/move",
- "method": "PUT",
- "title": "Move to To Do"
}, - "move-to-done": {
- "href": "/api/v0.2/kanban/task/123e4567-e89b-12d3-a456-426614174000/move",
- "method": "PUT",
- "title": "Move to Done"
}, - "move-to-closed": {
- "href": "/api/v0.2/kanban/task/123e4567-e89b-12d3-a456-426614174000/move",
- "method": "PUT",
- "title": "Move to Closed"
}, - "move-to-cancelled": {
- "href": "/api/v0.2/kanban/task/123e4567-e89b-12d3-a456-426614174000/move",
- "method": "PUT",
- "title": "Move to Cancelled"
}, - "unflag": {
- "href": "/api/v0.2/kanban/task/123e4567-e89b-12d3-a456-426614174000",
- "method": "PUT",
- "title": "Unflag task"
}, - "members": {
- "href": "/api/v0.2/member",
- "method": "GET",
- "title": "Get assignable users"
}, - "comments": {
- "href": "/api/v0.2/kanban/task/123e4567-e89b-12d3-a456-426614174000/comment",
- "method": "GET",
- "title": "Get all comments for this task"
}, - "add-comment": {
- "href": "/api/v0.2/kanban/task/123e4567-e89b-12d3-a456-426614174000/comment",
- "method": "POST",
- "title": "Add a comment to this task"
}
}, - "_embedded": {
- "events": [
- {
- "eventId": "evt-001",
- "eventType": "TASK_CREATED",
- "timestamp": "2025-01-15T10:30:00Z",
- "userId": "user-123",
- "payload": {
- "title": "Implement dark mode",
- "status": "BACKLOG"
}
}
]
}
}Returns HATEOAS links for the specified application.
Available applications:
FLEET: Fleet management application linksResponse includes navigation links to:
activity: User activity listanalytics: Analytics dashboard| app required | string Example: app=FLEET Application identifier |
{- "_links": {
- "activity": {
- "href": "/api/v0.1/analytics"
}, - "analytics": {
- "href": "/api/v0.1/analytics"
}, - "catalog": {
- "href": "/api/v0.1/analytics"
}, - "checklist": {
- "href": "/api/v0.1/analytics"
}, - "coupling": {
- "href": "/api/v0.1/analytics"
}, - "dashboard": {
- "href": "/api/v0.1/analytics"
}, - "equipment": {
- "href": "/api/v0.1/analytics"
}, - "event": {
- "href": "/api/v0.1/analytics"
}, - "handover": {
- "href": "/api/v0.1/analytics"
}, - "issues": {
- "href": "/api/v0.1/analytics"
}, - "kanban": {
- "href": "/api/v0.1/analytics"
}, - "maintenance": {
- "href": "/api/v0.1/analytics"
}, - "map": {
- "href": "/api/v0.1/analytics"
}, - "organisation": {
- "href": "/api/v0.1/analytics"
}, - "profile": {
- "href": "/api/v0.1/analytics"
}, - "refueling": {
- "href": "/api/v0.1/analytics"
}, - "report": {
- "href": "/api/v0.1/analytics"
}, - "self": {
- "href": "/api/v0.1/analytics"
}, - "settings": {
- "href": "/api/v0.1/analytics"
}, - "tire": {
- "href": "/api/v0.1/analytics"
}, - "vehicles": {
- "href": "/api/v0.1/analytics"
}, - "warranty": {
- "href": "/api/v0.1/analytics"
}
}
}Returns all members of the specified organisation sorted by last name and first name
| organisation-id required | string <uuid> Organisation ID |
Deleted member
[- {
- "userId": "a25f2907-9940-4070-9e84-f55d16bfd98a",
- "firstName": "A",
- "lastName": "B",
- "enabled": true,
- "isManager": true,
- "appAccessEnabled": false,
- "appAccessNote": null
}
]Creates a new Member directly from office-provided details (e.g. a driver profile), without going through the User Invitation flow. Provisions a disabled, credential-less KeyCloak account upfront; App Access can be granted later via Activation. Requires manager privileges.
| organisation-id required | string <uuid> Organisation ID |
| email required | string <email> non-empty |
| firstName required | string non-empty |
| lastName required | string non-empty |
{- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string"
}Created member
{- "userId": "a25f2907-9940-4070-9e84-f55d16bfd98a",
- "firstName": "Jane",
- "lastName": "Doe",
- "enabled": true,
- "isManager": false,
- "appAccessEnabled": false,
- "appAccessNote": null
}Updates a member's enabled status and manager privileges. Requires manager privileges; a manager cannot update their own membership.
| organisation-id required | string <uuid> |
| appAccessEnabled | boolean |
| appAccessNote | string |
| enabled | boolean |
| firstName | string |
| isManager | boolean |
| lastName | string |
| userId required | string <uuid> |
{- "appAccessEnabled": true,
- "appAccessNote": "string",
- "enabled": true,
- "firstName": "string",
- "isManager": true,
- "lastName": "string",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}Updated member
{- "userId": "a25f2907-9940-4070-9e84-f55d16bfd98a",
- "firstName": "u1",
- "lastName": "o1",
- "enabled": true,
- "isManager": true,
- "appAccessEnabled": true,
- "appAccessNote": null
}Returns the current user's membership details and privileges in the specified organisation
| organisation-id required | string <uuid> Organisation ID |
Member with active account
{- "userId": "a25f2907-9940-4070-9e84-f55d16bfd98a",
- "firstName": "John",
- "lastName": "Smith",
- "enabled": true,
- "isManager": false,
- "appAccessEnabled": true,
- "appAccessNote": null
}Returns a specific member by their user ID. Requires manager privileges.
| userId required | string <uuid> User ID of the member |
| organisation-id required | string <uuid> Organisation ID |
Active member
{- "userId": "a25f2907-9940-4070-9e84-f55d16bfd98a",
- "firstName": "u1",
- "lastName": "o1",
- "enabled": true,
- "isManager": true,
- "appAccessEnabled": true,
- "appAccessNote": null
}Grants App Access to a Member: enables their KeyCloak account and sends them an email to set their own password (Activation). The Member completes the setup themselves. Requires manager privileges; a manager cannot activate their own App Access. Independent of Member Enabled status.
| userId required | string <uuid> User ID of the member |
| organisation-id required | string <uuid> |
| note | string |
{- "note": "string"
}Activated member
{- "userId": "a25f2907-9940-4070-9e84-f55d16bfd98a",
- "firstName": "Jane",
- "lastName": "Doe",
- "enabled": true,
- "isManager": false,
- "appAccessEnabled": true,
- "appAccessNote": "Requested by office on 2024-01-15"
}Revokes App Access from a Member by disabling their KeyCloak account; no email is sent. Requires manager privileges; a manager cannot deactivate their own App Access. Independent of Member Enabled status.
| userId required | string <uuid> User ID of the member |
| organisation-id required | string <uuid> |
| note | string |
{- "note": "string"
}Deactivated member
{- "userId": "a25f2907-9940-4070-9e84-f55d16bfd98a",
- "firstName": "Jane",
- "lastName": "Doe",
- "enabled": true,
- "isManager": false,
- "appAccessEnabled": false,
- "appAccessNote": "No longer needs app access - office handles handovers"
}Retrieves paginated list of comments for any resource (task, vehicle, etc.).
Returns active (non-deleted) comments by default, sorted chronologically. Supports pagination via page, size, and sort parameters.
Response includes HATEOAS links for navigation (self, first, next, prev, last). Each comment includes state-driven action links (edit, delete) based on authorization.
| contextType required | string (ContextType) Enum: "task" "vehicle" "maintenance-order" "fuel-record" "task" "vehicle" "maintenance-order" "fuel-record" Example: task Type of parent resource |
required | object (ContextId) Example: 660e8400-e29b-41d4-a716-446655440000 Parent resource identifier |
| includeDeleted | boolean Default: false Include soft-deleted comments |
required | object (Pageable) Pagination parameters (page, size, sort) |
required | object (OrganisationId) Organisation identifier |
{- "_embedded": {
- "commentResponseList": [
- {
- "commentId": "550e8400-e29b-41d4-a716-446655440000",
- "contextType": "task",
- "contextId": "660e8400-e29b-41d4-a716-446655440000",
- "content": "Updated authentication logic",
- "authorUserId": "770e8400-e29b-41d4-a716-446655440000",
- "deleted": false,
- "deletedAt": null,
- "version": 1,
- "createdAt": "2025-12-26T10:00:00",
- "updatedAt": "2025-12-26T10:00:00",
- "_links": {
- "self": {
- "href": "/api/v0.1/comment/task/660e8400.../550e8400..."
}, - "context": {
- "href": "/api/v0.1/kanban/task/660e8400...",
- "title": "View task"
}, - "edit": {
- "href": "/api/v0.1/comment/task/660e8400.../550e8400...",
- "method": "PUT",
- "title": "Edit this comment"
}, - "delete": {
- "href": "/api/v0.1/comment/task/660e8400.../550e8400...?version=1",
- "method": "DELETE",
- "title": "Delete this comment"
}
}
}
]
}, - "_links": {
- "self": {
- "href": "/api/v0.1/comment/task/660e8400...?page=0&size=20"
}, - "first": {
- "href": "/api/v0.1/comment/task/660e8400...?page=0&size=20"
}, - "last": {
- "href": "/api/v0.1/comment/task/660e8400...?page=2&size=20"
}
}, - "page": {
- "size": 20,
- "number": 0,
- "totalElements": 45,
- "totalPages": 3
}
}Returns a list of all vehicles belonging to the specified organisation, filtered by enabled status
| organisationId required | string <uuid> Organisation ID |
| enabled | boolean Default: true Example: enabled=true Filter by enabled status |
Vehicle list
[- {
- "vehicleId": "a25f2907-9940-4070-9e84-f55d16bfd98a",
- "axesCount": 2,
- "vin": "WBA12345678901234",
- "registration": "KR12345",
- "brandId": "b35f2907-9940-4070-9e84-f55d16bfd98b",
- "brandName": "BMW",
- "modelId": "c45f2907-9940-4070-9e84-f55d16bfd98c",
- "modelName": "X3",
- "registrationDate": "2023-01-15",
- "firstRegistrationInCountryDate": "2023-01-20",
- "productionDate": "2022-12-01",
- "color": "BLACK",
- "distanceUnit": "KM",
- "remarks": "Company car",
- "enabled": true,
- "destinationId": "d55f2907-9940-4070-9e84-f55d16bfd98d",
- "trailer": false,
- "trailerMillage": false,
- "dutyStatus": "OK",
- "maintenanceStatus": "WARN",
- "taskStatus": "OK",
- "createdTimestamp": "2023-01-15T10:30:00",
- "updatedTimestamp": "2024-06-20T14:45:00",
- "createdPersonId": "e65f2907-9940-4070-9e84-f55d16bfd98e",
- "updatedPersonId": "e65f2907-9940-4070-9e84-f55d16bfd98e",
- "_links": {
- "self": {
- "href": "/api/v1.5/f75f2907-9940-4070-9e84-f55d16bfd98f/vehicles/a25f2907-9940-4070-9e84-f55d16bfd98a"
}, - "maintenances": {
- "href": "/api/v0.1/analytics?columns=maintenanceId&columns=operationDate&columns=vehicleId&columns=createdBy&filter=entity%3DMAINTENANCE&filter=vehicleId%3Da25f2907-9940-4070-9e84-f55d16bfd98a&sort=-operationDate®ister=PROJECTION"
}, - "maintenances_latest": {
- "href": "/api/v0.1/analytics?columns=maintenanceId&columns=operationDate&columns=vehicleId&columns=createdBy&filter=entity%3DMAINTENANCE&filter=vehicleId%3Da25f2907-9940-4070-9e84-f55d16bfd98a&sort=-operationDate®ister=PROJECTION&size=5&page=0"
}
}
}
]Creates a new vehicle in the organisation.
Image attachment (optional):
POST /api/v0.1/image with responsibleService: VEHICLEimageId valuesimageIds field of this request
Images not confirmed via imageIds will be removed by the background housekeeping job.| organisationId required | string <uuid> |
| color | string (VehicleColor) Enum: "BLACK" "WHITE" "GRAY" "RED" "BLUE" "GREEN" "DARK_BLUE" "SILVER" |
| destinationId required | string <uuid> |
| enabled | boolean |
| firstRegistrationInCountryDate | string <date> |
| imageIds | Array of strings <uuid> [ items <uuid > ] |
| modelId required | string <uuid> |
| productionDate | string <date> |
| registration required | string non-empty |
| registrationDate | string <date> |
| remarks required | string |
| trailerMillage required | boolean |
| vin | string |
{- "color": "BLACK",
- "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
- "enabled": true,
- "firstRegistrationInCountryDate": "2019-08-24",
- "imageIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
- "productionDate": "2019-08-24",
- "registration": "string",
- "registrationDate": "2019-08-24",
- "remarks": "string",
- "trailerMillage": true,
- "vin": "string"
}{- "_links": {
- "maintenances": {
- "href": "/api/v0.1/analytics?entity=MAINTENANCE"
}, - "maintenances_latest": {
- "href": "/api/v0.1/analytics?entity=MAINTENANCE"
}, - "self": {
- "href": "/api/v1.5/{organisationId}/vehicles/{vehicleId}"
}
}, - "axesCount": 0,
- "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
- "brandName": "string",
- "color": "BLACK",
- "createdPersonId": "725aa23d-feb7-48a8-9f3f-3bed04243ae5",
- "createdTimestamp": "2019-08-24T14:15:22Z",
- "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
- "distanceUnit": "KILOMETER",
- "dutyStatus": "ERROR",
- "enabled": true,
- "firstRegistrationInCountryDate": "2019-08-24",
- "imageIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "maintenanceStatus": "ERROR",
- "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
- "modelName": "string",
- "productionDate": "2019-08-24",
- "registration": "string",
- "registrationDate": "2019-08-24",
- "remarks": "string",
- "taskStatus": "ERROR",
- "trailer": true,
- "trailerMillage": true,
- "updatedPersonId": "94de6710-6ec2-42e9-b486-8ddb836e206e",
- "updatedTimestamp": "2019-08-24T14:15:22Z",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
- "vin": "string"
}Returns a specific vehicle by its ID within the organisation
| organisationId required | string <uuid> Organisation ID |
| vehicleId required | string <uuid> Vehicle ID |
Vehicle response
{- "vehicleId": "9026e67c-309f-409d-affc-0b78f0b0db92",
- "axesCount": 2,
- "vin": null,
- "registration": "RZ09876",
- "brandId": "b35f2907-9940-4070-9e84-f55d16bfd98b",
- "brandName": "BMW",
- "modelId": "60ca8601-5639-43cd-a1ba-dd7e248112c3",
- "modelName": "320i",
- "registrationDate": "2015-01-01",
- "firstRegistrationInCountryDate": null,
- "productionDate": null,
- "color": null,
- "distanceUnit": "MILE",
- "remarks": "Drive carefully",
- "enabled": true,
- "destinationId": "2d68b5d6-3494-49ca-84e8-6dfe34f148a9",
- "trailer": false,
- "trailerMillage": false,
- "dutyStatus": null,
- "maintenanceStatus": null,
- "taskStatus": null,
- "createdTimestamp": "2020-01-02T10:11:12",
- "updatedTimestamp": "2020-02-03T11:12:13",
- "createdPersonId": "e65f2907-9940-4070-9e84-f55d16bfd98e",
- "updatedPersonId": "e65f2907-9940-4070-9e84-f55d16bfd98e"
}Updates an existing vehicle.
Image attachment (optional):
POST /api/v0.1/image with responsibleService: VEHICLEimageId valuesimageIds field of this request
Only newly uploaded (unconfirmed) images need to be listed - existing confirmed images are unaffected.
Images uploaded but not included here will be removed by the background housekeeping job.| organisationId required | string <uuid> |
| vehicleId required | string <uuid> |
| color | string (VehicleColor) Enum: "BLACK" "WHITE" "GRAY" "RED" "BLUE" "GREEN" "DARK_BLUE" "SILVER" |
| destinationId required | string <uuid> |
| enabled | boolean |
| firstRegistrationInCountryDate | string <date> |
| imageIds | Array of strings <uuid> [ items <uuid > ] |
| modelId required | string <uuid> |
| productionDate | string <date> |
| registration required | string non-empty |
| registrationDate | string <date> |
| remarks required | string |
| trailerMillage required | boolean |
| vin | string |
{- "color": "BLACK",
- "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
- "enabled": true,
- "firstRegistrationInCountryDate": "2019-08-24",
- "imageIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
- "productionDate": "2019-08-24",
- "registration": "string",
- "registrationDate": "2019-08-24",
- "remarks": "string",
- "trailerMillage": true,
- "vin": "string"
}{- "_links": {
- "maintenances": {
- "href": "/api/v0.1/analytics?entity=MAINTENANCE"
}, - "maintenances_latest": {
- "href": "/api/v0.1/analytics?entity=MAINTENANCE"
}, - "self": {
- "href": "/api/v1.5/{organisationId}/vehicles/{vehicleId}"
}
}, - "axesCount": 0,
- "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
- "brandName": "string",
- "color": "BLACK",
- "createdPersonId": "725aa23d-feb7-48a8-9f3f-3bed04243ae5",
- "createdTimestamp": "2019-08-24T14:15:22Z",
- "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
- "distanceUnit": "KILOMETER",
- "dutyStatus": "ERROR",
- "enabled": true,
- "firstRegistrationInCountryDate": "2019-08-24",
- "imageIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "maintenanceStatus": "ERROR",
- "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
- "modelName": "string",
- "productionDate": "2019-08-24",
- "registration": "string",
- "registrationDate": "2019-08-24",
- "remarks": "string",
- "taskStatus": "ERROR",
- "trailer": true,
- "trailerMillage": true,
- "updatedPersonId": "94de6710-6ec2-42e9-b486-8ddb836e206e",
- "updatedTimestamp": "2019-08-24T14:15:22Z",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
- "vin": "string"
}Stores a batch of raw beacon sightings. No business rules (coupling detection, trailer attach/detach) are evaluated in this call - those run downstream from the raw event log.
Identity: observerUserId is taken from the authenticated principal, not from the request body.
Beacon resolution: each item is resolved by (proximityUuid, major, minor) against all beacons visible to the caller. Outcomes:
firstSeenAt (if null) and lastSeenAt updated on the beaconunknownBeaconIndicesambiguousBeaconIndicesTimestamp window: items with observedAt more than 24 h in the past or more than 5 min in the future are rejected and reported in invalidTimestampIndices.
Transaction: all accepted observations are inserted in a single transaction; rejected items have no side effect.
Batch limit: 500 observations per request. Larger batches return 413 Payload Too Large.
required | Array of objects (ObservationItem) [ 1 .. 500 ] characters [ 0 .. 500 ] items [ items [ 1 .. 500 ] characters ] Beacon sightings in chronological order. Each item is resolved independently against the caller's beacons. |
required | object (ObserverDescriptor) Self-description of the device sending the batch. |
Two-beacon sighting from a moving truck
{- "observer": {
- "deviceId": "iPhone-1A2B3C4D",
- "appVersion": "1.0"
}, - "observations": [
- {
- "proximityUuid": "E2C56DB5-DFFB-48D2-B060-D0F5A71096E0",
- "major": 1001,
- "minor": 1,
- "observedAt": "2026-05-27T22:15:43.512Z",
- "rssi": -52,
- "accuracy": 0.8,
- "proximity": "IMMEDIATE",
- "location": {
- "latitude": 52.2297,
- "longitude": 21.0122,
- "gpsAccuracy": 8,
- "speedMps": 18.4
}
}, - {
- "proximityUuid": "E2C56DB5-DFFB-48D2-B060-D0F5A71096E0",
- "major": 2042,
- "minor": 7,
- "observedAt": "2026-05-27T22:15:43.512Z",
- "rssi": -71,
- "accuracy": 2.6,
- "proximity": "NEAR",
- "location": {
- "latitude": 52.2297,
- "longitude": 21.0122,
- "gpsAccuracy": 8,
- "speedMps": 18.4
}
}
]
}{ "acceptedCount": 18, "unknownBeaconIndices": [ 3, 7 ], "ambiguousBeaconIndices": [], "invalidTimestampIndices": [] }
[- {
- "comment": "Contact person John Doe I",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "fuelSupplierId": "4b36bd9b-7b78-491a-989d-af9809b3d3c0",
- "name": "Global Track Warehouse",
- "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}
]| organisation-id required | string <uuid> |
| comment | string Additional unstructured comment |
| name required | string non-empty Name of the fuel supplier |
{- "comment": "Contact person John Doe I",
- "name": "Global Track Warehouse"
}{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}| fuelSupplierId required | string <uuid> |
| organisation-id required | string <uuid> |
{- "comment": "Contact person John Doe I",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "fuelSupplierId": "4b36bd9b-7b78-491a-989d-af9809b3d3c0",
- "name": "Global Track Warehouse",
- "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}| fuelSupplierId required | string <uuid> |
| organisation-id required | string <uuid> |
| comment | string Additional unstructured comment |
| name required | string non-empty Name of the fuel supplier |
{- "comment": "Contact person John Doe I",
- "name": "Global Track Warehouse"
}{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}Retrieves all active (not done) maintenance requests for the user's organization with HATEOAS links
{- "_embedded": {
- "maintenanceOrder": [
- {
- "_links": {
- "property1": {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}, - "property2": {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}
}, - "atKilometers": 0,
- "createDate": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "cyclical": true,
- "done": true,
- "doneDate": "2019-08-24T14:15:22Z",
- "doneUserId": "72ce7f1e-7f2a-4fa5-9f68-3495d76fbecd",
- "editDate": "2019-08-24T14:15:22Z",
- "editUserId": "b8cb20cd-fd09-4975-ad6b-1f7347c2e8ed",
- "everyDays": 0,
- "expirationDate": "2019-08-24",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "inspRequest": "string",
- "status": "UNSET",
- "vehicleBrand": "string",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
- "vehicleModel": "string",
- "vehicleRegistration": "string"
}
]
}, - "_links": {
- "property1": {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}, - "property2": {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}
}
}Retrieves all maintenance requests for a specific vehicle with HATEOAS links
| vehicleId required | string <uuid> Vehicle ID |
{- "_embedded": {
- "maintenanceOrder": [
- {
- "_links": {
- "property1": {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}, - "property2": {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}
}, - "atKilometers": 0,
- "createDate": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "cyclical": true,
- "done": true,
- "doneDate": "2019-08-24T14:15:22Z",
- "doneUserId": "72ce7f1e-7f2a-4fa5-9f68-3495d76fbecd",
- "editDate": "2019-08-24T14:15:22Z",
- "editUserId": "b8cb20cd-fd09-4975-ad6b-1f7347c2e8ed",
- "everyDays": 0,
- "expirationDate": "2019-08-24",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "inspRequest": "string",
- "status": "UNSET",
- "vehicleBrand": "string",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
- "vehicleModel": "string",
- "vehicleRegistration": "string"
}
]
}, - "_links": {
- "property1": {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}, - "property2": {
- "deprecation": "string",
- "href": "string",
- "hreflang": "string",
- "name": "string",
- "profile": "string",
- "templated": true,
- "title": "string",
- "type": "string"
}
}
}Creates a new maintenance request for a vehicle with optional image attachment
| vehicleId required | string <uuid> Vehicle ID |
| file | string <binary> |
required | object (MaintenanceRequestDTOV04) |
{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}Retrieves a specific maintenance request with HATEOAS links
| maintenanceRequestId required | string <uuid> Maintenance request ID |
{- "atKilometers": 0,
- "createDate": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "cyclical": true,
- "done": true,
- "doneDate": "2019-08-24T14:15:22Z",
- "doneUserId": "72ce7f1e-7f2a-4fa5-9f68-3495d76fbecd",
- "editDate": "2019-08-24T14:15:22Z",
- "editUserId": "b8cb20cd-fd09-4975-ad6b-1f7347c2e8ed",
- "everyDays": 0,
- "expirationDate": "2019-08-24",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "inspRequest": "string",
- "status": "UNSET",
- "vehicleBrand": "string",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
- "vehicleModel": "string",
- "vehicleRegistration": "string"
}Updates an existing maintenance request with optional image replacement
| maintenanceRequestId required | string <uuid> Maintenance request ID |
| file | string <binary> |
required | object (MaintenanceRequestDTOV04) |
{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}Marks a maintenance request as done or undone. If marking as done for a cyclical request, creates a new request for the next cycle.
| maintenanceRequestId required | string <uuid> Maintenance request ID |
| done required | boolean |
| doneDate | string <date-time> |
| doneUserId | string <uuid> |
| id | string <uuid> |
{- "done": true,
- "doneDate": "2019-08-24T14:15:22Z",
- "doneUserId": "72ce7f1e-7f2a-4fa5-9f68-3495d76fbecd",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}{- "done": true,
- "doneDate": "2019-08-24T14:15:22Z",
- "doneUserId": "72ce7f1e-7f2a-4fa5-9f68-3495d76fbecd",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}Retrieves the image attached to a maintenance request
| maintenanceRequestId required | string <uuid> Maintenance request ID |
{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}[- {
- "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "description": "string",
- "name": "string",
- "organisationId": {
- "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5"
}, - "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}
]required | object (OrganisationId) |
| assetId | string <uuid> |
| createDateTime | string <date-time> |
| createUserId | string <uuid> |
| description | string |
| name | string |
object (OrganisationId) | |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
{- "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "description": "string",
- "name": "string",
- "organisationId": {
- "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5"
}, - "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}{- "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "description": "string",
- "name": "string",
- "organisationId": {
- "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5"
}, - "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}required | object (OrganisationId) |
| assetId | string <uuid> |
| createDateTime | string <date-time> |
| createUserId | string <uuid> |
| description | string |
| name | string |
object (OrganisationId) | |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
{- "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "description": "string",
- "name": "string",
- "organisationId": {
- "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5"
}, - "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}{- "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "description": "string",
- "name": "string",
- "organisationId": {
- "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5"
}, - "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}| assetId required | string <uuid> |
required | object (OrganisationId) |
{- "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "description": "string",
- "name": "string",
- "organisationId": {
- "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5"
}, - "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}[- {
- "amount": 0,
- "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
- "assetInstanceId": "605efab6-99a7-4ea3-8f61-391429fbad2b",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "deleted": true,
- "deletedDateTime": "2019-08-24T14:15:22Z",
- "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759",
- "organisationId": {
- "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5"
}, - "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}
]required | object (OrganisationId) |
| amount | integer <int32> |
| assetId | string <uuid> |
| assetInstanceId | string <uuid> |
| createDateTime | string <date-time> |
| createUserId | string <uuid> |
| deleted | boolean |
| deletedDateTime | string <date-time> |
| deletedUserId | string <uuid> |
object (OrganisationId) | |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
| vehicleId | string <uuid> |
{- "amount": 0,
- "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
- "assetInstanceId": "605efab6-99a7-4ea3-8f61-391429fbad2b",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "deleted": true,
- "deletedDateTime": "2019-08-24T14:15:22Z",
- "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759",
- "organisationId": {
- "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5"
}, - "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}{- "amount": 0,
- "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
- "assetInstanceId": "605efab6-99a7-4ea3-8f61-391429fbad2b",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "deleted": true,
- "deletedDateTime": "2019-08-24T14:15:22Z",
- "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759",
- "organisationId": {
- "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5"
}, - "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}required | object (OrganisationId) |
| amount | integer <int32> |
| assetId | string <uuid> |
| assetInstanceId | string <uuid> |
| createDateTime | string <date-time> |
| createUserId | string <uuid> |
| deleted | boolean |
| deletedDateTime | string <date-time> |
| deletedUserId | string <uuid> |
object (OrganisationId) | |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
| vehicleId | string <uuid> |
{- "amount": 0,
- "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
- "assetInstanceId": "605efab6-99a7-4ea3-8f61-391429fbad2b",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "deleted": true,
- "deletedDateTime": "2019-08-24T14:15:22Z",
- "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759",
- "organisationId": {
- "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5"
}, - "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}{- "amount": 0,
- "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
- "assetInstanceId": "605efab6-99a7-4ea3-8f61-391429fbad2b",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "deleted": true,
- "deletedDateTime": "2019-08-24T14:15:22Z",
- "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759",
- "organisationId": {
- "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5"
}, - "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}required | object (OrganisationId) |
| amount | integer <int32> |
| assetId | string <uuid> |
| assetInstanceId | string <uuid> |
| createDateTime | string <date-time> |
| createUserId | string <uuid> |
| deleted | boolean |
| deletedDateTime | string <date-time> |
| deletedUserId | string <uuid> |
object (OrganisationId) | |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
| vehicleId | string <uuid> |
{- "amount": 0,
- "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
- "assetInstanceId": "605efab6-99a7-4ea3-8f61-391429fbad2b",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "deleted": true,
- "deletedDateTime": "2019-08-24T14:15:22Z",
- "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759",
- "organisationId": {
- "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5"
}, - "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}{- "amount": 0,
- "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
- "assetInstanceId": "605efab6-99a7-4ea3-8f61-391429fbad2b",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "deleted": true,
- "deletedDateTime": "2019-08-24T14:15:22Z",
- "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759",
- "organisationId": {
- "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5"
}, - "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}| assetInstanceId required | string <uuid> |
required | object (OrganisationId) |
{- "amount": 0,
- "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
- "assetInstanceId": "605efab6-99a7-4ea3-8f61-391429fbad2b",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "deleted": true,
- "deletedDateTime": "2019-08-24T14:15:22Z",
- "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759",
- "organisationId": {
- "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5"
}, - "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}[- {
- "comment": "string",
- "dateCreated": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "items": [
- {
- "contentTypeId": "VEHICLE_MANUFACTURE_STATE",
- "format": "string",
- "objectId": "e39ea5f2-2188-47f8-add0-f1976630af5e",
- "objectRepr": "string",
- "serializedData": "string"
}
], - "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}
][- {
- "checklistId": "9c2471f0-7b0e-4603-bb5c-ee5fa92d766a",
- "closed": true,
- "closedDate": "2019-08-24T14:15:22Z",
- "closedUserId": "f33cf7f8-af45-40d7-bf15-cfa1fa469453",
- "comment": "string",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "description": "string",
- "items": [
- {
- "checked": true,
- "name": "string"
}
], - "name": "string",
- "operationDate": "2019-08-24",
- "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
- "template": true,
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}
]required | object (OrganisationId) |
| checklistId | string <uuid> |
| closed | boolean |
| closedDate | string <date-time> |
| closedUserId | string <uuid> |
| comment | string |
| createDateTime | string <date-time> |
| createUserId | string <uuid> |
| description | string |
Array of objects (ChecklistItemDTO) | |
| name | string |
| operationDate | string <date> |
| organisationId | string <uuid> |
| template | boolean |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
| vehicleId | string <uuid> |
{- "checklistId": "9c2471f0-7b0e-4603-bb5c-ee5fa92d766a",
- "closed": true,
- "closedDate": "2019-08-24T14:15:22Z",
- "closedUserId": "f33cf7f8-af45-40d7-bf15-cfa1fa469453",
- "comment": "string",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "description": "string",
- "items": [
- {
- "checked": true,
- "name": "string"
}
], - "name": "string",
- "operationDate": "2019-08-24",
- "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
- "template": true,
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}{- "checklistId": "9c2471f0-7b0e-4603-bb5c-ee5fa92d766a",
- "closed": true,
- "closedDate": "2019-08-24T14:15:22Z",
- "closedUserId": "f33cf7f8-af45-40d7-bf15-cfa1fa469453",
- "comment": "string",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "description": "string",
- "items": [
- {
- "checked": true,
- "name": "string"
}
], - "name": "string",
- "operationDate": "2019-08-24",
- "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
- "template": true,
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}required | object (OrganisationId) |
| checklistId | string <uuid> |
| closed | boolean |
| closedDate | string <date-time> |
| closedUserId | string <uuid> |
| comment | string |
| createDateTime | string <date-time> |
| createUserId | string <uuid> |
| description | string |
Array of objects (ChecklistItemDTO) | |
| name | string |
| operationDate | string <date> |
| organisationId | string <uuid> |
| template | boolean |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
| vehicleId | string <uuid> |
{- "checklistId": "9c2471f0-7b0e-4603-bb5c-ee5fa92d766a",
- "closed": true,
- "closedDate": "2019-08-24T14:15:22Z",
- "closedUserId": "f33cf7f8-af45-40d7-bf15-cfa1fa469453",
- "comment": "string",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "description": "string",
- "items": [
- {
- "checked": true,
- "name": "string"
}
], - "name": "string",
- "operationDate": "2019-08-24",
- "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
- "template": true,
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}{- "checklistId": "9c2471f0-7b0e-4603-bb5c-ee5fa92d766a",
- "closed": true,
- "closedDate": "2019-08-24T14:15:22Z",
- "closedUserId": "f33cf7f8-af45-40d7-bf15-cfa1fa469453",
- "comment": "string",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "description": "string",
- "items": [
- {
- "checked": true,
- "name": "string"
}
], - "name": "string",
- "operationDate": "2019-08-24",
- "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
- "template": true,
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}| checklistId required | string <uuid> |
required | object (OrganisationId) |
{- "checklistId": "9c2471f0-7b0e-4603-bb5c-ee5fa92d766a",
- "closed": true,
- "closedDate": "2019-08-24T14:15:22Z",
- "closedUserId": "f33cf7f8-af45-40d7-bf15-cfa1fa469453",
- "comment": "string",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "description": "string",
- "items": [
- {
- "checked": true,
- "name": "string"
}
], - "name": "string",
- "operationDate": "2019-08-24",
- "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
- "template": true,
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}| checklistId required | string <uuid> |
required | object (OrganisationId) |
{- "checklistId": "9c2471f0-7b0e-4603-bb5c-ee5fa92d766a",
- "closed": true,
- "closedDate": "2019-08-24T14:15:22Z",
- "closedUserId": "f33cf7f8-af45-40d7-bf15-cfa1fa469453",
- "comment": "string",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "description": "string",
- "items": [
- {
- "checked": true,
- "name": "string"
}
], - "name": "string",
- "operationDate": "2019-08-24",
- "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
- "template": true,
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}[- {
- "carBrand": "string",
- "carId": "566dcc5d-30ab-488e-96e1-c09dec523f18",
- "carModel": "string",
- "carRegistration": "string",
- "coupledDate": "2019-08-24",
- "coupledDistance": 0,
- "coupledPersonId": "6c41767c-738c-45d1-85ff-44593d0abedf",
- "coupledRemarks": "string",
- "coupledTrailerDistance": 0,
- "createDateTime": "2019-08-24T14:15:22Z",
- "decoupledDate": "2019-08-24",
- "decoupledDateTime": "2019-08-24T14:15:22Z",
- "decoupledDistance": 0,
- "decoupledPersonId": "e8698e97-a658-468a-8bc7-6a9cf8a6f1ac",
- "decoupledRemarks": "string",
- "decoupledTrailerDistance": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "trailerBrand": "string",
- "trailerId": "d519e634-43b4-4caf-a685-a90a28153574",
- "trailerModel": "string",
- "trailerRegistration": "string",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updatePersonId": "069b7006-3570-4408-a633-a325fbeb33e1"
}
]| carBrand | string |
| carId required | string <uuid> |
| carModel | string |
| carRegistration | string |
| coupledDate | string <date> |
| coupledDistance required | integer <int64> |
| coupledPersonId | string <uuid> |
| coupledRemarks | string |
| coupledTrailerDistance | integer <int64> |
| createDateTime | string <date-time> |
| decoupledDate | string <date> |
| decoupledDateTime | string <date-time> |
| decoupledDistance | integer <int64> |
| decoupledPersonId | string <uuid> |
| decoupledRemarks | string |
| decoupledTrailerDistance | integer <int64> |
| id | string <uuid> |
| trailerBrand | string |
| trailerId required | string <uuid> |
| trailerModel | string |
| trailerRegistration | string |
| updateDateTime | string <date-time> |
| updatePersonId | string <uuid> |
{- "carBrand": "string",
- "carId": "566dcc5d-30ab-488e-96e1-c09dec523f18",
- "carModel": "string",
- "carRegistration": "string",
- "coupledDate": "2019-08-24",
- "coupledDistance": 0,
- "coupledPersonId": "6c41767c-738c-45d1-85ff-44593d0abedf",
- "coupledRemarks": "string",
- "coupledTrailerDistance": 0,
- "createDateTime": "2019-08-24T14:15:22Z",
- "decoupledDate": "2019-08-24",
- "decoupledDateTime": "2019-08-24T14:15:22Z",
- "decoupledDistance": 0,
- "decoupledPersonId": "e8698e97-a658-468a-8bc7-6a9cf8a6f1ac",
- "decoupledRemarks": "string",
- "decoupledTrailerDistance": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "trailerBrand": "string",
- "trailerId": "d519e634-43b4-4caf-a685-a90a28153574",
- "trailerModel": "string",
- "trailerRegistration": "string",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updatePersonId": "069b7006-3570-4408-a633-a325fbeb33e1"
}{ }[- {
- "carBrand": "string",
- "carId": "566dcc5d-30ab-488e-96e1-c09dec523f18",
- "carModel": "string",
- "carRegistration": "string",
- "coupledDate": "2019-08-24",
- "coupledDistance": 0,
- "coupledPersonId": "6c41767c-738c-45d1-85ff-44593d0abedf",
- "coupledRemarks": "string",
- "coupledTrailerDistance": 0,
- "createDateTime": "2019-08-24T14:15:22Z",
- "decoupledDate": "2019-08-24",
- "decoupledDateTime": "2019-08-24T14:15:22Z",
- "decoupledDistance": 0,
- "decoupledPersonId": "e8698e97-a658-468a-8bc7-6a9cf8a6f1ac",
- "decoupledRemarks": "string",
- "decoupledTrailerDistance": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "trailerBrand": "string",
- "trailerId": "d519e634-43b4-4caf-a685-a90a28153574",
- "trailerModel": "string",
- "trailerRegistration": "string",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updatePersonId": "069b7006-3570-4408-a633-a325fbeb33e1"
}
]{- "coupleable": true,
- "couplings": [
- {
- "carBrand": "string",
- "carId": "566dcc5d-30ab-488e-96e1-c09dec523f18",
- "carModel": "string",
- "carRegistration": "string",
- "coupledDate": "2019-08-24",
- "coupledDistance": 0,
- "coupledPersonId": "6c41767c-738c-45d1-85ff-44593d0abedf",
- "coupledRemarks": "string",
- "coupledTrailerDistance": 0,
- "createDateTime": "2019-08-24T14:15:22Z",
- "decoupledDate": "2019-08-24",
- "decoupledDateTime": "2019-08-24T14:15:22Z",
- "decoupledDistance": 0,
- "decoupledPersonId": "e8698e97-a658-468a-8bc7-6a9cf8a6f1ac",
- "decoupledRemarks": "string",
- "decoupledTrailerDistance": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "trailerBrand": "string",
- "trailerId": "d519e634-43b4-4caf-a685-a90a28153574",
- "trailerModel": "string",
- "trailerRegistration": "string",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updatePersonId": "069b7006-3570-4408-a633-a325fbeb33e1"
}
]
}{- "carBrand": "string",
- "carId": "566dcc5d-30ab-488e-96e1-c09dec523f18",
- "carModel": "string",
- "carRegistration": "string",
- "coupledDate": "2019-08-24",
- "coupledDistance": 0,
- "coupledPersonId": "6c41767c-738c-45d1-85ff-44593d0abedf",
- "coupledRemarks": "string",
- "coupledTrailerDistance": 0,
- "createDateTime": "2019-08-24T14:15:22Z",
- "decoupledDate": "2019-08-24",
- "decoupledDateTime": "2019-08-24T14:15:22Z",
- "decoupledDistance": 0,
- "decoupledPersonId": "e8698e97-a658-468a-8bc7-6a9cf8a6f1ac",
- "decoupledRemarks": "string",
- "decoupledTrailerDistance": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "trailerBrand": "string",
- "trailerId": "d519e634-43b4-4caf-a685-a90a28153574",
- "trailerModel": "string",
- "trailerRegistration": "string",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updatePersonId": "069b7006-3570-4408-a633-a325fbeb33e1"
}| couplingId required | string <uuid> |
| carBrand | string |
| carId required | string <uuid> |
| carModel | string |
| carRegistration | string |
| coupledDate | string <date> |
| coupledDistance required | integer <int64> |
| coupledPersonId | string <uuid> |
| coupledRemarks | string |
| coupledTrailerDistance | integer <int64> |
| createDateTime | string <date-time> |
| decoupledDate | string <date> |
| decoupledDateTime | string <date-time> |
| decoupledDistance | integer <int64> |
| decoupledPersonId | string <uuid> |
| decoupledRemarks | string |
| decoupledTrailerDistance | integer <int64> |
| id | string <uuid> |
| trailerBrand | string |
| trailerId required | string <uuid> |
| trailerModel | string |
| trailerRegistration | string |
| updateDateTime | string <date-time> |
| updatePersonId | string <uuid> |
{- "carBrand": "string",
- "carId": "566dcc5d-30ab-488e-96e1-c09dec523f18",
- "carModel": "string",
- "carRegistration": "string",
- "coupledDate": "2019-08-24",
- "coupledDistance": 0,
- "coupledPersonId": "6c41767c-738c-45d1-85ff-44593d0abedf",
- "coupledRemarks": "string",
- "coupledTrailerDistance": 0,
- "createDateTime": "2019-08-24T14:15:22Z",
- "decoupledDate": "2019-08-24",
- "decoupledDateTime": "2019-08-24T14:15:22Z",
- "decoupledDistance": 0,
- "decoupledPersonId": "e8698e97-a658-468a-8bc7-6a9cf8a6f1ac",
- "decoupledRemarks": "string",
- "decoupledTrailerDistance": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "trailerBrand": "string",
- "trailerId": "d519e634-43b4-4caf-a685-a90a28153574",
- "trailerModel": "string",
- "trailerRegistration": "string",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updatePersonId": "069b7006-3570-4408-a633-a325fbeb33e1"
}{ }| vehicleId required | string <uuid> |
| date | string <date> |
{- "dailyDistance": 0.1,
- "distance": 0,
- "distanceUnit": "KILOMETER",
- "errorMessage": "string",
- "status": "OK",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}[- {
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "handoverId": "67143d15-44f0-4ced-839c-8a3899adfeba",
- "handoverState": "NEW",
- "imageIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "incomingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
- "incomingDriverApproved": true,
- "incomingDriverConditionOfVehicleComment": "string",
- "incomingDriverId": "104b6336-56dc-4281-bd24-a3c055c9a73c",
- "managerApprovalTimestamp": "2019-08-24T14:15:22Z",
- "managerApproved": true,
- "managerConditionOfVehicleComment": "string",
- "managerId": "b2c2c359-55f3-4680-a660-901475c7a693",
- "operationDate": "2019-08-24",
- "organisationId": "string",
- "outgoingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
- "outgoingDriverApproved": true,
- "outgoingDriverConditionOfVehicleComment": "string",
- "outgoingDriverId": "e2c72071-4035-4433-8231-f4dc75807e4a",
- "placeOfTransfer": "string",
- "reason": "string",
- "trailerChecklistId": "6b6dbbe8-1ea7-4c78-a9a3-46ac52311455",
- "trailerDistance": 0,
- "trailerId": "d519e634-43b4-4caf-a685-a90a28153574",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleChecklistId": "f2a8860b-c279-4c31-a168-cacc3decb98e",
- "vehicleDistance": 0,
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}
]required | object (OrganisationId) |
| createDateTime | string <date-time> |
| createUserId | string <uuid> |
| handoverId | string <uuid> |
| handoverState | string (HandoverState) Enum: "NEW" "WAITING_FOR_DRIVERS_APPROVAL" "WAITING_FOR_MANAGER_APPROVAL" "CLOSED_APPROVED" "CLOSED_REJECTED" |
| imageIds | Array of strings <uuid> [ items <uuid > ] |
| incomingDriverApprovalTimestamp | string <date-time> |
| incomingDriverApproved | boolean |
| incomingDriverConditionOfVehicleComment | string |
| incomingDriverId | string <uuid> |
| managerApprovalTimestamp | string <date-time> |
| managerApproved | boolean |
| managerConditionOfVehicleComment | string |
| managerId | string <uuid> |
| operationDate | string <date> |
| organisationId | string |
| outgoingDriverApprovalTimestamp | string <date-time> |
| outgoingDriverApproved | boolean |
| outgoingDriverConditionOfVehicleComment | string |
| outgoingDriverId | string <uuid> |
| placeOfTransfer | string |
| reason | string |
| trailerChecklistId | string <uuid> |
| trailerDistance | integer <int32> |
| trailerId | string <uuid> |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
| vehicleChecklistId | string <uuid> |
| vehicleDistance | integer <int32> |
| vehicleId | string <uuid> |
{- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "handoverId": "67143d15-44f0-4ced-839c-8a3899adfeba",
- "handoverState": "NEW",
- "imageIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "incomingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
- "incomingDriverApproved": true,
- "incomingDriverConditionOfVehicleComment": "string",
- "incomingDriverId": "104b6336-56dc-4281-bd24-a3c055c9a73c",
- "managerApprovalTimestamp": "2019-08-24T14:15:22Z",
- "managerApproved": true,
- "managerConditionOfVehicleComment": "string",
- "managerId": "b2c2c359-55f3-4680-a660-901475c7a693",
- "operationDate": "2019-08-24",
- "organisationId": "string",
- "outgoingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
- "outgoingDriverApproved": true,
- "outgoingDriverConditionOfVehicleComment": "string",
- "outgoingDriverId": "e2c72071-4035-4433-8231-f4dc75807e4a",
- "placeOfTransfer": "string",
- "reason": "string",
- "trailerChecklistId": "6b6dbbe8-1ea7-4c78-a9a3-46ac52311455",
- "trailerDistance": 0,
- "trailerId": "d519e634-43b4-4caf-a685-a90a28153574",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleChecklistId": "f2a8860b-c279-4c31-a168-cacc3decb98e",
- "vehicleDistance": 0,
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}{- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "handoverId": "67143d15-44f0-4ced-839c-8a3899adfeba",
- "handoverState": "NEW",
- "imageIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "incomingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
- "incomingDriverApproved": true,
- "incomingDriverConditionOfVehicleComment": "string",
- "incomingDriverId": "104b6336-56dc-4281-bd24-a3c055c9a73c",
- "managerApprovalTimestamp": "2019-08-24T14:15:22Z",
- "managerApproved": true,
- "managerConditionOfVehicleComment": "string",
- "managerId": "b2c2c359-55f3-4680-a660-901475c7a693",
- "operationDate": "2019-08-24",
- "organisationId": "string",
- "outgoingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
- "outgoingDriverApproved": true,
- "outgoingDriverConditionOfVehicleComment": "string",
- "outgoingDriverId": "e2c72071-4035-4433-8231-f4dc75807e4a",
- "placeOfTransfer": "string",
- "reason": "string",
- "trailerChecklistId": "6b6dbbe8-1ea7-4c78-a9a3-46ac52311455",
- "trailerDistanceId": "6ef67421-49f8-4042-bd6c-3208c828216f",
- "trailerId": "d519e634-43b4-4caf-a685-a90a28153574",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleChecklistId": "f2a8860b-c279-4c31-a168-cacc3decb98e",
- "vehicleDistanceId": "d0447fbf-4ed2-421e-adb1-7c226e9f4b17",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}required | object (OrganisationId) |
| createDateTime | string <date-time> |
| createUserId | string <uuid> |
| handoverId | string <uuid> |
| handoverState | string (HandoverState) Enum: "NEW" "WAITING_FOR_DRIVERS_APPROVAL" "WAITING_FOR_MANAGER_APPROVAL" "CLOSED_APPROVED" "CLOSED_REJECTED" |
| imageIds | Array of strings <uuid> [ items <uuid > ] |
| incomingDriverApprovalTimestamp | string <date-time> |
| incomingDriverApproved | boolean |
| incomingDriverConditionOfVehicleComment | string |
| incomingDriverId | string <uuid> |
| managerApprovalTimestamp | string <date-time> |
| managerApproved | boolean |
| managerConditionOfVehicleComment | string |
| managerId | string <uuid> |
| operationDate | string <date> |
| organisationId | string |
| outgoingDriverApprovalTimestamp | string <date-time> |
| outgoingDriverApproved | boolean |
| outgoingDriverConditionOfVehicleComment | string |
| outgoingDriverId | string <uuid> |
| placeOfTransfer | string |
| reason | string |
| trailerChecklistId | string <uuid> |
| trailerDistance | integer <int32> |
| trailerId | string <uuid> |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
| vehicleChecklistId | string <uuid> |
| vehicleDistance | integer <int32> |
| vehicleId | string <uuid> |
{- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "handoverId": "67143d15-44f0-4ced-839c-8a3899adfeba",
- "handoverState": "NEW",
- "imageIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "incomingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
- "incomingDriverApproved": true,
- "incomingDriverConditionOfVehicleComment": "string",
- "incomingDriverId": "104b6336-56dc-4281-bd24-a3c055c9a73c",
- "managerApprovalTimestamp": "2019-08-24T14:15:22Z",
- "managerApproved": true,
- "managerConditionOfVehicleComment": "string",
- "managerId": "b2c2c359-55f3-4680-a660-901475c7a693",
- "operationDate": "2019-08-24",
- "organisationId": "string",
- "outgoingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
- "outgoingDriverApproved": true,
- "outgoingDriverConditionOfVehicleComment": "string",
- "outgoingDriverId": "e2c72071-4035-4433-8231-f4dc75807e4a",
- "placeOfTransfer": "string",
- "reason": "string",
- "trailerChecklistId": "6b6dbbe8-1ea7-4c78-a9a3-46ac52311455",
- "trailerDistance": 0,
- "trailerId": "d519e634-43b4-4caf-a685-a90a28153574",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleChecklistId": "f2a8860b-c279-4c31-a168-cacc3decb98e",
- "vehicleDistance": 0,
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}{- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "handoverId": "67143d15-44f0-4ced-839c-8a3899adfeba",
- "handoverState": "NEW",
- "imageIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "incomingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
- "incomingDriverApproved": true,
- "incomingDriverConditionOfVehicleComment": "string",
- "incomingDriverId": "104b6336-56dc-4281-bd24-a3c055c9a73c",
- "managerApprovalTimestamp": "2019-08-24T14:15:22Z",
- "managerApproved": true,
- "managerConditionOfVehicleComment": "string",
- "managerId": "b2c2c359-55f3-4680-a660-901475c7a693",
- "operationDate": "2019-08-24",
- "organisationId": "string",
- "outgoingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
- "outgoingDriverApproved": true,
- "outgoingDriverConditionOfVehicleComment": "string",
- "outgoingDriverId": "e2c72071-4035-4433-8231-f4dc75807e4a",
- "placeOfTransfer": "string",
- "reason": "string",
- "trailerChecklistId": "6b6dbbe8-1ea7-4c78-a9a3-46ac52311455",
- "trailerDistanceId": "6ef67421-49f8-4042-bd6c-3208c828216f",
- "trailerId": "d519e634-43b4-4caf-a685-a90a28153574",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleChecklistId": "f2a8860b-c279-4c31-a168-cacc3decb98e",
- "vehicleDistanceId": "d0447fbf-4ed2-421e-adb1-7c226e9f4b17",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}required | object (OrganisationId) |
| createDateTime | string <date-time> |
| createUserId | string <uuid> |
| handoverId | string <uuid> |
| handoverState | string (HandoverState) Enum: "NEW" "WAITING_FOR_DRIVERS_APPROVAL" "WAITING_FOR_MANAGER_APPROVAL" "CLOSED_APPROVED" "CLOSED_REJECTED" |
| imageIds | Array of strings <uuid> [ items <uuid > ] |
| incomingDriverApprovalTimestamp | string <date-time> |
| incomingDriverApproved | boolean |
| incomingDriverConditionOfVehicleComment | string |
| incomingDriverId | string <uuid> |
| managerApprovalTimestamp | string <date-time> |
| managerApproved | boolean |
| managerConditionOfVehicleComment | string |
| managerId | string <uuid> |
| operationDate | string <date> |
| organisationId | string |
| outgoingDriverApprovalTimestamp | string <date-time> |
| outgoingDriverApproved | boolean |
| outgoingDriverConditionOfVehicleComment | string |
| outgoingDriverId | string <uuid> |
| placeOfTransfer | string |
| reason | string |
| trailerChecklistId | string <uuid> |
| trailerDistance | integer <int32> |
| trailerId | string <uuid> |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
| vehicleChecklistId | string <uuid> |
| vehicleDistance | integer <int32> |
| vehicleId | string <uuid> |
{- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "handoverId": "67143d15-44f0-4ced-839c-8a3899adfeba",
- "handoverState": "NEW",
- "imageIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "incomingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
- "incomingDriverApproved": true,
- "incomingDriverConditionOfVehicleComment": "string",
- "incomingDriverId": "104b6336-56dc-4281-bd24-a3c055c9a73c",
- "managerApprovalTimestamp": "2019-08-24T14:15:22Z",
- "managerApproved": true,
- "managerConditionOfVehicleComment": "string",
- "managerId": "b2c2c359-55f3-4680-a660-901475c7a693",
- "operationDate": "2019-08-24",
- "organisationId": "string",
- "outgoingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
- "outgoingDriverApproved": true,
- "outgoingDriverConditionOfVehicleComment": "string",
- "outgoingDriverId": "e2c72071-4035-4433-8231-f4dc75807e4a",
- "placeOfTransfer": "string",
- "reason": "string",
- "trailerChecklistId": "6b6dbbe8-1ea7-4c78-a9a3-46ac52311455",
- "trailerDistance": 0,
- "trailerId": "d519e634-43b4-4caf-a685-a90a28153574",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleChecklistId": "f2a8860b-c279-4c31-a168-cacc3decb98e",
- "vehicleDistance": 0,
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}{- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "handoverId": "67143d15-44f0-4ced-839c-8a3899adfeba",
- "handoverState": "NEW",
- "imageIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "incomingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
- "incomingDriverApproved": true,
- "incomingDriverConditionOfVehicleComment": "string",
- "incomingDriverId": "104b6336-56dc-4281-bd24-a3c055c9a73c",
- "managerApprovalTimestamp": "2019-08-24T14:15:22Z",
- "managerApproved": true,
- "managerConditionOfVehicleComment": "string",
- "managerId": "b2c2c359-55f3-4680-a660-901475c7a693",
- "operationDate": "2019-08-24",
- "organisationId": "string",
- "outgoingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
- "outgoingDriverApproved": true,
- "outgoingDriverConditionOfVehicleComment": "string",
- "outgoingDriverId": "e2c72071-4035-4433-8231-f4dc75807e4a",
- "placeOfTransfer": "string",
- "reason": "string",
- "trailerChecklistId": "6b6dbbe8-1ea7-4c78-a9a3-46ac52311455",
- "trailerDistanceId": "6ef67421-49f8-4042-bd6c-3208c828216f",
- "trailerId": "d519e634-43b4-4caf-a685-a90a28153574",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleChecklistId": "f2a8860b-c279-4c31-a168-cacc3decb98e",
- "vehicleDistanceId": "d0447fbf-4ed2-421e-adb1-7c226e9f4b17",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}| handoverId required | string <uuid> |
required | object (OrganisationId) |
{- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "handoverId": "67143d15-44f0-4ced-839c-8a3899adfeba",
- "handoverState": "NEW",
- "imageIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "incomingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
- "incomingDriverApproved": true,
- "incomingDriverConditionOfVehicleComment": "string",
- "incomingDriverId": "104b6336-56dc-4281-bd24-a3c055c9a73c",
- "managerApprovalTimestamp": "2019-08-24T14:15:22Z",
- "managerApproved": true,
- "managerConditionOfVehicleComment": "string",
- "managerId": "b2c2c359-55f3-4680-a660-901475c7a693",
- "operationDate": "2019-08-24",
- "organisationId": "string",
- "outgoingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
- "outgoingDriverApproved": true,
- "outgoingDriverConditionOfVehicleComment": "string",
- "outgoingDriverId": "e2c72071-4035-4433-8231-f4dc75807e4a",
- "placeOfTransfer": "string",
- "reason": "string",
- "trailerChecklistId": "6b6dbbe8-1ea7-4c78-a9a3-46ac52311455",
- "trailerDistance": 0,
- "trailerId": "d519e634-43b4-4caf-a685-a90a28153574",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleChecklistId": "f2a8860b-c279-4c31-a168-cacc3decb98e",
- "vehicleDistance": 0,
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}[- {
- "category": "AIR_CONDITION",
- "description": "string",
- "dictionary": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "value": "string"
}
], - "distanceConfigurable": true,
- "distanceInterval": 0,
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
- "timeInterval": 0,
- "timeIntervalConfigurable": true,
- "type": "Boolean"
}
]| category | string (MaintenanceItemCategory) Enum: "AIR_CONDITION" "BREAK" "CLUTCH" "ELECTRICS" "ENGINE" "ENGINE_OIL" "EXHAUST" "LIGHTING" "STEERING" "SUSPENSION" "TRANSMISSION" "TYRE" "TURBO" |
| description | string |
Array of objects (MaintenanceItemDictionary) | |
| distanceConfigurable | boolean |
| distanceInterval | integer <int32> |
| enabled | boolean |
| id | string <uuid> |
| name required | string non-empty |
| organisationId | string <uuid> |
| timeInterval | integer <int32> |
| timeIntervalConfigurable | boolean |
| type | string (MaintenanceItemType) Enum: "Boolean" "DictionaryRadio" "DictionarySelect" |
{- "category": "AIR_CONDITION",
- "description": "string",
- "dictionary": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "value": "string"
}
], - "distanceConfigurable": true,
- "distanceInterval": 0,
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
- "timeInterval": 0,
- "timeIntervalConfigurable": true,
- "type": "Boolean"
}{- "category": "AIR_CONDITION",
- "description": "string",
- "dictionary": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "value": "string"
}
], - "distanceConfigurable": true,
- "distanceInterval": 0,
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
- "timeInterval": 0,
- "timeIntervalConfigurable": true,
- "type": "Boolean"
}| category | string (MaintenanceItemCategory) Enum: "AIR_CONDITION" "BREAK" "CLUTCH" "ELECTRICS" "ENGINE" "ENGINE_OIL" "EXHAUST" "LIGHTING" "STEERING" "SUSPENSION" "TRANSMISSION" "TYRE" "TURBO" |
| description | string |
Array of objects (MaintenanceItemDictionary) | |
| distanceConfigurable | boolean |
| distanceInterval | integer <int32> |
| enabled | boolean |
| id | string <uuid> |
| name required | string non-empty |
| organisationId | string <uuid> |
| timeInterval | integer <int32> |
| timeIntervalConfigurable | boolean |
| type | string (MaintenanceItemType) Enum: "Boolean" "DictionaryRadio" "DictionarySelect" |
{- "category": "AIR_CONDITION",
- "description": "string",
- "dictionary": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "value": "string"
}
], - "distanceConfigurable": true,
- "distanceInterval": 0,
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
- "timeInterval": 0,
- "timeIntervalConfigurable": true,
- "type": "Boolean"
}{- "category": "AIR_CONDITION",
- "description": "string",
- "dictionary": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "value": "string"
}
], - "distanceConfigurable": true,
- "distanceInterval": 0,
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
- "timeInterval": 0,
- "timeIntervalConfigurable": true,
- "type": "Boolean"
}{- "category": "AIR_CONDITION",
- "description": "string",
- "dictionary": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "value": "string"
}
], - "distanceConfigurable": true,
- "distanceInterval": 0,
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
- "timeInterval": 0,
- "timeIntervalConfigurable": true,
- "type": "Boolean"
}| category | string (MaintenanceItemCategory) Enum: "AIR_CONDITION" "BREAK" "CLUTCH" "ELECTRICS" "ENGINE" "ENGINE_OIL" "EXHAUST" "LIGHTING" "STEERING" "SUSPENSION" "TRANSMISSION" "TYRE" "TURBO" |
| description | string |
Array of objects (MaintenanceItemDictionary) | |
| distanceConfigurable | boolean |
| distanceInterval | integer <int32> |
| enabled | boolean |
| id | string <uuid> |
| name required | string non-empty |
| organisationId | string <uuid> |
| timeInterval | integer <int32> |
| timeIntervalConfigurable | boolean |
| type | string (MaintenanceItemType) Enum: "Boolean" "DictionaryRadio" "DictionarySelect" |
{- "category": "AIR_CONDITION",
- "description": "string",
- "dictionary": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "value": "string"
}
], - "distanceConfigurable": true,
- "distanceInterval": 0,
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
- "timeInterval": 0,
- "timeIntervalConfigurable": true,
- "type": "Boolean"
}{- "category": "AIR_CONDITION",
- "description": "string",
- "dictionary": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "value": "string"
}
], - "distanceConfigurable": true,
- "distanceInterval": 0,
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
- "timeInterval": 0,
- "timeIntervalConfigurable": true,
- "type": "Boolean"
}| organisation-id required | string <uuid> |
| prompt | string |
{- "prompt": "string"
}{- "response": "string"
}[- {
- "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
- "description": "string",
- "distance": 0,
- "distanceUnit": "KILOMETER",
- "eventType": "PRODUCTION",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "operationDate": "2019-08-24"
}
][- {
- "comment": "Second hand tire",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "dotCode": "DOT T7D3 1BH 3218",
- "organisationId": "string",
- "productionDate": "2024-01-20",
- "serialNumber": "2024-01-20",
- "tagRfid": "123456789",
- "tireId": "3619f2ce-ce8f-4b86-abd3-1408e917f6b0",
- "tireLineId": "8cf7f971-db36-49f3-85ea-90b9e60160e1",
- "tireOperations": [
- {
- "axleNumber": 0,
- "axlePosition": "LEFT_OR_LEFT_OUTER",
- "balanced": true,
- "comment": "string",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "maintenanceId": "b3564c3f-6d8c-49be-bab7-e3821ae80ea6",
- "tireLifeCycleStage": "NEW",
- "treadDepthLeft": 0,
- "treadDepthMiddle": 0,
- "treadDepthRight": 0,
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "visibleDamage": true,
- "wheelRimRotation": true
}
], - "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}
]required | object (OrganisationId) |
| comment | string User comment on tire |
| createDateTime | string <date-time> |
| createUserId | string <uuid> |
| dotCode | string The DOT code (Department of Transportation) is a unique alphanumeric code that indicates the tire manufacturer, plant, size, and production date. The last four digits show the week and year of manufacture, e. g., 2023 means the 20th week of 2023. |
| organisationId | string |
| productionDate | string <date> Tire production date |
| serialNumber | string Tire serial number |
| tagRfid | string Tire RFID |
| tireId | string <uuid> |
| tireLineId | string <uuid> |
Array of objects (TireOperationDTO) | |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
{- "comment": "Second hand tire",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "dotCode": "DOT T7D3 1BH 3218",
- "organisationId": "string",
- "productionDate": "2024-01-20",
- "serialNumber": "2024-01-20",
- "tagRfid": "123456789",
- "tireId": "3619f2ce-ce8f-4b86-abd3-1408e917f6b0",
- "tireLineId": "8cf7f971-db36-49f3-85ea-90b9e60160e1",
- "tireOperations": [
- {
- "axleNumber": 0,
- "axlePosition": "LEFT_OR_LEFT_OUTER",
- "balanced": true,
- "comment": "string",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "maintenanceId": "b3564c3f-6d8c-49be-bab7-e3821ae80ea6",
- "tireLifeCycleStage": "NEW",
- "treadDepthLeft": 0,
- "treadDepthMiddle": 0,
- "treadDepthRight": 0,
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "visibleDamage": true,
- "wheelRimRotation": true
}
], - "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}{- "comment": "Second hand tire",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "dotCode": "DOT T7D3 1BH 3218",
- "organisationId": "string",
- "productionDate": "2024-01-20",
- "serialNumber": "2024-01-20",
- "tagRfid": "123456789",
- "tireId": "3619f2ce-ce8f-4b86-abd3-1408e917f6b0",
- "tireLineId": "8cf7f971-db36-49f3-85ea-90b9e60160e1",
- "tireOperations": [
- {
- "axleNumber": 0,
- "axlePosition": "LEFT_OR_LEFT_OUTER",
- "balanced": true,
- "comment": "string",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "maintenanceId": "b3564c3f-6d8c-49be-bab7-e3821ae80ea6",
- "tireLifeCycleStage": "NEW",
- "treadDepthLeft": 0,
- "treadDepthMiddle": 0,
- "treadDepthRight": 0,
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "visibleDamage": true,
- "wheelRimRotation": true
}
], - "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}required | object (OrganisationId) |
| comment | string User comment on tire |
| createDateTime | string <date-time> |
| createUserId | string <uuid> |
| dotCode | string The DOT code (Department of Transportation) is a unique alphanumeric code that indicates the tire manufacturer, plant, size, and production date. The last four digits show the week and year of manufacture, e. g., 2023 means the 20th week of 2023. |
| organisationId | string |
| productionDate | string <date> Tire production date |
| serialNumber | string Tire serial number |
| tagRfid | string Tire RFID |
| tireId | string <uuid> |
| tireLineId | string <uuid> |
Array of objects (TireOperationDTO) | |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
{- "comment": "Second hand tire",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "dotCode": "DOT T7D3 1BH 3218",
- "organisationId": "string",
- "productionDate": "2024-01-20",
- "serialNumber": "2024-01-20",
- "tagRfid": "123456789",
- "tireId": "3619f2ce-ce8f-4b86-abd3-1408e917f6b0",
- "tireLineId": "8cf7f971-db36-49f3-85ea-90b9e60160e1",
- "tireOperations": [
- {
- "axleNumber": 0,
- "axlePosition": "LEFT_OR_LEFT_OUTER",
- "balanced": true,
- "comment": "string",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "maintenanceId": "b3564c3f-6d8c-49be-bab7-e3821ae80ea6",
- "tireLifeCycleStage": "NEW",
- "treadDepthLeft": 0,
- "treadDepthMiddle": 0,
- "treadDepthRight": 0,
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "visibleDamage": true,
- "wheelRimRotation": true
}
], - "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}{- "comment": "Second hand tire",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "dotCode": "DOT T7D3 1BH 3218",
- "organisationId": "string",
- "productionDate": "2024-01-20",
- "serialNumber": "2024-01-20",
- "tagRfid": "123456789",
- "tireId": "3619f2ce-ce8f-4b86-abd3-1408e917f6b0",
- "tireLineId": "8cf7f971-db36-49f3-85ea-90b9e60160e1",
- "tireOperations": [
- {
- "axleNumber": 0,
- "axlePosition": "LEFT_OR_LEFT_OUTER",
- "balanced": true,
- "comment": "string",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "maintenanceId": "b3564c3f-6d8c-49be-bab7-e3821ae80ea6",
- "tireLifeCycleStage": "NEW",
- "treadDepthLeft": 0,
- "treadDepthMiddle": 0,
- "treadDepthRight": 0,
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "visibleDamage": true,
- "wheelRimRotation": true
}
], - "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}required | object (OrganisationId) |
| axleNumber | integer <int32> Axles numered from the front |
| axlePosition | string (TirePosition) Enum: "LEFT_OR_LEFT_OUTER" "LEFT_INNER" "RIGHT_INNER" "RIGHT_OR_RIGHT_OUTER" |
| balanced | boolean Tire was balanced |
| comment | string Tire operation comment |
| maintenanceId | string <uuid> Vehicle maintenance when tire operation took place |
| tireId | string <uuid> |
| tireLifeCycleStage | string (TireLifeCycleStage) Enum: "NEW" "INSTALLED" "POSITION_CHANGED" "INSPECTED" "REGROOVED" "REPAIRED" "RETREADED" "UNINSTALLED" "DECOMMISSIONED" |
| treadDepthLeft | integer <int32> tread depth left in [mm] |
| treadDepthMiddle | integer <int32> tread depth middle in [mm] |
| treadDepthRight | integer <int32> tread depth right in [mm] |
| visibleDamage | boolean Visual inspection for damage |
| wheelRimRotation | boolean Tire is rotated on the rim |
{- "axleNumber": 1,
- "axlePosition": "LEFT_OR_LEFT_OUTER",
- "balanced": true,
- "comment": "New tire",
- "maintenanceId": "1b89df27-65e7-4fe9-829e-eb29e30ff29a",
- "tireId": "3619f2ce-ce8f-4b86-abd3-1408e917f6b0",
- "tireLifeCycleStage": "NEW",
- "treadDepthLeft": 10,
- "treadDepthMiddle": 11,
- "treadDepthRight": 12,
- "visibleDamage": true,
- "wheelRimRotation": true
}{- "comment": "Second hand tire",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "dotCode": "DOT T7D3 1BH 3218",
- "organisationId": "string",
- "productionDate": "2024-01-20",
- "serialNumber": "2024-01-20",
- "tagRfid": "123456789",
- "tireId": "3619f2ce-ce8f-4b86-abd3-1408e917f6b0",
- "tireLineId": "8cf7f971-db36-49f3-85ea-90b9e60160e1",
- "tireOperations": [
- {
- "axleNumber": 0,
- "axlePosition": "LEFT_OR_LEFT_OUTER",
- "balanced": true,
- "comment": "string",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "maintenanceId": "b3564c3f-6d8c-49be-bab7-e3821ae80ea6",
- "tireLifeCycleStage": "NEW",
- "treadDepthLeft": 0,
- "treadDepthMiddle": 0,
- "treadDepthRight": 0,
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "visibleDamage": true,
- "wheelRimRotation": true
}
], - "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}required | object (OrganisationId) |
| axleNumber | integer <int32> Axles numered from the front |
| axlePosition | string (TirePosition) Enum: "LEFT_OR_LEFT_OUTER" "LEFT_INNER" "RIGHT_INNER" "RIGHT_OR_RIGHT_OUTER" |
| balanced | boolean Tire was balanced |
| comment | string Tire operation comment |
| maintenanceId | string <uuid> Vehicle maintenance when tire operation took place |
| operationId | string <uuid> |
| tireId | string <uuid> |
| tireLifeCycleStage | string (TireLifeCycleStage) Enum: "NEW" "INSTALLED" "POSITION_CHANGED" "INSPECTED" "REGROOVED" "REPAIRED" "RETREADED" "UNINSTALLED" "DECOMMISSIONED" |
| treadDepthLeft | integer <int32> tread depth left in [mm] |
| treadDepthMiddle | integer <int32> tread depth middle in [mm] |
| treadDepthRight | integer <int32> tread depth right in [mm] |
| visibleDamage | boolean Visual inspection for damage |
| wheelRimRotation | boolean Tire is rotated on the rim |
{- "axleNumber": 2,
- "axlePosition": "LEFT_OR_LEFT_OUTER",
- "balanced": true,
- "comment": "Installed properly",
- "maintenanceId": "1b89df27-65e7-4fe9-829e-eb29e30ff29a",
- "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",
- "tireId": "3619f2ce-ce8f-4b86-abd3-1408e917f6b0",
- "tireLifeCycleStage": "NEW",
- "treadDepthLeft": 10,
- "treadDepthMiddle": 11,
- "treadDepthRight": 12,
- "visibleDamage": false,
- "wheelRimRotation": true
}{- "comment": "Second hand tire",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "dotCode": "DOT T7D3 1BH 3218",
- "organisationId": "string",
- "productionDate": "2024-01-20",
- "serialNumber": "2024-01-20",
- "tagRfid": "123456789",
- "tireId": "3619f2ce-ce8f-4b86-abd3-1408e917f6b0",
- "tireLineId": "8cf7f971-db36-49f3-85ea-90b9e60160e1",
- "tireOperations": [
- {
- "axleNumber": 0,
- "axlePosition": "LEFT_OR_LEFT_OUTER",
- "balanced": true,
- "comment": "string",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "maintenanceId": "b3564c3f-6d8c-49be-bab7-e3821ae80ea6",
- "tireLifeCycleStage": "NEW",
- "treadDepthLeft": 0,
- "treadDepthMiddle": 0,
- "treadDepthRight": 0,
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "visibleDamage": true,
- "wheelRimRotation": true
}
], - "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}| tireId required | string <uuid> |
required | object (OrganisationId) |
{- "comment": "Second hand tire",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "dotCode": "DOT T7D3 1BH 3218",
- "organisationId": "string",
- "productionDate": "2024-01-20",
- "serialNumber": "2024-01-20",
- "tagRfid": "123456789",
- "tireId": "3619f2ce-ce8f-4b86-abd3-1408e917f6b0",
- "tireLineId": "8cf7f971-db36-49f3-85ea-90b9e60160e1",
- "tireOperations": [
- {
- "axleNumber": 0,
- "axlePosition": "LEFT_OR_LEFT_OUTER",
- "balanced": true,
- "comment": "string",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "maintenanceId": "b3564c3f-6d8c-49be-bab7-e3821ae80ea6",
- "tireLifeCycleStage": "NEW",
- "treadDepthLeft": 0,
- "treadDepthMiddle": 0,
- "treadDepthRight": 0,
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "visibleDamage": true,
- "wheelRimRotation": true
}
], - "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}[- {
- "comment": "Good for TGR",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "lineId": "e698cdee-c4ef-4d12-b0ea-7c98b2fc64a8",
- "name": "Turanza",
- "organisationId": "string",
- "tireManufactureId": "48de747f-a9a9-456e-9907-64e5e87d58f2",
- "tireUsage": "ALL_SEASON",
- "treadPattern": "DRIVE",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "warrantyMileageLimit": 0,
- "warrantyYearsLimit": 5
}
]required | object (OrganisationId) |
| comment | string Additional information about tire line |
| createDateTime | string <date-time> |
| createUserId | string <uuid> |
| lineId | string <uuid> |
| name | string The name of the tire line or model |
| organisationId | string |
| tireManufactureId | string <uuid> |
| tireUsage | string (TireUsage) Enum: "ALL_SEASON" "SUMMER" "WINTER" "MUD_TERRAIN" "HIGHWAY" "SLICK" Types of tread based on usage |
| treadPattern | string (TreadPattern) Enum: "DRIVE" "STEER" "TRAILER" "GENERAL" One of tire tread patterns |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
| warrantyMileageLimit | integer <int32> The distance during which a warranty is valid. |
| warrantyYearsLimit | integer <int32> The time during which a warranty is valid in years. |
{- "comment": "Good for TGR",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "lineId": "e698cdee-c4ef-4d12-b0ea-7c98b2fc64a8",
- "name": "Turanza",
- "organisationId": "string",
- "tireManufactureId": "48de747f-a9a9-456e-9907-64e5e87d58f2",
- "tireUsage": "ALL_SEASON",
- "treadPattern": "DRIVE",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "warrantyMileageLimit": 0,
- "warrantyYearsLimit": 5
}{- "comment": "Good for TGR",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "lineId": "e698cdee-c4ef-4d12-b0ea-7c98b2fc64a8",
- "name": "Turanza",
- "organisationId": "string",
- "tireManufactureId": "48de747f-a9a9-456e-9907-64e5e87d58f2",
- "tireUsage": "ALL_SEASON",
- "treadPattern": "DRIVE",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "warrantyMileageLimit": 0,
- "warrantyYearsLimit": 5
}required | object (OrganisationId) |
| comment | string Additional information about tire line |
| createDateTime | string <date-time> |
| createUserId | string <uuid> |
| lineId | string <uuid> |
| name | string The name of the tire line or model |
| organisationId | string |
| tireManufactureId | string <uuid> |
| tireUsage | string (TireUsage) Enum: "ALL_SEASON" "SUMMER" "WINTER" "MUD_TERRAIN" "HIGHWAY" "SLICK" Types of tread based on usage |
| treadPattern | string (TreadPattern) Enum: "DRIVE" "STEER" "TRAILER" "GENERAL" One of tire tread patterns |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
| warrantyMileageLimit | integer <int32> The distance during which a warranty is valid. |
| warrantyYearsLimit | integer <int32> The time during which a warranty is valid in years. |
{- "comment": "Good for TGR",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "lineId": "e698cdee-c4ef-4d12-b0ea-7c98b2fc64a8",
- "name": "Turanza",
- "organisationId": "string",
- "tireManufactureId": "48de747f-a9a9-456e-9907-64e5e87d58f2",
- "tireUsage": "ALL_SEASON",
- "treadPattern": "DRIVE",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "warrantyMileageLimit": 0,
- "warrantyYearsLimit": 5
}{- "comment": "Good for TGR",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "lineId": "e698cdee-c4ef-4d12-b0ea-7c98b2fc64a8",
- "name": "Turanza",
- "organisationId": "string",
- "tireManufactureId": "48de747f-a9a9-456e-9907-64e5e87d58f2",
- "tireUsage": "ALL_SEASON",
- "treadPattern": "DRIVE",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "warrantyMileageLimit": 0,
- "warrantyYearsLimit": 5
}| lineId required | string <uuid> |
required | object (OrganisationId) |
{- "comment": "Good for TGR",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "lineId": "e698cdee-c4ef-4d12-b0ea-7c98b2fc64a8",
- "name": "Turanza",
- "organisationId": "string",
- "tireManufactureId": "48de747f-a9a9-456e-9907-64e5e87d58f2",
- "tireUsage": "ALL_SEASON",
- "treadPattern": "DRIVE",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "warrantyMileageLimit": 0,
- "warrantyYearsLimit": 5
}[- {
- "comment": "Good manufacture",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "manufactureId": "419e8723-64f8-4e03-a61e-e3e0b6dc353a",
- "name": "Bridgestone",
- "organisationId": "string",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}
]required | object (OrganisationId) |
| comment | string Additional information about tire manufacture |
| createDateTime | string <date-time> |
| createUserId | string <uuid> |
| manufactureId | string <uuid> |
| name | string The name of the tire manufacture |
| organisationId | string |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
{- "comment": "Good manufacture",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "manufactureId": "419e8723-64f8-4e03-a61e-e3e0b6dc353a",
- "name": "Bridgestone",
- "organisationId": "string",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}{- "comment": "Good manufacture",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "manufactureId": "419e8723-64f8-4e03-a61e-e3e0b6dc353a",
- "name": "Bridgestone",
- "organisationId": "string",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}required | object (OrganisationId) |
| comment | string Additional information about tire manufacture |
| createDateTime | string <date-time> |
| createUserId | string <uuid> |
| manufactureId | string <uuid> |
| name | string The name of the tire manufacture |
| organisationId | string |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
{- "comment": "Good manufacture",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "manufactureId": "419e8723-64f8-4e03-a61e-e3e0b6dc353a",
- "name": "Bridgestone",
- "organisationId": "string",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}{- "comment": "Good manufacture",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "manufactureId": "419e8723-64f8-4e03-a61e-e3e0b6dc353a",
- "name": "Bridgestone",
- "organisationId": "string",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}| manufactureId required | string <uuid> |
required | object (OrganisationId) |
{- "comment": "Good manufacture",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "manufactureId": "419e8723-64f8-4e03-a61e-e3e0b6dc353a",
- "name": "Bridgestone",
- "organisationId": "string",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}Delete organisation with IAM users is required by Apple Store and Google Play. User need to be the owner (founder) of the organization. If deleted organisation is current organisation, then current organisation is empty. If deleted organisation is only organisation user belong then user belong to no organisation. User belong to one CORPORATE organization is not deleted. For ser belong to other PRIVATE organisation is deleted and for other organisation user initials are saved.
{- "organisations": [
- {
- "id": {
- "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5"
}, - "imageId": "bbefe473-c66a-4040-85cf-1c7e6f0b3830",
- "name": "string",
- "organisationType": "PRIVATE",
- "promptToggle": true,
- "trackingToggle": true
}
]
}[- {
- "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
- "models": [
- {
- "axesCount": 0,
- "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
- "maintenanceItemValues": [
- {
- "distanceInterval": 0,
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "maintenanceItemId": "10be3182-291a-4dc6-bf71-aabafed209f8",
- "timeInterval": 0
}
], - "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
- "name": "string",
- "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
- "typeName": "string"
}
], - "name": "string"
}
]| organisation-id required | string |
| name required | string non-empty |
{- "name": "string"
}{- "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
- "models": [
- {
- "axesCount": 0,
- "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
- "maintenanceItemValues": [
- {
- "distanceInterval": 0,
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "maintenanceItemId": "10be3182-291a-4dc6-bf71-aabafed209f8",
- "timeInterval": 0
}
], - "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
- "name": "string",
- "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
- "typeName": "string"
}
], - "name": "string"
}| brandId required | string <uuid> |
| organisation-id required | string |
{- "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
- "models": [
- {
- "axesCount": 0,
- "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
- "maintenanceItemValues": [
- {
- "distanceInterval": 0,
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "maintenanceItemId": "10be3182-291a-4dc6-bf71-aabafed209f8",
- "timeInterval": 0
}
], - "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
- "name": "string",
- "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
- "typeName": "string"
}
], - "name": "string"
}| brandId required | string <uuid> |
| organisation-id required | string |
| name required | string non-empty |
{- "name": "string"
}{- "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
- "models": [
- {
- "axesCount": 0,
- "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
- "maintenanceItemValues": [
- {
- "distanceInterval": 0,
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "maintenanceItemId": "10be3182-291a-4dc6-bf71-aabafed209f8",
- "timeInterval": 0
}
], - "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
- "name": "string",
- "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
- "typeName": "string"
}
], - "name": "string"
}Retrieves paginated list of comments for any resource (task, vehicle, etc.).
Returns active (non-deleted) comments by default, sorted chronologically. Supports pagination via page, size, and sort parameters.
Response includes HATEOAS links for navigation (self, first, next, prev, last). Each comment includes state-driven action links (edit, delete) based on authorization.
| contextType required | string (ContextType) Enum: "task" "vehicle" "maintenance-order" "fuel-record" "task" "vehicle" "maintenance-order" "fuel-record" Example: task Type of parent resource |
required | object (ContextId) Example: 660e8400-e29b-41d4-a716-446655440000 Parent resource identifier |
| includeDeleted | boolean Default: false Include soft-deleted comments |
required | object (Pageable) Pagination parameters (page, size, sort) |
required | object (OrganisationId) Organisation identifier |
{- "_embedded": {
- "commentResponseList": [
- {
- "commentId": "550e8400-e29b-41d4-a716-446655440000",
- "contextType": "task",
- "contextId": "660e8400-e29b-41d4-a716-446655440000",
- "content": "Updated authentication logic",
- "authorUserId": "770e8400-e29b-41d4-a716-446655440000",
- "deleted": false,
- "deletedAt": null,
- "version": 1,
- "createdAt": "2025-12-26T10:00:00",
- "updatedAt": "2025-12-26T10:00:00",
- "_links": {
- "self": {
- "href": "/api/v0.1/comment/task/660e8400.../550e8400..."
}, - "context": {
- "href": "/api/v0.1/kanban/task/660e8400...",
- "title": "View task"
}, - "edit": {
- "href": "/api/v0.1/comment/task/660e8400.../550e8400...",
- "method": "PUT",
- "title": "Edit this comment"
}, - "delete": {
- "href": "/api/v0.1/comment/task/660e8400.../550e8400...?version=1",
- "method": "DELETE",
- "title": "Delete this comment"
}
}
}
]
}, - "_links": {
- "self": {
- "href": "/api/v0.1/comment/task/660e8400...?page=0&size=20"
}, - "first": {
- "href": "/api/v0.1/comment/task/660e8400...?page=0&size=20"
}, - "last": {
- "href": "/api/v0.1/comment/task/660e8400...?page=2&size=20"
}
}, - "page": {
- "size": 20,
- "number": 0,
- "totalElements": 45,
- "totalPages": 3
}
}| organisation-id required | string |
| id | string <uuid> |
| name required | string non-empty |
| organisationId | string <uuid> |
| trailer | boolean |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
- "trailer": true
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
- "trailer": true
}| typeId required | string <uuid> |
| organisation-id required | string |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
- "trailer": true
}| typeId required | string <uuid> |
| organisation-id required | string |
| id | string <uuid> |
| name required | string non-empty |
| organisationId | string <uuid> |
| trailer | boolean |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
- "trailer": true
}{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
- "trailer": true
}| organisationId required | string <uuid> |
| description | string [ 0 .. 256 ] characters |
| enabled | boolean |
| id | string <uuid> |
| name required | string [ 1 .. 64 ] characters |
| organisationId | string |
{- "description": "string",
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "organisationId": "string"
}{- "description": "string",
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "organisationId": "string"
}| organisationId required | string <uuid> |
| vehicleId required | string <uuid> |
[- {
- "description": "string",
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "organisationId": "string"
}
]| organisationId required | string <uuid> |
| vehicleId required | string <uuid> |
[- {
- "description": "string",
- "name": "string",
- "value": "string",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
- "vehicleParameterId": "74f97355-5ca7-4ed1-97df-b01206485647"
}
]| organisationId required | string <uuid> |
| parameterId required | string <uuid> |
| description | string [ 0 .. 256 ] characters |
| enabled | boolean |
| id | string <uuid> |
| name required | string [ 1 .. 64 ] characters |
| organisationId | string |
{- "description": "string",
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "organisationId": "string"
}{- "description": "string",
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "organisationId": "string"
}| organisationId required | string <uuid> |
object (TankLevel) | |
object (TankLevel) | |
| ignition | boolean |
| latitude required | number <float> |
| longitude required | number <float> |
| odometer | integer <int32> |
| operationTimestamp | string <date-time> |
| speed | number <float> |
| vehicleId required | string <uuid> |
{- "catalystLevel": {
- "level": 0.1,
- "unit": "PERCENT"
}, - "fuelLevel": {
- "level": 0.1,
- "unit": "PERCENT"
}, - "ignition": true,
- "latitude": 0.1,
- "longitude": 0.1,
- "odometer": 0,
- "operationTimestamp": "2019-08-24T14:15:22Z",
- "speed": 0.1,
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}| organisationId required | string <uuid> |
| vehicleId required | string <uuid> |
| from required | string <date-time> |
| to required | string <date-time> |
{- "from": "2019-08-24T14:15:22Z",
- "telemetries": [
- {
- "catalystLevel": 0.1,
- "catalystLevelUnit": "PERCENT",
- "fuelLevel": 0.1,
- "fuelLevelUnit": "PERCENT",
- "ignition": true,
- "latitude": 0.1,
- "longitude": 0.1,
- "odometer": 0,
- "operationTimestamp": "2019-08-24T14:15:22Z",
- "registration": "string",
- "speed": 0.1,
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}
], - "to": "2019-08-24T14:15:22Z"
}| organisationId required | string <uuid> |
| vehicleId required | string <uuid> |
| description | string |
| name | string |
| value | string |
| vehicleId | string <uuid> |
| vehicleParameterId | string <uuid> |
{- "description": "string",
- "name": "string",
- "value": "string",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
- "vehicleParameterId": "74f97355-5ca7-4ed1-97df-b01206485647"
}{- "description": "string",
- "name": "string",
- "value": "string",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
- "vehicleParameterId": "74f97355-5ca7-4ed1-97df-b01206485647"
}| organisationId required | string <uuid> |
| vehicleId required | string <uuid> |
| parameterId required | string <uuid> |
{- "description": "string",
- "name": "string",
- "value": "string",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
- "vehicleParameterId": "74f97355-5ca7-4ed1-97df-b01206485647"
}[- {
- "brandName": "string",
- "category": "string",
- "description": "string",
- "distanceUnit": "KILOMETER",
- "lastMaintenanceId": { },
- "limitDays": 0,
- "limitMillage": 0,
- "maintenanceItemId": "10be3182-291a-4dc6-bf71-aabafed209f8",
- "modelName": "string",
- "passedDays": 0,
- "passedMillage": 0,
- "registration": "string",
- "remainingDays": 0,
- "remainingMillage": 0,
- "status": "OK",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}
][- {
- "brandName": "string",
- "category": "string",
- "description": "string",
- "distanceUnit": "KILOMETER",
- "lastMaintenanceId": { },
- "limitDays": 0,
- "limitMillage": 0,
- "maintenanceItemId": "10be3182-291a-4dc6-bf71-aabafed209f8",
- "modelName": "string",
- "passedDays": 0,
- "passedMillage": 0,
- "registration": "string",
- "remainingDays": 0,
- "remainingMillage": 0,
- "status": "OK",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}
]| organisationId required | string <uuid> |
| createDateTime | string <date-time> |
| distance | integer <int64> |
| distanceType | string (DistanceType) Enum: "DISTANCE" "MAINTENANCE" "DUTY" "COUPLING" "HANDOVER" "REFUELING" |
| distanceUnit | string (WorkUnit) Enum: "KILOMETER" "MILE" "HOUR" |
| externalId | string <uuid> |
| id | object (DistanceId) |
| operationDate | string <date> |
| remarks | string [ 0 .. 1024 ] characters |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
| userId | string <uuid> |
| vehicleId | string <uuid> |
{- "createDateTime": "2019-08-24T14:15:22Z",
- "distance": 0,
- "distanceType": "DISTANCE",
- "distanceUnit": "KILOMETER",
- "externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
- "id": { },
- "operationDate": "2019-08-24",
- "remarks": "string",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}{ }| organisationId required | string <uuid> |
| createDateTime | string <date-time> |
| distance | integer <int64> |
| distanceType | string (DistanceType) Enum: "DISTANCE" "MAINTENANCE" "DUTY" "COUPLING" "HANDOVER" "REFUELING" |
| distanceUnit | string (WorkUnit) Enum: "KILOMETER" "MILE" "HOUR" |
| externalId | string <uuid> |
| id | object (DistanceId) |
| operationDate | string <date> |
| remarks | string [ 0 .. 1024 ] characters |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
| userId | string <uuid> |
| vehicleId | string <uuid> |
{- "createDateTime": "2019-08-24T14:15:22Z",
- "distance": 0,
- "distanceType": "DISTANCE",
- "distanceUnit": "KILOMETER",
- "externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
- "id": { },
- "operationDate": "2019-08-24",
- "remarks": "string",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}{ }| organisationId required | string <uuid> |
| vehicleId required | string <uuid> |
[- {
- "createDateTime": "2019-08-24T14:15:22Z",
- "distance": 0,
- "distanceType": "DISTANCE",
- "distanceUnit": "KILOMETER",
- "externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
- "id": { },
- "operationDate": "2019-08-24",
- "remarks": "string",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}
]| organisationId required | string <uuid> |
| distanceId required | object (DistanceId) |
{- "createDateTime": "2019-08-24T14:15:22Z",
- "distance": 0,
- "distanceType": "DISTANCE",
- "distanceUnit": "KILOMETER",
- "externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
- "id": { },
- "operationDate": "2019-08-24",
- "remarks": "string",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}| organisationId required | string <uuid> |
| vehicleId required | string <uuid> |
[- {
- "description": "string",
- "expirationDate": "2019-08-24",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "imageIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "itemId": "f11b669d-7201-4c21-88af-d85092f0c005",
- "name": "string",
- "status": "UNSET",
- "type": "DATE",
- "updateTimestamp": "2019-08-24T14:15:22Z",
- "updateUser": "361e814f-eb1f-4bf2-8c47-35f1bcb2124e",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}
]{- "description": "string",
- "expirationDate": "2019-08-24",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "imageIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "itemId": "f11b669d-7201-4c21-88af-d85092f0c005",
- "name": "string",
- "status": "UNSET",
- "type": "DATE",
- "updateTimestamp": "2019-08-24T14:15:22Z",
- "updateUser": "361e814f-eb1f-4bf2-8c47-35f1bcb2124e",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}| organisationId required | string <uuid> |
| dutyId required | string <uuid> |
| expirationDate | string <date> |
| imageIds | Array of strings <uuid> [ items <uuid > ] |
{- "expirationDate": "2019-08-24",
- "imageIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}{- "description": "string",
- "expirationDate": "2019-08-24",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "imageIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "itemId": "f11b669d-7201-4c21-88af-d85092f0c005",
- "name": "string",
- "status": "UNSET",
- "type": "DATE",
- "updateTimestamp": "2019-08-24T14:15:22Z",
- "updateUser": "361e814f-eb1f-4bf2-8c47-35f1bcb2124e",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb"
}| organisationId required | string <uuid> |
| description | string |
| name required | string |
{- "description": "string",
- "name": "string"
}{- "description": "string",
- "id": { },
- "name": "string"
}| organisationId required | string <uuid> |
| dutyItemId required | string <uuid> |
| description | string |
| name required | string |
{- "description": "string",
- "name": "string"
}{- "description": "string",
- "id": { },
- "name": "string"
}| organisationId required | string <uuid> |
required | object (Pageable) |
{- "content": [
- {
- "detail1": "string",
- "detailDate": "2019-08-24",
- "id": 0,
- "note": "string",
- "operationDate": "2019-08-24",
- "registration": "string",
- "sourceId": "string",
- "type": "DUTY",
- "userId": "string"
}
], - "empty": true,
- "first": true,
- "last": true,
- "number": 0,
- "numberOfElements": 0,
- "pageable": {
- "offset": 0,
- "pageNumber": 0,
- "pageSize": 0,
- "paged": true,
- "sort": {
- "empty": true,
- "sorted": true,
- "unsorted": true
}, - "unpaged": true
}, - "size": 0,
- "sort": {
- "empty": true,
- "sorted": true,
- "unsorted": true
}, - "totalElements": 0,
- "totalPages": 0
}| organisation-id required | string |
| dutyItemIds | Array of strings <uuid> [ items <uuid > ] |
| id | string <uuid> |
| name required | string non-empty |
{- "dutyItemIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}{- "dutyItemIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}| destinationId required | string <uuid> |
| organisation-id required | string |
| dutyItemIds | Array of strings <uuid> [ items <uuid > ] |
| id | string <uuid> |
| name required | string non-empty |
{- "dutyItemIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}{- "dutyItemIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string"
}[- {
- "atKilometers": 0,
- "createDate": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "cyclical": true,
- "done": true,
- "doneDate": "2019-08-24T14:15:22Z",
- "doneUserId": "72ce7f1e-7f2a-4fa5-9f68-3495d76fbecd",
- "editDate": "2019-08-24T14:15:22Z",
- "editUserId": "b8cb20cd-fd09-4975-ad6b-1f7347c2e8ed",
- "everyDays": 0,
- "expirationDate": "2019-08-24",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "inspRequest": "string",
- "status": "UNSET",
- "vehicleBrand": "string",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
- "vehicleModel": "string",
- "vehicleRegistration": "string"
}
]| vehicleId required | string <uuid> |
[- {
- "atKilometers": 0,
- "createDate": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "cyclical": true,
- "done": true,
- "doneDate": "2019-08-24T14:15:22Z",
- "doneUserId": "72ce7f1e-7f2a-4fa5-9f68-3495d76fbecd",
- "editDate": "2019-08-24T14:15:22Z",
- "editUserId": "b8cb20cd-fd09-4975-ad6b-1f7347c2e8ed",
- "everyDays": 0,
- "expirationDate": "2019-08-24",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "inspRequest": "string",
- "status": "UNSET",
- "vehicleBrand": "string",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
- "vehicleModel": "string",
- "vehicleRegistration": "string"
}
]| vehicleId required | string <uuid> |
| file | string <binary> |
required | object (MaintenanceRequestDTOV03) |
{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}| maintenanceRequestId required | string <uuid> |
{- "atKilometers": 0,
- "createDate": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "cyclical": true,
- "done": true,
- "doneDate": "2019-08-24T14:15:22Z",
- "doneUserId": "72ce7f1e-7f2a-4fa5-9f68-3495d76fbecd",
- "editDate": "2019-08-24T14:15:22Z",
- "editUserId": "b8cb20cd-fd09-4975-ad6b-1f7347c2e8ed",
- "everyDays": 0,
- "expirationDate": "2019-08-24",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "inspRequest": "string",
- "status": "UNSET",
- "vehicleBrand": "string",
- "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
- "vehicleModel": "string",
- "vehicleRegistration": "string"
}| maintenanceRequestId required | string <uuid> |
| file | string <binary> |
required | object (MaintenanceRequestDTOV03) |
{- "message": "string",
- "violations": [
- {
- "fieldName": "string",
- "message": "string"
}
]
}| maintenanceRequestId required | string <uuid> |
| done required | boolean |
| doneDate | string <date-time> |
| doneUserId | string <uuid> |
| id | string <uuid> |
{- "done": true,
- "doneDate": "2019-08-24T14:15:22Z",
- "doneUserId": "72ce7f1e-7f2a-4fa5-9f68-3495d76fbecd",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}{- "done": true,
- "doneDate": "2019-08-24T14:15:22Z",
- "doneUserId": "72ce7f1e-7f2a-4fa5-9f68-3495d76fbecd",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}User with enabled organisation
[- {
- "id": "560b225b-dc15-41d3-bc06-29e0c613d223",
- "name": "tecaser@techmetria.io",
- "type": "PRIVATE",
- "imageId": null,
- "featureToggles": [ ]
}
]| featureToggles | Array of strings |
| id | string |
| imageId | string <uuid> |
| name | string |
| type | string (OrganisationType) Enum: "PRIVATE" "CORPORATE" |
{- "featureToggles": [
- "string"
], - "id": "string",
- "imageId": "bbefe473-c66a-4040-85cf-1c7e6f0b3830",
- "name": "string",
- "type": "PRIVATE"
}{- "featureToggles": [
- "string"
], - "id": "string",
- "imageId": "bbefe473-c66a-4040-85cf-1c7e6f0b3830",
- "name": "string",
- "type": "PRIVATE"
}Returns the currently selected organisation for the authenticated user
Corporate organisation
{- "id": "c45f2907-9940-4070-9e84-f55d16bfd98c",
- "name": "Acme Corp Fleet",
- "type": "CORPORATE",
- "imageId": null,
- "featureToggles": [
- "tracking"
]
}| featureToggles | Array of strings |
| id | string |
| imageId | string <uuid> |
| name | string |
| type | string (OrganisationType) Enum: "PRIVATE" "CORPORATE" |
{- "featureToggles": [
- "string"
], - "id": "string",
- "imageId": "bbefe473-c66a-4040-85cf-1c7e6f0b3830",
- "name": "string",
- "type": "PRIVATE"
}{- "featureToggles": [
- "string"
], - "id": "string",
- "imageId": "bbefe473-c66a-4040-85cf-1c7e6f0b3830",
- "name": "string",
- "type": "PRIVATE"
}Delete organisation without IAM users. If deleted organisation is current organisation, then current organisation is empty. If deleted organisation is only organisation user belong then user belong to no organisation.
| organisationId required | string <uuid> |
{- "featureToggles": [
- "string"
], - "id": "string",
- "imageId": "bbefe473-c66a-4040-85cf-1c7e6f0b3830",
- "name": "string",
- "type": "PRIVATE"
}| organisationId required | string <uuid> |
| featureToggles | Array of strings |
| id | string |
| imageId | string <uuid> |
| name | string |
| type | string (OrganisationType) Enum: "PRIVATE" "CORPORATE" |
{- "featureToggles": [
- "string"
], - "id": "string",
- "imageId": "bbefe473-c66a-4040-85cf-1c7e6f0b3830",
- "name": "string",
- "type": "PRIVATE"
}{- "featureToggles": [
- "string"
], - "id": "string",
- "imageId": "bbefe473-c66a-4040-85cf-1c7e6f0b3830",
- "name": "string",
- "type": "PRIVATE"
}{- "axesCount": 0,
- "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
- "maintenanceItemValues": [
- {
- "distanceInterval": 0,
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "maintenanceItemId": "10be3182-291a-4dc6-bf71-aabafed209f8",
- "timeInterval": 0
}
], - "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
- "name": "string",
- "selectedVehicleParameters": [
- {
- "enabled": true,
- "vehicleParameterId": "74f97355-5ca7-4ed1-97df-b01206485647"
}
], - "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
- "typeName": "string",
- "workUnit": "KILOMETER"
}| organisationId required | string <uuid> |
| brandId required | string <uuid> |
[- {
- "axesCount": 0,
- "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
- "maintenanceItemValues": [
- {
- "distanceInterval": 0,
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "maintenanceItemId": "10be3182-291a-4dc6-bf71-aabafed209f8",
- "timeInterval": 0
}
], - "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
- "name": "string",
- "selectedVehicleParameters": [
- {
- "enabled": true,
- "vehicleParameterId": "74f97355-5ca7-4ed1-97df-b01206485647"
}
], - "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
- "typeName": "string",
- "workUnit": "KILOMETER"
}
]| organisationId required | string <uuid> |
| axesCount | integer <int32> [ 2 .. 4 ] |
| brandId | string <uuid> |
required | Array of objects (MaintenanceItemValueDTO) |
| modelId | string <uuid> |
| name required | string non-empty |
required | Array of objects (SelectedVehicleParameterDTO) |
| typeId required | string <uuid> |
| typeName | string |
| workUnit required | string (WorkUnit) Enum: "KILOMETER" "MILE" "HOUR" |
{- "axesCount": 2,
- "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
- "maintenanceItemValues": [
- {
- "booleanValue": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "maintenanceItemId": "10be3182-291a-4dc6-bf71-aabafed209f8",
- "multipleValue": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "singleValue": "d27d5344-a56e-44a6-ab6f-6ec776611635"
}
], - "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
- "name": "string",
- "selectedVehicleParameters": [
- {
- "description": "string",
- "enabled": true,
- "name": "string",
- "vehicleParameterId": "74f97355-5ca7-4ed1-97df-b01206485647"
}
], - "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
- "typeName": "string",
- "workUnit": "KILOMETER"
}{- "axesCount": 0,
- "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
- "maintenanceItemValues": [
- {
- "distanceInterval": 0,
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "maintenanceItemId": "10be3182-291a-4dc6-bf71-aabafed209f8",
- "timeInterval": 0
}
], - "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
- "name": "string",
- "selectedVehicleParameters": [
- {
- "enabled": true,
- "vehicleParameterId": "74f97355-5ca7-4ed1-97df-b01206485647"
}
], - "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
- "workUnit": "KILOMETER"
}| organisationId required | string <uuid> |
| modelId required | string <uuid> |
| axesCount | integer <int32> [ 2 .. 4 ] |
| brandId | string <uuid> |
required | Array of objects (MaintenanceItemValueDTO) |
| modelId | string <uuid> |
| name required | string non-empty |
required | Array of objects (SelectedVehicleParameterDTO) |
| typeId required | string <uuid> |
| typeName | string |
| workUnit required | string (WorkUnit) Enum: "KILOMETER" "MILE" "HOUR" |
{- "axesCount": 2,
- "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
- "maintenanceItemValues": [
- {
- "booleanValue": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "maintenanceItemId": "10be3182-291a-4dc6-bf71-aabafed209f8",
- "multipleValue": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "singleValue": "d27d5344-a56e-44a6-ab6f-6ec776611635"
}
], - "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
- "name": "string",
- "selectedVehicleParameters": [
- {
- "description": "string",
- "enabled": true,
- "name": "string",
- "vehicleParameterId": "74f97355-5ca7-4ed1-97df-b01206485647"
}
], - "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
- "typeName": "string",
- "workUnit": "KILOMETER"
}{- "axesCount": 0,
- "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
- "maintenanceItemValues": [
- {
- "distanceInterval": 0,
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "maintenanceItemId": "10be3182-291a-4dc6-bf71-aabafed209f8",
- "timeInterval": 0
}
], - "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
- "name": "string",
- "selectedVehicleParameters": [
- {
- "enabled": true,
- "vehicleParameterId": "74f97355-5ca7-4ed1-97df-b01206485647"
}
], - "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
- "workUnit": "KILOMETER"
}| organisationId required | string <uuid> |
| dutyItemId required | string <uuid> |
[- {
- "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
- "brandName": "string",
- "dutyStatus": "UNSET",
- "expirationDate": "2019-08-24",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
- "modelName": "string",
- "productionDate": "2019-08-24",
- "registration": "string",
- "registrationDate": "2019-08-24",
- "vin": "string"
}
][- {
- "createdUserId": "ea7e097f-834f-4fa5-87fc-4730a5fb67fe",
- "distance": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "itemList": [
- "string"
], - "modelName": "string",
- "operationDate": "2019-08-24",
- "registration": "string",
- "remarks": "string",
- "updatedUserId": "730d09f5-8bb3-40d5-8e8a-99d263e0b0ee"
}
][- {
- "amount": 3,
- "claimId": "88057929-7728-4a26-8396-f965dcc8b947",
- "claimState": "NEW",
- "closeReason": "Successful resolution",
- "comment": "Contact person John Doe III",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "finalResolution": "REPLACED",
- "internalClaimId": 1,
- "organisationId": "string",
- "partSerialNumber": "33447871",
- "preferredResolution": "REPLACE",
- "problemDescription": "The part got broken during standard exploration.",
- "problemOccurrenceDate": "2024-11-03",
- "responseDeadline": "2024-12-01",
- "submissionDate": "2024-11-10",
- "submissionUserId": "d600433f-912f-44ee-a51e-8165859cc8b1",
- "supplierClaimNumber": "56/2024",
- "uninstallationMaintenanceId": "9808cca7-4ef7-438b-923e-abe59019f83d",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleLoadDuringFault": 12345,
- "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81"
}
]required | object (OrganisationId) |
| amount | integer <int32> Amount of product |
| claimId | string <uuid> |
| claimState | string (ClaimState) Enum: "NEW" "SUBMITTED" "RESPONSE_DEADLINE_EXCEED" "CLOSED" |
| closeReason | string If available, for traceability. |
| comment | string Additional unstructured comment |
| createDateTime | string <date-time> |
| createUserId | string <uuid> |
| finalResolution | string (FinalResolution) Enum: "CANCELED" "REPLACED" "REFUND" "REJECTED" Final resolution replacement, a repair, or a refund. |
| internalClaimId | integer <int32> Unique user friendly claim ID for tracking purposes. |
| organisationId | string |
| partSerialNumber | string If available, for traceability. |
| preferredResolution | string (Resolution) Enum: "REPLACE" "REFUND" "WHATEVER" Whether the customer wants a replacement, a repair, or a refund. |
| problemDescription | string Detailed description of the issue or defect with the part. |
| problemOccurrenceDate | string <date> When the problem was first noticed. |
| responseDeadline | string <date> Supplier response deadline. |
| submissionDate | string <date> Date of Claim Submission: The date on which the warranty claim was filed. |
| submissionUserId | string <uuid> |
| supplierClaimNumber | string Supplier claim number. |
| uninstallationMaintenanceId | string <uuid> |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
| vehicleLoadDuringFault | integer <int32> Vehicle load during fault. |
| warrantyId | string <uuid> |
{- "amount": 3,
- "claimId": "88057929-7728-4a26-8396-f965dcc8b947",
- "claimState": "NEW",
- "closeReason": "Successful resolution",
- "comment": "Contact person John Doe III",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "finalResolution": "REPLACED",
- "internalClaimId": 1,
- "organisationId": "string",
- "partSerialNumber": "33447871",
- "preferredResolution": "REPLACE",
- "problemDescription": "The part got broken during standard exploration.",
- "problemOccurrenceDate": "2024-11-03",
- "responseDeadline": "2024-12-01",
- "submissionDate": "2024-11-10",
- "submissionUserId": "d600433f-912f-44ee-a51e-8165859cc8b1",
- "supplierClaimNumber": "56/2024",
- "uninstallationMaintenanceId": "9808cca7-4ef7-438b-923e-abe59019f83d",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleLoadDuringFault": 12345,
- "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81"
}{- "amount": 3,
- "claimId": "88057929-7728-4a26-8396-f965dcc8b947",
- "claimState": "NEW",
- "closeReason": "Successful resolution",
- "comment": "Contact person John Doe III",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "finalResolution": "REPLACED",
- "internalClaimId": 1,
- "organisationId": "string",
- "partSerialNumber": "33447871",
- "preferredResolution": "REPLACE",
- "problemDescription": "The part got broken during standard exploration.",
- "problemOccurrenceDate": "2024-11-03",
- "responseDeadline": "2024-12-01",
- "submissionDate": "2024-11-10",
- "submissionUserId": "d600433f-912f-44ee-a51e-8165859cc8b1",
- "supplierClaimNumber": "56/2024",
- "uninstallationMaintenanceId": "9808cca7-4ef7-438b-923e-abe59019f83d",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleLoadDuringFault": 12345,
- "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81"
}required | object (OrganisationId) |
| amount | integer <int32> Amount of product |
| claimId | string <uuid> |
| claimState | string (ClaimState) Enum: "NEW" "SUBMITTED" "RESPONSE_DEADLINE_EXCEED" "CLOSED" |
| closeReason | string If available, for traceability. |
| comment | string Additional unstructured comment |
| createDateTime | string <date-time> |
| createUserId | string <uuid> |
| finalResolution | string (FinalResolution) Enum: "CANCELED" "REPLACED" "REFUND" "REJECTED" Final resolution replacement, a repair, or a refund. |
| internalClaimId | integer <int32> Unique user friendly claim ID for tracking purposes. |
| organisationId | string |
| partSerialNumber | string If available, for traceability. |
| preferredResolution | string (Resolution) Enum: "REPLACE" "REFUND" "WHATEVER" Whether the customer wants a replacement, a repair, or a refund. |
| problemDescription | string Detailed description of the issue or defect with the part. |
| problemOccurrenceDate | string <date> When the problem was first noticed. |
| responseDeadline | string <date> Supplier response deadline. |
| submissionDate | string <date> Date of Claim Submission: The date on which the warranty claim was filed. |
| submissionUserId | string <uuid> |
| supplierClaimNumber | string Supplier claim number. |
| uninstallationMaintenanceId | string <uuid> |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
| vehicleLoadDuringFault | integer <int32> Vehicle load during fault. |
| warrantyId | string <uuid> |
{- "amount": 3,
- "claimId": "88057929-7728-4a26-8396-f965dcc8b947",
- "claimState": "NEW",
- "closeReason": "Successful resolution",
- "comment": "Contact person John Doe III",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "finalResolution": "REPLACED",
- "internalClaimId": 1,
- "organisationId": "string",
- "partSerialNumber": "33447871",
- "preferredResolution": "REPLACE",
- "problemDescription": "The part got broken during standard exploration.",
- "problemOccurrenceDate": "2024-11-03",
- "responseDeadline": "2024-12-01",
- "submissionDate": "2024-11-10",
- "submissionUserId": "d600433f-912f-44ee-a51e-8165859cc8b1",
- "supplierClaimNumber": "56/2024",
- "uninstallationMaintenanceId": "9808cca7-4ef7-438b-923e-abe59019f83d",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleLoadDuringFault": 12345,
- "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81"
}{- "amount": 3,
- "claimId": "88057929-7728-4a26-8396-f965dcc8b947",
- "claimState": "NEW",
- "closeReason": "Successful resolution",
- "comment": "Contact person John Doe III",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "finalResolution": "REPLACED",
- "internalClaimId": 1,
- "organisationId": "string",
- "partSerialNumber": "33447871",
- "preferredResolution": "REPLACE",
- "problemDescription": "The part got broken during standard exploration.",
- "problemOccurrenceDate": "2024-11-03",
- "responseDeadline": "2024-12-01",
- "submissionDate": "2024-11-10",
- "submissionUserId": "d600433f-912f-44ee-a51e-8165859cc8b1",
- "supplierClaimNumber": "56/2024",
- "uninstallationMaintenanceId": "9808cca7-4ef7-438b-923e-abe59019f83d",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleLoadDuringFault": 12345,
- "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81"
}required | object (OrganisationId) |
| claimId | string <uuid> |
{- "claimId": "88057929-7728-4a26-8396-f965dcc8b947"
}{- "amount": 3,
- "claimId": "88057929-7728-4a26-8396-f965dcc8b947",
- "claimState": "NEW",
- "closeReason": "Successful resolution",
- "comment": "Contact person John Doe III",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "finalResolution": "REPLACED",
- "internalClaimId": 1,
- "organisationId": "string",
- "partSerialNumber": "33447871",
- "preferredResolution": "REPLACE",
- "problemDescription": "The part got broken during standard exploration.",
- "problemOccurrenceDate": "2024-11-03",
- "responseDeadline": "2024-12-01",
- "submissionDate": "2024-11-10",
- "submissionUserId": "d600433f-912f-44ee-a51e-8165859cc8b1",
- "supplierClaimNumber": "56/2024",
- "uninstallationMaintenanceId": "9808cca7-4ef7-438b-923e-abe59019f83d",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleLoadDuringFault": 12345,
- "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81"
}required | object (OrganisationId) |
| claimId | string <uuid> |
{- "claimId": "88057929-7728-4a26-8396-f965dcc8b947"
}{- "amount": 3,
- "claimId": "88057929-7728-4a26-8396-f965dcc8b947",
- "claimState": "NEW",
- "closeReason": "Successful resolution",
- "comment": "Contact person John Doe III",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "finalResolution": "REPLACED",
- "internalClaimId": 1,
- "organisationId": "string",
- "partSerialNumber": "33447871",
- "preferredResolution": "REPLACE",
- "problemDescription": "The part got broken during standard exploration.",
- "problemOccurrenceDate": "2024-11-03",
- "responseDeadline": "2024-12-01",
- "submissionDate": "2024-11-10",
- "submissionUserId": "d600433f-912f-44ee-a51e-8165859cc8b1",
- "supplierClaimNumber": "56/2024",
- "uninstallationMaintenanceId": "9808cca7-4ef7-438b-923e-abe59019f83d",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleLoadDuringFault": 12345,
- "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81"
}| claimId required | string <uuid> |
required | object (OrganisationId) |
{- "amount": 3,
- "claimId": "88057929-7728-4a26-8396-f965dcc8b947",
- "claimState": "NEW",
- "closeReason": "Successful resolution",
- "comment": "Contact person John Doe III",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "finalResolution": "REPLACED",
- "internalClaimId": 1,
- "organisationId": "string",
- "partSerialNumber": "33447871",
- "preferredResolution": "REPLACE",
- "problemDescription": "The part got broken during standard exploration.",
- "problemOccurrenceDate": "2024-11-03",
- "responseDeadline": "2024-12-01",
- "submissionDate": "2024-11-10",
- "submissionUserId": "d600433f-912f-44ee-a51e-8165859cc8b1",
- "supplierClaimNumber": "56/2024",
- "uninstallationMaintenanceId": "9808cca7-4ef7-438b-923e-abe59019f83d",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "vehicleLoadDuringFault": 12345,
- "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81"
}[- {
- "city": "string",
- "comment": "Contact person John Doe I",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "customerNumber": "12345",
- "email": "string",
- "name": "string",
- "organisationId": "string",
- "phoneNumber": "string",
- "postalCode": "string",
- "street": "string",
- "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}
]required | object (OrganisationId) |
| city | string |
| comment | string Additional unstructured comment |
| createDateTime | string <date-time> |
| createUserId | string <uuid> |
| customerNumber | string Customer number in supplier system |
string | |
| name | string |
| organisationId | string |
| phoneNumber | string |
| postalCode | string |
| street | string |
| supplierId | string <uuid> |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
{- "city": "string",
- "comment": "Contact person John Doe I",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "customerNumber": "12345",
- "email": "string",
- "name": "string",
- "organisationId": "string",
- "phoneNumber": "string",
- "postalCode": "string",
- "street": "string",
- "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}{- "city": "string",
- "comment": "Contact person John Doe I",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "customerNumber": "12345",
- "email": "string",
- "name": "string",
- "organisationId": "string",
- "phoneNumber": "string",
- "postalCode": "string",
- "street": "string",
- "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}required | object (OrganisationId) |
| city | string |
| comment | string Additional unstructured comment |
| createDateTime | string <date-time> |
| createUserId | string <uuid> |
| customerNumber | string Customer number in supplier system |
string | |
| name | string |
| organisationId | string |
| phoneNumber | string |
| postalCode | string |
| street | string |
| supplierId | string <uuid> |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
{- "city": "string",
- "comment": "Contact person John Doe I",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "customerNumber": "12345",
- "email": "string",
- "name": "string",
- "organisationId": "string",
- "phoneNumber": "string",
- "postalCode": "string",
- "street": "string",
- "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}{- "city": "string",
- "comment": "Contact person John Doe I",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "customerNumber": "12345",
- "email": "string",
- "name": "string",
- "organisationId": "string",
- "phoneNumber": "string",
- "postalCode": "string",
- "street": "string",
- "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}| supplierId required | string <uuid> |
required | object (OrganisationId) |
{- "city": "string",
- "comment": "Contact person John Doe I",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "customerNumber": "12345",
- "email": "string",
- "name": "string",
- "organisationId": "string",
- "phoneNumber": "string",
- "postalCode": "string",
- "street": "string",
- "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54"
}[- {
- "cloudStorageFolder": "/Users/Tecaser/warranty/2024",
- "comment": "Contact person John Doe II",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "expirationDate": "2026-03-10",
- "expirationDistance": 20000,
- "installationMaintenanceId": "945bc318-33d1-4968-87e3-4ed9cf91fc00",
- "invoiceDate": "2019-08-24",
- "invoiceNumber": "123/2024",
- "organisationId": "string",
- "partDescription": "Front brake pad for Volvo TGR 440",
- "partName": "Front brake pad for TGR 440",
- "partNumber": "33447871",
- "placeOfPurchase": "Cracow",
- "purchaseDate": "2019-08-24",
- "registrationDate": "2024-04-01",
- "registrationNumber": "R/123/2024/VLV",
- "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81",
- "warrantyState": "NEW"
}
]required | object (OrganisationId) |
| cloudStorageFolder | string Store scanned copies of invoices, warranty cards, and other documents in a cloud storage folder for easy access. |
| comment | string Additional unstructured comment |
| createDateTime | string <date-time> |
| createUserId | string <uuid> |
| expirationDate | string <date> To check expiration date under warranty coverage. |
| expirationDistance | integer <int32> To check expiration distance under warranty coverage. |
| installationMaintenanceId | string <uuid> |
| invoiceDate | string <date> |
| invoiceNumber | string The original purchase invoice number for verification. |
| organisationId | string |
| partDescription | string Description of the part. |
| partName | string Name of the part. |
| partNumber | string The specific part number for easy identification. |
| placeOfPurchase | string Place of purchase. |
| purchaseDate | string <date> |
| registrationDate | string <date> The date you registered the product with the manufacturer. |
| registrationNumber | string If the product required online registration for the warranty, note down the registration confirmation or number. |
| supplierId | string <uuid> |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
| warrantyId | string <uuid> |
| warrantyState | string (WarrantyState) Enum: "NEW" "INSTALLED" "EXPIRED_SOON" "EXPIRED" |
{- "cloudStorageFolder": "/Users/Tecaser/warranty/2024",
- "comment": "Contact person John Doe II",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "expirationDate": "2026-03-10",
- "expirationDistance": 20000,
- "installationMaintenanceId": "945bc318-33d1-4968-87e3-4ed9cf91fc00",
- "invoiceDate": "2019-08-24",
- "invoiceNumber": "123/2024",
- "organisationId": "string",
- "partDescription": "Front brake pad for Volvo TGR 440",
- "partName": "Front brake pad for TGR 440",
- "partNumber": "33447871",
- "placeOfPurchase": "Cracow",
- "purchaseDate": "2019-08-24",
- "registrationDate": "2024-04-01",
- "registrationNumber": "R/123/2024/VLV",
- "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81",
- "warrantyState": "NEW"
}{- "cloudStorageFolder": "/Users/Tecaser/warranty/2024",
- "comment": "Contact person John Doe II",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "expirationDate": "2026-03-10",
- "expirationDistance": 20000,
- "installationMaintenanceId": "945bc318-33d1-4968-87e3-4ed9cf91fc00",
- "invoiceDate": "2019-08-24",
- "invoiceNumber": "123/2024",
- "organisationId": "string",
- "partDescription": "Front brake pad for Volvo TGR 440",
- "partName": "Front brake pad for TGR 440",
- "partNumber": "33447871",
- "placeOfPurchase": "Cracow",
- "purchaseDate": "2019-08-24",
- "registrationDate": "2024-04-01",
- "registrationNumber": "R/123/2024/VLV",
- "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81",
- "warrantyState": "NEW"
}required | object (OrganisationId) |
| cloudStorageFolder | string Store scanned copies of invoices, warranty cards, and other documents in a cloud storage folder for easy access. |
| comment | string Additional unstructured comment |
| createDateTime | string <date-time> |
| createUserId | string <uuid> |
| expirationDate | string <date> To check expiration date under warranty coverage. |
| expirationDistance | integer <int32> To check expiration distance under warranty coverage. |
| installationMaintenanceId | string <uuid> |
| invoiceDate | string <date> |
| invoiceNumber | string The original purchase invoice number for verification. |
| organisationId | string |
| partDescription | string Description of the part. |
| partName | string Name of the part. |
| partNumber | string The specific part number for easy identification. |
| placeOfPurchase | string Place of purchase. |
| purchaseDate | string <date> |
| registrationDate | string <date> The date you registered the product with the manufacturer. |
| registrationNumber | string If the product required online registration for the warranty, note down the registration confirmation or number. |
| supplierId | string <uuid> |
| updateDateTime | string <date-time> |
| updateUserId | string <uuid> |
| warrantyId | string <uuid> |
| warrantyState | string (WarrantyState) Enum: "NEW" "INSTALLED" "EXPIRED_SOON" "EXPIRED" |
{- "cloudStorageFolder": "/Users/Tecaser/warranty/2024",
- "comment": "Contact person John Doe II",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "expirationDate": "2026-03-10",
- "expirationDistance": 20000,
- "installationMaintenanceId": "945bc318-33d1-4968-87e3-4ed9cf91fc00",
- "invoiceDate": "2019-08-24",
- "invoiceNumber": "123/2024",
- "organisationId": "string",
- "partDescription": "Front brake pad for Volvo TGR 440",
- "partName": "Front brake pad for TGR 440",
- "partNumber": "33447871",
- "placeOfPurchase": "Cracow",
- "purchaseDate": "2019-08-24",
- "registrationDate": "2024-04-01",
- "registrationNumber": "R/123/2024/VLV",
- "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81",
- "warrantyState": "NEW"
}{- "cloudStorageFolder": "/Users/Tecaser/warranty/2024",
- "comment": "Contact person John Doe II",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "expirationDate": "2026-03-10",
- "expirationDistance": 20000,
- "installationMaintenanceId": "945bc318-33d1-4968-87e3-4ed9cf91fc00",
- "invoiceDate": "2019-08-24",
- "invoiceNumber": "123/2024",
- "organisationId": "string",
- "partDescription": "Front brake pad for Volvo TGR 440",
- "partName": "Front brake pad for TGR 440",
- "partNumber": "33447871",
- "placeOfPurchase": "Cracow",
- "purchaseDate": "2019-08-24",
- "registrationDate": "2024-04-01",
- "registrationNumber": "R/123/2024/VLV",
- "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81",
- "warrantyState": "NEW"
}required | object (OrganisationId) |
| warrantyId | string <uuid> |
{- "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81"
}{- "cloudStorageFolder": "/Users/Tecaser/warranty/2024",
- "comment": "Contact person John Doe II",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "expirationDate": "2026-03-10",
- "expirationDistance": 20000,
- "installationMaintenanceId": "945bc318-33d1-4968-87e3-4ed9cf91fc00",
- "invoiceDate": "2019-08-24",
- "invoiceNumber": "123/2024",
- "organisationId": "string",
- "partDescription": "Front brake pad for Volvo TGR 440",
- "partName": "Front brake pad for TGR 440",
- "partNumber": "33447871",
- "placeOfPurchase": "Cracow",
- "purchaseDate": "2019-08-24",
- "registrationDate": "2024-04-01",
- "registrationNumber": "R/123/2024/VLV",
- "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81",
- "warrantyState": "NEW"
}| warrantyId required | string <uuid> |
required | object (OrganisationId) |
{- "cloudStorageFolder": "/Users/Tecaser/warranty/2024",
- "comment": "Contact person John Doe II",
- "createDateTime": "2019-08-24T14:15:22Z",
- "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
- "expirationDate": "2026-03-10",
- "expirationDistance": 20000,
- "installationMaintenanceId": "945bc318-33d1-4968-87e3-4ed9cf91fc00",
- "invoiceDate": "2019-08-24",
- "invoiceNumber": "123/2024",
- "organisationId": "string",
- "partDescription": "Front brake pad for Volvo TGR 440",
- "partName": "Front brake pad for TGR 440",
- "partNumber": "33447871",
- "placeOfPurchase": "Cracow",
- "purchaseDate": "2019-08-24",
- "registrationDate": "2024-04-01",
- "registrationNumber": "R/123/2024/VLV",
- "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
- "updateDateTime": "2019-08-24T14:15:22Z",
- "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
- "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81",
- "warrantyState": "NEW"
}