API docs by Redocly

OpenAPI definition (v0)

Download OpenAPI specification:Download

warranty-controller

getAll

header Parameters
required
object (OrganisationId)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

update

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
warrantyId
string <uuid>
organisationId
string
createDateTime
string <date-time>
updateDateTime
string <date-time>
createUserId
string <uuid>
updateUserId
string <uuid>
warrantyState
string (WarrantyState)
Enum: "NEW" "INSTALLED" "EXPIRED_SOON" "EXPIRED"
supplierId
string <uuid>
invoiceNumber
string

The original purchase invoice number for verification.

invoiceDate
string <date>
purchaseDate
string <date>
installationMaintenanceId
string <uuid>
expirationDate
string <date>

To check expiration date under warranty coverage.

expirationDistance
integer <int32>

To check expiration distance under warranty coverage.

partName
string

Name of the part.

partDescription
string

Description of the part.

partNumber
string

The specific part number for easy identification.

placeOfPurchase
string

Place of purchase.

registrationNumber
string

If the product required online registration for the warranty, note down the registration confirmation or number.

registrationDate
string <date>

The date you registered the product with the manufacturer.

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

Responses

Request samples

Content type
application/json
{
  • "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "warrantyState": "NEW",
  • "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
  • "invoiceNumber": "123/2024",
  • "invoiceDate": "2019-08-24",
  • "purchaseDate": "2019-08-24",
  • "installationMaintenanceId": "945bc318-33d1-4968-87e3-4ed9cf91fc00",
  • "expirationDate": "2026-03-10",
  • "expirationDistance": 20000,
  • "partName": "Front brake pad for TGR 440",
  • "partDescription": "Front brake pad for Volvo TGR 440",
  • "partNumber": "33447871",
  • "placeOfPurchase": "Cracow",
  • "registrationNumber": "R/123/2024/VLV",
  • "registrationDate": "2024-04-01",
  • "cloudStorageFolder": "/Users/Tecaser/warranty/2024",
  • "comment": "Contact person John Doe II"
}

Response samples

Content type
application/json
{
  • "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "warrantyState": "NEW",
  • "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
  • "invoiceNumber": "123/2024",
  • "invoiceDate": "2019-08-24",
  • "purchaseDate": "2019-08-24",
  • "installationMaintenanceId": "945bc318-33d1-4968-87e3-4ed9cf91fc00",
  • "expirationDate": "2026-03-10",
  • "expirationDistance": 20000,
  • "partName": "Front brake pad for TGR 440",
  • "partDescription": "Front brake pad for Volvo TGR 440",
  • "partNumber": "33447871",
  • "placeOfPurchase": "Cracow",
  • "registrationNumber": "R/123/2024/VLV",
  • "registrationDate": "2024-04-01",
  • "cloudStorageFolder": "/Users/Tecaser/warranty/2024",
  • "comment": "Contact person John Doe II"
}

create

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
warrantyId
string <uuid>
organisationId
string
createDateTime
string <date-time>
updateDateTime
string <date-time>
createUserId
string <uuid>
updateUserId
string <uuid>
warrantyState
string (WarrantyState)
Enum: "NEW" "INSTALLED" "EXPIRED_SOON" "EXPIRED"
supplierId
string <uuid>
invoiceNumber
string

The original purchase invoice number for verification.

invoiceDate
string <date>
purchaseDate
string <date>
installationMaintenanceId
string <uuid>
expirationDate
string <date>

To check expiration date under warranty coverage.

expirationDistance
integer <int32>

To check expiration distance under warranty coverage.

partName
string

Name of the part.

partDescription
string

Description of the part.

partNumber
string

The specific part number for easy identification.

placeOfPurchase
string

Place of purchase.

registrationNumber
string

If the product required online registration for the warranty, note down the registration confirmation or number.

registrationDate
string <date>

The date you registered the product with the manufacturer.

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

Responses

Request samples

Content type
application/json
{
  • "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "warrantyState": "NEW",
  • "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
  • "invoiceNumber": "123/2024",
  • "invoiceDate": "2019-08-24",
  • "purchaseDate": "2019-08-24",
  • "installationMaintenanceId": "945bc318-33d1-4968-87e3-4ed9cf91fc00",
  • "expirationDate": "2026-03-10",
  • "expirationDistance": 20000,
  • "partName": "Front brake pad for TGR 440",
  • "partDescription": "Front brake pad for Volvo TGR 440",
  • "partNumber": "33447871",
  • "placeOfPurchase": "Cracow",
  • "registrationNumber": "R/123/2024/VLV",
  • "registrationDate": "2024-04-01",
  • "cloudStorageFolder": "/Users/Tecaser/warranty/2024",
  • "comment": "Contact person John Doe II"
}

Response samples

Content type
application/json
{
  • "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "warrantyState": "NEW",
  • "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
  • "invoiceNumber": "123/2024",
  • "invoiceDate": "2019-08-24",
  • "purchaseDate": "2019-08-24",
  • "installationMaintenanceId": "945bc318-33d1-4968-87e3-4ed9cf91fc00",
  • "expirationDate": "2026-03-10",
  • "expirationDistance": 20000,
  • "partName": "Front brake pad for TGR 440",
  • "partDescription": "Front brake pad for Volvo TGR 440",
  • "partNumber": "33447871",
  • "placeOfPurchase": "Cracow",
  • "registrationNumber": "R/123/2024/VLV",
  • "registrationDate": "2024-04-01",
  • "cloudStorageFolder": "/Users/Tecaser/warranty/2024",
  • "comment": "Contact person John Doe II"
}

install

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
warrantyId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81"
}

Response samples

Content type
application/json
{
  • "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "warrantyState": "NEW",
  • "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
  • "invoiceNumber": "123/2024",
  • "invoiceDate": "2019-08-24",
  • "purchaseDate": "2019-08-24",
  • "installationMaintenanceId": "945bc318-33d1-4968-87e3-4ed9cf91fc00",
  • "expirationDate": "2026-03-10",
  • "expirationDistance": 20000,
  • "partName": "Front brake pad for TGR 440",
  • "partDescription": "Front brake pad for Volvo TGR 440",
  • "partNumber": "33447871",
  • "placeOfPurchase": "Cracow",
  • "registrationNumber": "R/123/2024/VLV",
  • "registrationDate": "2024-04-01",
  • "cloudStorageFolder": "/Users/Tecaser/warranty/2024",
  • "comment": "Contact person John Doe II"
}

get

path Parameters
warrantyId
required
string <uuid>
header Parameters
required
object (OrganisationId)

Responses

Response samples

Content type
application/json
{
  • "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "warrantyState": "NEW",
  • "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
  • "invoiceNumber": "123/2024",
  • "invoiceDate": "2019-08-24",
  • "purchaseDate": "2019-08-24",
  • "installationMaintenanceId": "945bc318-33d1-4968-87e3-4ed9cf91fc00",
  • "expirationDate": "2026-03-10",
  • "expirationDistance": 20000,
  • "partName": "Front brake pad for TGR 440",
  • "partDescription": "Front brake pad for Volvo TGR 440",
  • "partNumber": "33447871",
  • "placeOfPurchase": "Cracow",
  • "registrationNumber": "R/123/2024/VLV",
  • "registrationDate": "2024-04-01",
  • "cloudStorageFolder": "/Users/Tecaser/warranty/2024",
  • "comment": "Contact person John Doe II"
}

supplier-controller

getAll_1

header Parameters
required
object (OrganisationId)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

update_1

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
supplierId
string <uuid>
organisationId
string
createDateTime
string <date-time>
updateDateTime
string <date-time>
createUserId
string <uuid>
updateUserId
string <uuid>
name
string
street
string
city
string
postalCode
string
email
string
phoneNumber
string
customerNumber
string

Customer number in supplier system

comment
string

Additional unstructured comment

Responses

Request samples

Content type
application/json
{
  • "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "name": "string",
  • "street": "string",
  • "city": "string",
  • "postalCode": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "customerNumber": "12345",
  • "comment": "Contact person John Doe I"
}

Response samples

Content type
application/json
{
  • "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "name": "string",
  • "street": "string",
  • "city": "string",
  • "postalCode": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "customerNumber": "12345",
  • "comment": "Contact person John Doe I"
}

create_1

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
supplierId
string <uuid>
organisationId
string
createDateTime
string <date-time>
updateDateTime
string <date-time>
createUserId
string <uuid>
updateUserId
string <uuid>
name
string
street
string
city
string
postalCode
string
email
string
phoneNumber
string
customerNumber
string

Customer number in supplier system

comment
string

Additional unstructured comment

Responses

Request samples

Content type
application/json
{
  • "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "name": "string",
  • "street": "string",
  • "city": "string",
  • "postalCode": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "customerNumber": "12345",
  • "comment": "Contact person John Doe I"
}

Response samples

Content type
application/json
{
  • "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "name": "string",
  • "street": "string",
  • "city": "string",
  • "postalCode": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "customerNumber": "12345",
  • "comment": "Contact person John Doe I"
}

get_1

path Parameters
supplierId
required
string <uuid>
header Parameters
required
object (OrganisationId)

Responses

Response samples

Content type
application/json
{
  • "supplierId": "e01eb4c4-8eb9-4fb7-b625-61f58c6148db",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "name": "string",
  • "street": "string",
  • "city": "string",
  • "postalCode": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "customerNumber": "12345",
  • "comment": "Contact person John Doe I"
}

claim-controller

getAll_2

header Parameters
required
object (OrganisationId)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

update_2

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
claimId
string <uuid>
organisationId
string
createDateTime
string <date-time>
updateDateTime
string <date-time>
createUserId
string <uuid>
updateUserId
string <uuid>
claimState
string (ClaimState)
Enum: "NEW" "SUBMITTED" "RESPONSE_DEADLINE_EXCEED" "CLOSED"
internalClaimId
integer <int32>

Unique user friendly claim ID for tracking purposes.

warrantyId
string <uuid>
amount
integer <int32>

Amount of product

submissionDate
string <date>

Date of Claim Submission: The date on which the warranty claim was filed.

submissionUserId
string <uuid>
problemOccurrenceDate
string <date>

When the problem was first noticed.

vehicleLoadDuringFault
integer <int32>

Vehicle load during fault.

supplierClaimNumber
string

Supplier claim number.

uninstallationMaintenanceId
string <uuid>
problemDescription
string

Detailed description of the issue or defect with the part.

partSerialNumber
string

If available, for traceability.

preferredResolution
string (Resolution)
Enum: "REPLACE" "REFUND" "WHATEVER"

Whether the customer wants a replacement, a repair, or a refund.

closeReason
string

If available, for traceability.

finalResolution
string (FinalResolution)
Enum: "CANCELED" "REPLACED" "REFUND" "REJECTED"

Final resolution replacement, a repair, or a refund.

responseDeadline
string <date>

Supplier response deadline.

comment
string

Additional unstructured comment

Responses

Request samples

Content type
application/json
{
  • "claimId": "88057929-7728-4a26-8396-f965dcc8b947",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "claimState": "NEW",
  • "internalClaimId": 1,
  • "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81",
  • "amount": 3,
  • "submissionDate": "2024-11-10",
  • "submissionUserId": "d600433f-912f-44ee-a51e-8165859cc8b1",
  • "problemOccurrenceDate": "2024-11-03",
  • "vehicleLoadDuringFault": 12345,
  • "supplierClaimNumber": "56/2024",
  • "uninstallationMaintenanceId": "9808cca7-4ef7-438b-923e-abe59019f83d",
  • "problemDescription": "The part got broken during standard exploration.",
  • "partSerialNumber": "33447871",
  • "preferredResolution": "REPLACE",
  • "closeReason": "Successful resolution",
  • "finalResolution": "REPLACED",
  • "responseDeadline": "2024-12-01",
  • "comment": "Contact person John Doe III"
}

Response samples

Content type
application/json
{
  • "claimId": "88057929-7728-4a26-8396-f965dcc8b947",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "claimState": "NEW",
  • "internalClaimId": 1,
  • "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81",
  • "amount": 3,
  • "submissionDate": "2024-11-10",
  • "submissionUserId": "d600433f-912f-44ee-a51e-8165859cc8b1",
  • "problemOccurrenceDate": "2024-11-03",
  • "vehicleLoadDuringFault": 12345,
  • "supplierClaimNumber": "56/2024",
  • "uninstallationMaintenanceId": "9808cca7-4ef7-438b-923e-abe59019f83d",
  • "problemDescription": "The part got broken during standard exploration.",
  • "partSerialNumber": "33447871",
  • "preferredResolution": "REPLACE",
  • "closeReason": "Successful resolution",
  • "finalResolution": "REPLACED",
  • "responseDeadline": "2024-12-01",
  • "comment": "Contact person John Doe III"
}

create_2

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
claimId
string <uuid>
organisationId
string
createDateTime
string <date-time>
updateDateTime
string <date-time>
createUserId
string <uuid>
updateUserId
string <uuid>
claimState
string (ClaimState)
Enum: "NEW" "SUBMITTED" "RESPONSE_DEADLINE_EXCEED" "CLOSED"
internalClaimId
integer <int32>

Unique user friendly claim ID for tracking purposes.

warrantyId
string <uuid>
amount
integer <int32>

Amount of product

submissionDate
string <date>

Date of Claim Submission: The date on which the warranty claim was filed.

submissionUserId
string <uuid>
problemOccurrenceDate
string <date>

When the problem was first noticed.

vehicleLoadDuringFault
integer <int32>

Vehicle load during fault.

supplierClaimNumber
string

Supplier claim number.

uninstallationMaintenanceId
string <uuid>
problemDescription
string

Detailed description of the issue or defect with the part.

partSerialNumber
string

If available, for traceability.

preferredResolution
string (Resolution)
Enum: "REPLACE" "REFUND" "WHATEVER"

Whether the customer wants a replacement, a repair, or a refund.

closeReason
string

If available, for traceability.

finalResolution
string (FinalResolution)
Enum: "CANCELED" "REPLACED" "REFUND" "REJECTED"

Final resolution replacement, a repair, or a refund.

responseDeadline
string <date>

Supplier response deadline.

comment
string

Additional unstructured comment

Responses

Request samples

Content type
application/json
{
  • "claimId": "88057929-7728-4a26-8396-f965dcc8b947",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "claimState": "NEW",
  • "internalClaimId": 1,
  • "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81",
  • "amount": 3,
  • "submissionDate": "2024-11-10",
  • "submissionUserId": "d600433f-912f-44ee-a51e-8165859cc8b1",
  • "problemOccurrenceDate": "2024-11-03",
  • "vehicleLoadDuringFault": 12345,
  • "supplierClaimNumber": "56/2024",
  • "uninstallationMaintenanceId": "9808cca7-4ef7-438b-923e-abe59019f83d",
  • "problemDescription": "The part got broken during standard exploration.",
  • "partSerialNumber": "33447871",
  • "preferredResolution": "REPLACE",
  • "closeReason": "Successful resolution",
  • "finalResolution": "REPLACED",
  • "responseDeadline": "2024-12-01",
  • "comment": "Contact person John Doe III"
}

Response samples

Content type
application/json
{
  • "claimId": "88057929-7728-4a26-8396-f965dcc8b947",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "claimState": "NEW",
  • "internalClaimId": 1,
  • "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81",
  • "amount": 3,
  • "submissionDate": "2024-11-10",
  • "submissionUserId": "d600433f-912f-44ee-a51e-8165859cc8b1",
  • "problemOccurrenceDate": "2024-11-03",
  • "vehicleLoadDuringFault": 12345,
  • "supplierClaimNumber": "56/2024",
  • "uninstallationMaintenanceId": "9808cca7-4ef7-438b-923e-abe59019f83d",
  • "problemDescription": "The part got broken during standard exploration.",
  • "partSerialNumber": "33447871",
  • "preferredResolution": "REPLACE",
  • "closeReason": "Successful resolution",
  • "finalResolution": "REPLACED",
  • "responseDeadline": "2024-12-01",
  • "comment": "Contact person John Doe III"
}

submit

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
claimId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "claimId": "88057929-7728-4a26-8396-f965dcc8b947"
}

Response samples

Content type
application/json
{
  • "claimId": "88057929-7728-4a26-8396-f965dcc8b947",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "claimState": "NEW",
  • "internalClaimId": 1,
  • "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81",
  • "amount": 3,
  • "submissionDate": "2024-11-10",
  • "submissionUserId": "d600433f-912f-44ee-a51e-8165859cc8b1",
  • "problemOccurrenceDate": "2024-11-03",
  • "vehicleLoadDuringFault": 12345,
  • "supplierClaimNumber": "56/2024",
  • "uninstallationMaintenanceId": "9808cca7-4ef7-438b-923e-abe59019f83d",
  • "problemDescription": "The part got broken during standard exploration.",
  • "partSerialNumber": "33447871",
  • "preferredResolution": "REPLACE",
  • "closeReason": "Successful resolution",
  • "finalResolution": "REPLACED",
  • "responseDeadline": "2024-12-01",
  • "comment": "Contact person John Doe III"
}

close_1

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
claimId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "claimId": "88057929-7728-4a26-8396-f965dcc8b947"
}

Response samples

Content type
application/json
{
  • "claimId": "88057929-7728-4a26-8396-f965dcc8b947",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "claimState": "NEW",
  • "internalClaimId": 1,
  • "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81",
  • "amount": 3,
  • "submissionDate": "2024-11-10",
  • "submissionUserId": "d600433f-912f-44ee-a51e-8165859cc8b1",
  • "problemOccurrenceDate": "2024-11-03",
  • "vehicleLoadDuringFault": 12345,
  • "supplierClaimNumber": "56/2024",
  • "uninstallationMaintenanceId": "9808cca7-4ef7-438b-923e-abe59019f83d",
  • "problemDescription": "The part got broken during standard exploration.",
  • "partSerialNumber": "33447871",
  • "preferredResolution": "REPLACE",
  • "closeReason": "Successful resolution",
  • "finalResolution": "REPLACED",
  • "responseDeadline": "2024-12-01",
  • "comment": "Contact person John Doe III"
}

get_2

path Parameters
claimId
required
string <uuid>
header Parameters
required
object (OrganisationId)

Responses

Response samples

Content type
application/json
{
  • "claimId": "88057929-7728-4a26-8396-f965dcc8b947",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "claimState": "NEW",
  • "internalClaimId": 1,
  • "warrantyId": "ceb519c6-3040-4c2c-99a5-9fe694427f81",
  • "amount": 3,
  • "submissionDate": "2024-11-10",
  • "submissionUserId": "d600433f-912f-44ee-a51e-8165859cc8b1",
  • "problemOccurrenceDate": "2024-11-03",
  • "vehicleLoadDuringFault": 12345,
  • "supplierClaimNumber": "56/2024",
  • "uninstallationMaintenanceId": "9808cca7-4ef7-438b-923e-abe59019f83d",
  • "problemDescription": "The part got broken during standard exploration.",
  • "partSerialNumber": "33447871",
  • "preferredResolution": "REPLACE",
  • "closeReason": "Successful resolution",
  • "finalResolution": "REPLACED",
  • "responseDeadline": "2024-12-01",
  • "comment": "Contact person John Doe III"
}

vehicle-controller

getVehicle Deprecated

path Parameters
vehicleId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "axesCount": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "vin": "string",
  • "registration": "string",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "brandName": "string",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "modelName": "string",
  • "registrationDate": "2019-08-24",
  • "firstRegistrationInCountryDate": "2019-08-24",
  • "productionDate": "2019-08-24",
  • "duties": [
    ],
  • "color": "BLACK",
  • "distanceUnit": "KILOMETER",
  • "remarks": "string",
  • "enabled": true,
  • "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
  • "trailer": true,
  • "trailerMillage": true,
  • "status": "ERROR",
  • "createdTimestamp": "2019-08-24T14:15:22Z",
  • "updatedTimestamp": "2019-08-24T14:15:22Z",
  • "createdPersonId": "725aa23d-feb7-48a8-9f3f-3bed04243ae5",
  • "updatedPersonId": "94de6710-6ec2-42e9-b486-8ddb836e206e"
}

updateVehicle Deprecated

path Parameters
vehicleId
required
string <uuid>
Request Body schema: application/json
required
enabled
boolean
registration
required
string
vin
string
modelId
required
string <uuid>
productionDate
string <date>
registrationDate
string <date>
remarks
required
string
color
string (VehicleColor)
Enum: "BLACK" "WHITE" "GRAY" "RED" "BLUE" "GREEN" "DARK_BLUE" "SILVER"
destinationId
required
string <uuid>
trailerMillage
required
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "registration": "string",
  • "vin": "string",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "productionDate": "2019-08-24",
  • "registrationDate": "2019-08-24",
  • "remarks": "string",
  • "color": "BLACK",
  • "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
  • "trailerMillage": true
}

Response samples

Content type
application/json
{ }

updateVehicleV1_2_2 Deprecated

path Parameters
vehicleId
required
string <uuid>
Request Body schema: application/json
required
enabled
boolean
registration
required
string
vin
string
modelId
required
string <uuid>
productionDate
string <date>
registrationDate
string <date>
firstRegistrationInCountryDate
string <date>
remarks
required
string
color
string (VehicleColor)
Enum: "BLACK" "WHITE" "GRAY" "RED" "BLUE" "GREEN" "DARK_BLUE" "SILVER"
destinationId
required
string <uuid>
trailerMillage
required
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "registration": "string",
  • "vin": "string",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "productionDate": "2019-08-24",
  • "registrationDate": "2019-08-24",
  • "firstRegistrationInCountryDate": "2019-08-24",
  • "remarks": "string",
  • "color": "BLACK",
  • "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
  • "trailerMillage": true
}

Response samples

Content type
application/json
{ }

updateVehicleV1_1 Deprecated

path Parameters
vehicleId
required
string <uuid>
Request Body schema: application/json
required
enabled
boolean
registration
required
string
vin
string
modelId
required
string <uuid>
productionDate
string <date>
registrationDate
string <date>
firstRegistrationInCountryDate
string <date>
remarks
required
string
color
string (VehicleColor)
Enum: "BLACK" "WHITE" "GRAY" "RED" "BLUE" "GREEN" "DARK_BLUE" "SILVER"
destinationId
required
string <uuid>
trailerMillage
required
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "registration": "string",
  • "vin": "string",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "productionDate": "2019-08-24",
  • "registrationDate": "2019-08-24",
  • "firstRegistrationInCountryDate": "2019-08-24",
  • "remarks": "string",
  • "color": "BLACK",
  • "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
  • "trailerMillage": true
}

Response samples

Content type
application/json
{ }

getVehicles Deprecated

query Parameters
enabled
boolean
Default: true

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createVehicle Deprecated

Request Body schema: application/json
required
enabled
boolean
registration
required
string
vin
string
modelId
required
string <uuid>
productionDate
string <date>
registrationDate
string <date>
remarks
required
string
color
string (VehicleColor)
Enum: "BLACK" "WHITE" "GRAY" "RED" "BLUE" "GREEN" "DARK_BLUE" "SILVER"
destinationId
required
string <uuid>
trailerMillage
required
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "registration": "string",
  • "vin": "string",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "productionDate": "2019-08-24",
  • "registrationDate": "2019-08-24",
  • "remarks": "string",
  • "color": "BLACK",
  • "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
  • "trailerMillage": true
}

Response samples

Content type
application/json
{
  • "axesCount": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "vin": "string",
  • "registration": "string",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "brandName": "string",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "modelName": "string",
  • "registrationDate": "2019-08-24",
  • "firstRegistrationInCountryDate": "2019-08-24",
  • "productionDate": "2019-08-24",
  • "duties": [
    ],
  • "color": "BLACK",
  • "distanceUnit": "KILOMETER",
  • "remarks": "string",
  • "enabled": true,
  • "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
  • "trailer": true,
  • "trailerMillage": true,
  • "status": "ERROR",
  • "createdTimestamp": "2019-08-24T14:15:22Z",
  • "updatedTimestamp": "2019-08-24T14:15:22Z",
  • "createdPersonId": "725aa23d-feb7-48a8-9f3f-3bed04243ae5",
  • "updatedPersonId": "94de6710-6ec2-42e9-b486-8ddb836e206e"
}

createVehicleV12_2 Deprecated

Request Body schema: application/json
required
enabled
boolean
registration
required
string
vin
string
modelId
required
string <uuid>
productionDate
string <date>
registrationDate
string <date>
firstRegistrationInCountryDate
string <date>
remarks
required
string
color
string (VehicleColor)
Enum: "BLACK" "WHITE" "GRAY" "RED" "BLUE" "GREEN" "DARK_BLUE" "SILVER"
destinationId
required
string <uuid>
trailerMillage
required
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "registration": "string",
  • "vin": "string",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "productionDate": "2019-08-24",
  • "registrationDate": "2019-08-24",
  • "firstRegistrationInCountryDate": "2019-08-24",
  • "remarks": "string",
  • "color": "BLACK",
  • "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
  • "trailerMillage": true
}

Response samples

Content type
application/json
{
  • "axesCount": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "vin": "string",
  • "registration": "string",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "brandName": "string",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "modelName": "string",
  • "registrationDate": "2019-08-24",
  • "firstRegistrationInCountryDate": "2019-08-24",
  • "productionDate": "2019-08-24",
  • "duties": [
    ],
  • "color": "BLACK",
  • "distanceUnit": "KILOMETER",
  • "remarks": "string",
  • "enabled": true,
  • "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
  • "trailer": true,
  • "trailerMillage": true,
  • "status": "ERROR",
  • "createdTimestamp": "2019-08-24T14:15:22Z",
  • "updatedTimestamp": "2019-08-24T14:15:22Z",
  • "createdPersonId": "725aa23d-feb7-48a8-9f3f-3bed04243ae5",
  • "updatedPersonId": "94de6710-6ec2-42e9-b486-8ddb836e206e"
}

createVehicleV11 Deprecated

Request Body schema: application/json
required
enabled
boolean
registration
required
string
vin
string
modelId
required
string <uuid>
productionDate
string <date>
registrationDate
string <date>
firstRegistrationInCountryDate
string <date>
remarks
required
string
color
string (VehicleColor)
Enum: "BLACK" "WHITE" "GRAY" "RED" "BLUE" "GREEN" "DARK_BLUE" "SILVER"
destinationId
required
string <uuid>
trailerMillage
required
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "registration": "string",
  • "vin": "string",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "productionDate": "2019-08-24",
  • "registrationDate": "2019-08-24",
  • "firstRegistrationInCountryDate": "2019-08-24",
  • "remarks": "string",
  • "color": "BLACK",
  • "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
  • "trailerMillage": true
}

Response samples

Content type
application/json
{
  • "axesCount": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "vin": "string",
  • "registration": "string",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "brandName": "string",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "modelName": "string",
  • "registrationDate": "2019-08-24",
  • "firstRegistrationInCountryDate": "2019-08-24",
  • "productionDate": "2019-08-24",
  • "duties": [
    ],
  • "color": "BLACK",
  • "distanceUnit": "KILOMETER",
  • "remarks": "string",
  • "enabled": true,
  • "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
  • "trailer": true,
  • "trailerMillage": true,
  • "status": "ERROR",
  • "createdTimestamp": "2019-08-24T14:15:22Z",
  • "updatedTimestamp": "2019-08-24T14:15:22Z",
  • "createdPersonId": "725aa23d-feb7-48a8-9f3f-3bed04243ae5",
  • "updatedPersonId": "94de6710-6ec2-42e9-b486-8ddb836e206e"
}

vehicle-controller-v-14

getVehicle_1

path Parameters
organisationId
required
string <uuid>
vehicleId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "axesCount": 0,
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "vin": "string",
  • "registration": "string",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "brandName": "string",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "modelName": "string",
  • "registrationDate": "2019-08-24",
  • "firstRegistrationInCountryDate": "2019-08-24",
  • "productionDate": "2019-08-24",
  • "duties": [
    ],
  • "color": "BLACK",
  • "distanceUnit": "KILOMETER",
  • "remarks": "string",
  • "enabled": true,
  • "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
  • "trailer": true,
  • "trailerMillage": true,
  • "status": "ERROR",
  • "createdTimestamp": "2019-08-24T14:15:22Z",
  • "updatedTimestamp": "2019-08-24T14:15:22Z",
  • "createdPersonId": "725aa23d-feb7-48a8-9f3f-3bed04243ae5",
  • "updatedPersonId": "94de6710-6ec2-42e9-b486-8ddb836e206e"
}

updateVehicleV1_2

path Parameters
organisationId
required
string <uuid>
vehicleId
required
string <uuid>
Request Body schema: application/json
required
enabled
boolean
registration
required
string
vin
string
modelId
required
string <uuid>
productionDate
string <date>
registrationDate
string <date>
firstRegistrationInCountryDate
string <date>
remarks
required
string
color
string (VehicleColor)
Enum: "BLACK" "WHITE" "GRAY" "RED" "BLUE" "GREEN" "DARK_BLUE" "SILVER"
destinationId
required
string <uuid>
trailerMillage
required
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "registration": "string",
  • "vin": "string",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "productionDate": "2019-08-24",
  • "registrationDate": "2019-08-24",
  • "firstRegistrationInCountryDate": "2019-08-24",
  • "remarks": "string",
  • "color": "BLACK",
  • "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
  • "trailerMillage": true
}

Response samples

Content type
application/json
{
  • "axesCount": 0,
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "vin": "string",
  • "registration": "string",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "brandName": "string",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "modelName": "string",
  • "registrationDate": "2019-08-24",
  • "firstRegistrationInCountryDate": "2019-08-24",
  • "productionDate": "2019-08-24",
  • "duties": [
    ],
  • "color": "BLACK",
  • "distanceUnit": "KILOMETER",
  • "remarks": "string",
  • "enabled": true,
  • "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
  • "trailer": true,
  • "trailerMillage": true,
  • "status": "ERROR",
  • "createdTimestamp": "2019-08-24T14:15:22Z",
  • "updatedTimestamp": "2019-08-24T14:15:22Z",
  • "createdPersonId": "725aa23d-feb7-48a8-9f3f-3bed04243ae5",
  • "updatedPersonId": "94de6710-6ec2-42e9-b486-8ddb836e206e"
}

getVehicles_1

path Parameters
organisationId
required
string <uuid>
query Parameters
enabled
boolean
Default: true

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createVehicleV12

path Parameters
organisationId
required
string <uuid>
Request Body schema: application/json
required
enabled
boolean
registration
required
string
vin
string
modelId
required
string <uuid>
productionDate
string <date>
registrationDate
string <date>
firstRegistrationInCountryDate
string <date>
remarks
required
string
color
string (VehicleColor)
Enum: "BLACK" "WHITE" "GRAY" "RED" "BLUE" "GREEN" "DARK_BLUE" "SILVER"
destinationId
required
string <uuid>
trailerMillage
required
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "registration": "string",
  • "vin": "string",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "productionDate": "2019-08-24",
  • "registrationDate": "2019-08-24",
  • "firstRegistrationInCountryDate": "2019-08-24",
  • "remarks": "string",
  • "color": "BLACK",
  • "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
  • "trailerMillage": true
}

Response samples

Content type
application/json
{
  • "axesCount": 0,
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "vin": "string",
  • "registration": "string",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "brandName": "string",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "modelName": "string",
  • "registrationDate": "2019-08-24",
  • "firstRegistrationInCountryDate": "2019-08-24",
  • "productionDate": "2019-08-24",
  • "duties": [
    ],
  • "color": "BLACK",
  • "distanceUnit": "KILOMETER",
  • "remarks": "string",
  • "enabled": true,
  • "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
  • "trailer": true,
  • "trailerMillage": true,
  • "status": "ERROR",
  • "createdTimestamp": "2019-08-24T14:15:22Z",
  • "updatedTimestamp": "2019-08-24T14:15:22Z",
  • "createdPersonId": "725aa23d-feb7-48a8-9f3f-3bed04243ae5",
  • "updatedPersonId": "94de6710-6ec2-42e9-b486-8ddb836e206e"
}

vehicle-controller-v-13

getVehicle_2 Deprecated

path Parameters
organisationId
required
string <uuid>
vehicleId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "axesCount": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "vin": "string",
  • "registration": "string",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "brandName": "string",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "modelName": "string",
  • "registrationDate": "2019-08-24",
  • "firstRegistrationInCountryDate": "2019-08-24",
  • "productionDate": "2019-08-24",
  • "duties": [
    ],
  • "color": "BLACK",
  • "distanceUnit": "KILOMETER",
  • "remarks": "string",
  • "enabled": true,
  • "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
  • "trailer": true,
  • "trailerMillage": true,
  • "status": "ERROR",
  • "createdTimestamp": "2019-08-24T14:15:22Z",
  • "updatedTimestamp": "2019-08-24T14:15:22Z",
  • "createdPersonId": "725aa23d-feb7-48a8-9f3f-3bed04243ae5",
  • "updatedPersonId": "94de6710-6ec2-42e9-b486-8ddb836e206e"
}

updateVehicleV1_2_1 Deprecated

path Parameters
organisationId
required
string <uuid>
vehicleId
required
string <uuid>
Request Body schema: application/json
required
enabled
boolean
registration
required
string
vin
string
modelId
required
string <uuid>
productionDate
string <date>
registrationDate
string <date>
firstRegistrationInCountryDate
string <date>
remarks
required
string
color
string (VehicleColor)
Enum: "BLACK" "WHITE" "GRAY" "RED" "BLUE" "GREEN" "DARK_BLUE" "SILVER"
destinationId
required
string <uuid>
trailerMillage
required
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "registration": "string",
  • "vin": "string",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "productionDate": "2019-08-24",
  • "registrationDate": "2019-08-24",
  • "firstRegistrationInCountryDate": "2019-08-24",
  • "remarks": "string",
  • "color": "BLACK",
  • "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
  • "trailerMillage": true
}

Response samples

Content type
application/json
{
  • "axesCount": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "vin": "string",
  • "registration": "string",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "brandName": "string",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "modelName": "string",
  • "registrationDate": "2019-08-24",
  • "firstRegistrationInCountryDate": "2019-08-24",
  • "productionDate": "2019-08-24",
  • "duties": [
    ],
  • "color": "BLACK",
  • "distanceUnit": "KILOMETER",
  • "remarks": "string",
  • "enabled": true,
  • "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
  • "trailer": true,
  • "trailerMillage": true,
  • "status": "ERROR",
  • "createdTimestamp": "2019-08-24T14:15:22Z",
  • "updatedTimestamp": "2019-08-24T14:15:22Z",
  • "createdPersonId": "725aa23d-feb7-48a8-9f3f-3bed04243ae5",
  • "updatedPersonId": "94de6710-6ec2-42e9-b486-8ddb836e206e"
}

getVehicles_2 Deprecated

path Parameters
organisationId
required
string <uuid>
query Parameters
enabled
boolean
Default: true

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createVehicleV12_1 Deprecated

path Parameters
organisationId
required
string <uuid>
Request Body schema: application/json
required
enabled
boolean
registration
required
string
vin
string
modelId
required
string <uuid>
productionDate
string <date>
registrationDate
string <date>
firstRegistrationInCountryDate
string <date>
remarks
required
string
color
string (VehicleColor)
Enum: "BLACK" "WHITE" "GRAY" "RED" "BLUE" "GREEN" "DARK_BLUE" "SILVER"
destinationId
required
string <uuid>
trailerMillage
required
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "registration": "string",
  • "vin": "string",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "productionDate": "2019-08-24",
  • "registrationDate": "2019-08-24",
  • "firstRegistrationInCountryDate": "2019-08-24",
  • "remarks": "string",
  • "color": "BLACK",
  • "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
  • "trailerMillage": true
}

Response samples

Content type
application/json
{
  • "axesCount": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "vin": "string",
  • "registration": "string",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "brandName": "string",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "modelName": "string",
  • "registrationDate": "2019-08-24",
  • "firstRegistrationInCountryDate": "2019-08-24",
  • "productionDate": "2019-08-24",
  • "duties": [
    ],
  • "color": "BLACK",
  • "distanceUnit": "KILOMETER",
  • "remarks": "string",
  • "enabled": true,
  • "destinationId": "d0a0ebc7-d6b4-4f3c-a5af-5761a8148e3a",
  • "trailer": true,
  • "trailerMillage": true,
  • "status": "ERROR",
  • "createdTimestamp": "2019-08-24T14:15:22Z",
  • "updatedTimestamp": "2019-08-24T14:15:22Z",
  • "createdPersonId": "725aa23d-feb7-48a8-9f3f-3bed04243ae5",
  • "updatedPersonId": "94de6710-6ec2-42e9-b486-8ddb836e206e"
}

maintenance-item-controller

updateMaintenanceItem_V1_1

Request Body schema: application/json
required
id
string <uuid>
name
required
string
description
string
type
string (MaintenanceItemType)
Enum: "Boolean" "DictionaryRadio" "DictionarySelect"
Array of objects (MaintenanceItemDictionary)
distanceInterval
integer <int32>
distanceConfigurable
boolean
timeInterval
integer <int32>
timeIntervalConfigurable
boolean
enabled
boolean
organisationId
string <uuid>
category
string (MaintenanceItemCategory)
Enum: "AIR_CONDITION" "BREAK" "CLUTCH" "ELECTRICS" "ENGINE" "ENGINE_OIL" "EXHAUST" "LIGHTING" "STEERING" "SUSPENSION" "TRANSMISSION" "TYRE" "TURBO"

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "type": "Boolean",
  • "dictionary": [
    ],
  • "distanceInterval": 0,
  • "distanceConfigurable": true,
  • "timeInterval": 0,
  • "timeIntervalConfigurable": true,
  • "enabled": true,
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "category": "AIR_CONDITION"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "type": "Boolean",
  • "dictionary": [
    ],
  • "distanceInterval": 0,
  • "distanceConfigurable": true,
  • "timeInterval": 0,
  • "timeIntervalConfigurable": true,
  • "enabled": true,
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "category": "AIR_CONDITION"
}

getMaintenanceItems

Responses

Response samples

Content type
application/json
[
  • {
    }
]

updateMaintenanceItem

Request Body schema: application/json
required
id
string <uuid>
name
required
string
description
string
type
string (MaintenanceItemType)
Enum: "Boolean" "DictionaryRadio" "DictionarySelect"
Array of objects (MaintenanceItemDictionary)
distanceInterval
integer <int32>
distanceConfigurable
boolean
timeInterval
integer <int32>
timeIntervalConfigurable
boolean
enabled
boolean
organisationId
string <uuid>
category
string (MaintenanceItemCategory)
Enum: "AIR_CONDITION" "BREAK" "CLUTCH" "ELECTRICS" "ENGINE" "ENGINE_OIL" "EXHAUST" "LIGHTING" "STEERING" "SUSPENSION" "TRANSMISSION" "TYRE" "TURBO"

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "type": "Boolean",
  • "dictionary": [
    ],
  • "distanceInterval": 0,
  • "distanceConfigurable": true,
  • "timeInterval": 0,
  • "timeIntervalConfigurable": true,
  • "enabled": true,
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "category": "AIR_CONDITION"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "type": "Boolean",
  • "dictionary": [
    ],
  • "distanceInterval": 0,
  • "distanceConfigurable": true,
  • "timeInterval": 0,
  • "timeIntervalConfigurable": true,
  • "enabled": true,
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "category": "AIR_CONDITION"
}

createMaintenanceItem

Request Body schema: application/json
required
id
string <uuid>
name
required
string
description
string
type
string (MaintenanceItemType)
Enum: "Boolean" "DictionaryRadio" "DictionarySelect"
Array of objects (MaintenanceItemDictionary)
distanceInterval
integer <int32>
distanceConfigurable
boolean
timeInterval
integer <int32>
timeIntervalConfigurable
boolean
enabled
boolean
organisationId
string <uuid>
category
string (MaintenanceItemCategory)
Enum: "AIR_CONDITION" "BREAK" "CLUTCH" "ELECTRICS" "ENGINE" "ENGINE_OIL" "EXHAUST" "LIGHTING" "STEERING" "SUSPENSION" "TRANSMISSION" "TYRE" "TURBO"

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "type": "Boolean",
  • "dictionary": [
    ],
  • "distanceInterval": 0,
  • "distanceConfigurable": true,
  • "timeInterval": 0,
  • "timeIntervalConfigurable": true,
  • "enabled": true,
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "category": "AIR_CONDITION"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "type": "Boolean",
  • "dictionary": [
    ],
  • "distanceInterval": 0,
  • "distanceConfigurable": true,
  • "timeInterval": 0,
  • "timeIntervalConfigurable": true,
  • "enabled": true,
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "category": "AIR_CONDITION"
}

getMaintenanceItem

path Parameters
itemId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "type": "Boolean",
  • "dictionary": [
    ],
  • "distanceInterval": 0,
  • "distanceConfigurable": true,
  • "timeInterval": 0,
  • "timeIntervalConfigurable": true,
  • "enabled": true,
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "category": "AIR_CONDITION"
}

model-controller-command-v-03

updateModel

path Parameters
organisationId
required
string <uuid>
modelId
required
string <uuid>
Request Body schema: application/json
required
modelId
string <uuid>
name
required
string
brandId
string <uuid>
axesCount
integer <int32> [ 2 .. 4 ]
typeId
required
string <uuid>
typeName
string
workUnit
required
string (WorkUnit)
Enum: "KILOMETER" "MILE" "HOUR"
required
Array of objects (MaintenanceItemValueDTO)
required
Array of objects (SelectedVehicleParameterDTO)

Responses

Request samples

Content type
application/json
{
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "name": "string",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "axesCount": 2,
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "typeName": "string",
  • "workUnit": "KILOMETER",
  • "maintenanceItemValues": [
    ],
  • "selectedVehicleParameters": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "maintenanceItemValues": [
    ],
  • "selectedVehicleParameters": [
    ],
  • "workUnit": "KILOMETER",
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "axesCount": 0,
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278"
}

createModel

path Parameters
organisationId
required
string <uuid>
Request Body schema: application/json
required
modelId
string <uuid>
name
required
string
brandId
string <uuid>
axesCount
integer <int32> [ 2 .. 4 ]
typeId
required
string <uuid>
typeName
string
workUnit
required
string (WorkUnit)
Enum: "KILOMETER" "MILE" "HOUR"
required
Array of objects (MaintenanceItemValueDTO)
required
Array of objects (SelectedVehicleParameterDTO)

Responses

Request samples

Content type
application/json
{
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "name": "string",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "axesCount": 2,
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "typeName": "string",
  • "workUnit": "KILOMETER",
  • "maintenanceItemValues": [
    ],
  • "selectedVehicleParameters": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "maintenanceItemValues": [
    ],
  • "selectedVehicleParameters": [
    ],
  • "workUnit": "KILOMETER",
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "axesCount": 0,
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278"
}

maintenance-request-controller-v-03

getMaintenanceRequest

path Parameters
maintenanceRequestId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "vehicleRegistration": "string",
  • "vehicleBrand": "string",
  • "vehicleModel": "string",
  • "inspRequest": "string",
  • "expirationDate": "2019-08-24",
  • "atKilometers": 0,
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "createDate": "2019-08-24T14:15:22Z",
  • "editUserId": "b8cb20cd-fd09-4975-ad6b-1f7347c2e8ed",
  • "editDate": "2019-08-24T14:15:22Z",
  • "doneDate": "2019-08-24T14:15:22Z",
  • "doneUserId": "72ce7f1e-7f2a-4fa5-9f68-3495d76fbecd",
  • "done": true,
  • "status": "UNSET",
  • "cyclical": true,
  • "everyDays": 0
}

updateMaintenanceRequest

path Parameters
maintenanceRequestId
required
string <uuid>
Request Body schema: multipart/form-data
required
object (MaintenanceRequestDTOV02)
file
string <binary>

Responses

doneMaintenanceRequest

path Parameters
maintenanceRequestId
required
string <uuid>
Request Body schema: application/json
required
id
string <uuid>
done
required
boolean
doneDate
string <date-time>
doneUserId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "done": true,
  • "doneDate": "2019-08-24T14:15:22Z",
  • "doneUserId": "72ce7f1e-7f2a-4fa5-9f68-3495d76fbecd"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "done": true,
  • "doneDate": "2019-08-24T14:15:22Z",
  • "doneUserId": "72ce7f1e-7f2a-4fa5-9f68-3495d76fbecd"
}

getAllMaintenanceRequestForVehicle

path Parameters
vehicleId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createMaintenanceRequest

path Parameters
vehicleId
required
string <uuid>
Request Body schema: multipart/form-data
required
object (MaintenanceRequestDTOV02)
file
string <binary>

Responses

getAllMaintenanceRequest

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getImageForMaintenance

path Parameters
maintenanceRequestId
required
string <uuid>

Responses

destination-controller-v-03

getDestination

path Parameters
destinationId
required
string <uuid>
header Parameters
organisation-id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "dutyItemIds": [
    ]
}

updateDestination

path Parameters
destinationId
required
string <uuid>
header Parameters
organisation-id
required
string
Request Body schema: application/json
required
id
string <uuid>
name
required
string
dutyItemIds
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "dutyItemIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "dutyItemIds": [
    ]
}

getDestinationAll

header Parameters
organisation-id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createDestination

header Parameters
organisation-id
required
string
Request Body schema: application/json
required
id
string <uuid>
name
required
string
dutyItemIds
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "dutyItemIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "dutyItemIds": [
    ]
}

duty-item-controller-v-02

getDutyItem

path Parameters
organisationId
required
string <uuid>
dutyItemId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": { },
  • "description": "string"
}

updateDutyItem

path Parameters
organisationId
required
string <uuid>
dutyItemId
required
string <uuid>
Request Body schema: application/json
required
name
required
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": { },
  • "description": "string"
}

getDutyItems

path Parameters
organisationId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

addDutyItem

path Parameters
organisationId
required
string <uuid>
Request Body schema: application/json
required
name
required
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": { },
  • "description": "string"
}

duty-controller-v-02

getDuty

path Parameters
organisationId
required
string <uuid>
dutyId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "itemId": "f11b669d-7201-4c21-88af-d85092f0c005",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "name": "string",
  • "type": "DATE",
  • "status": "UNSET",
  • "expirationDate": "2019-08-24",
  • "updateTimestamp": "2019-08-24T14:15:22Z",
  • "updateUser": "361e814f-eb1f-4bf2-8c47-35f1bcb2124e"
}

updateDuty

path Parameters
organisationId
required
string <uuid>
dutyId
required
string <uuid>
Request Body schema: application/json
required
expirationDate
string <date>

Responses

Request samples

Content type
application/json
{
  • "expirationDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "itemId": "f11b669d-7201-4c21-88af-d85092f0c005",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "name": "string",
  • "type": "DATE",
  • "status": "UNSET",
  • "expirationDate": "2019-08-24",
  • "updateTimestamp": "2019-08-24T14:15:22Z",
  • "updateUser": "361e814f-eb1f-4bf2-8c47-35f1bcb2124e"
}

getDutiesForVehicle

path Parameters
organisationId
required
string <uuid>
vehicleId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

distance-controller-v-02

updateDistance

path Parameters
organisationId
required
string <uuid>
Request Body schema: application/json
required
id
object (DistanceId)
vehicleId
string <uuid>
operationDate
string <date>
userId
string <uuid>
createDateTime
string <date-time>
updateUserId
string <uuid>
updateDateTime
string <date-time>
distance
integer <int64>
distanceUnit
string (WorkUnit)
Enum: "KILOMETER" "MILE" "HOUR"
distanceType
string (DistanceType)
Enum: "DISTANCE" "MAINTENANCE" "DUTY" "COUPLING" "HANDOVER" "REFUELING"
externalId
string <uuid>
remarks
string [ 0 .. 1024 ] characters

Responses

Request samples

Content type
application/json
{
  • "id": { },
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "operationDate": "2019-08-24",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "distance": 0,
  • "distanceUnit": "KILOMETER",
  • "distanceType": "DISTANCE",
  • "externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
  • "remarks": "string"
}

Response samples

Content type
application/json
{ }

createDistance

path Parameters
organisationId
required
string <uuid>
Request Body schema: application/json
required
id
object (DistanceId)
vehicleId
string <uuid>
operationDate
string <date>
userId
string <uuid>
createDateTime
string <date-time>
updateUserId
string <uuid>
updateDateTime
string <date-time>
distance
integer <int64>
distanceUnit
string (WorkUnit)
Enum: "KILOMETER" "MILE" "HOUR"
distanceType
string (DistanceType)
Enum: "DISTANCE" "MAINTENANCE" "DUTY" "COUPLING" "HANDOVER" "REFUELING"
externalId
string <uuid>
remarks
string [ 0 .. 1024 ] characters

Responses

Request samples

Content type
application/json
{
  • "id": { },
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "operationDate": "2019-08-24",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "distance": 0,
  • "distanceUnit": "KILOMETER",
  • "distanceType": "DISTANCE",
  • "externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
  • "remarks": "string"
}

Response samples

Content type
application/json
{ }

getDistance

path Parameters
organisationId
required
string <uuid>
distanceId
required
object (DistanceId)

Responses

Response samples

Content type
application/json
{
  • "id": { },
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "operationDate": "2019-08-24",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "distance": 0,
  • "distanceUnit": "KILOMETER",
  • "distanceType": "DISTANCE",
  • "externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
  • "remarks": "string"
}

deleteDistance

path Parameters
organisationId
required
string <uuid>
distanceId
required
object (DistanceId)

Responses

Response samples

Content type
application/json
{
  • "violations": [
    ],
  • "message": "string"
}

getDistanceForVehicle

path Parameters
organisationId
required
string <uuid>
vehicleId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

model-controller-v-02

updateModel_1 Deprecated

path Parameters
organisationId
required
string <uuid>
brandId
required
string <uuid>
modelId
required
string <uuid>
Request Body schema: application/json
required
modelId
required
string <uuid>
name
required
string
brandId
string <uuid>
axesCount
integer <int32> [ 2 .. 4 ]
typeId
string <uuid>
typeName
string
required
Array of objects (MaintenanceItemValueDTO)
required
Array of objects (SelectedVehicleParameterDTO)

Responses

Request samples

Content type
application/json
{
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "name": "string",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "axesCount": 2,
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "typeName": "string",
  • "maintenanceItemValues": [
    ],
  • "selectedVehicleParameters": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "typeName": "string",
  • "maintenanceItemValues": [
    ],
  • "selectedVehicleParameters": [
    ],
  • "workUnit": "KILOMETER",
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "axesCount": 0,
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278"
}

getModelsForBrand_1 Deprecated

path Parameters
organisationId
required
string <uuid>
brandId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createModel_1 Deprecated

path Parameters
organisationId
required
string <uuid>
brandId
required
string <uuid>
Request Body schema: application/json
required
modelId
required
string <uuid>
name
required
string
brandId
string <uuid>
axesCount
integer <int32> [ 2 .. 4 ]
typeId
string <uuid>
typeName
string
required
Array of objects (MaintenanceItemValueDTO)
required
Array of objects (SelectedVehicleParameterDTO)

Responses

Request samples

Content type
application/json
{
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "name": "string",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "axesCount": 2,
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "typeName": "string",
  • "maintenanceItemValues": [
    ],
  • "selectedVehicleParameters": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "typeName": "string",
  • "maintenanceItemValues": [
    ],
  • "selectedVehicleParameters": [
    ],
  • "organisationId": {
    },
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "axesCount": 0,
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278"
}

getModel_1 Deprecated

path Parameters
organisationId
required
string <uuid>
modelId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "typeName": "string",
  • "maintenanceItemValues": [
    ],
  • "selectedVehicleParameters": [
    ],
  • "workUnit": "KILOMETER",
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "axesCount": 0,
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278"
}

member-controller-v-02

getOrganisationMembers_1

header Parameters
organisation-id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

updateMember

header Parameters
organisation-id
required
string <uuid>
Request Body schema: application/json
required
userId
required
string <uuid>
firstName
string
lastName
string
enabled
boolean
isManager
boolean

Responses

Request samples

Content type
application/json
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "firstName": "string",
  • "lastName": "string",
  • "enabled": true,
  • "isManager": true
}

Response samples

Content type
application/json
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "firstName": "string",
  • "lastName": "string",
  • "enabled": true,
  • "isManager": true
}

getOrganisationMembers

path Parameters
userId
required
string <uuid>
header Parameters
organisation-id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "firstName": "string",
  • "lastName": "string",
  • "enabled": true,
  • "isManager": true
}

getMyPrivilegeInOrganisation

header Parameters
organisation-id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "firstName": "string",
  • "lastName": "string",
  • "enabled": true,
  • "isManager": true
}

maintenance-controller-v-02

getMaintenanceById

path Parameters
maintenanceId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "operationDate": "2019-08-24",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "maintenanceItems": [
    ],
  • "distance": 0,
  • "distanceUnit": "KILOMETER",
  • "remarks": "string",
  • "image": "string"
}

updateMaintenanceForVehicle

path Parameters
maintenanceId
required
string <uuid>
Request Body schema: multipart/form-data
required
object (MaintenanceDTO)
file
string <binary>

Responses

Response samples

Content type
application/json
{
  • "violations": [
    ],
  • "message": "string"
}

deleteMaintenance

path Parameters
maintenanceId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "violations": [
    ],
  • "message": "string"
}

updateMaintenanceForVehicleNoImage

path Parameters
maintenanceId
required
string <uuid>
Request Body schema: application/json
required
id
string <uuid>
vehicleId
string <uuid>
operationDate
string <date>
createDateTime
string <date-time>
updateDateTime
string <date-time>
userId
string <uuid>
updateUserId
string <uuid>
Array of objects (MaintenanceItemValueDTO)
distance
integer <int64>
distanceUnit
string (WorkUnit)
Enum: "KILOMETER" "MILE" "HOUR"
remarks
required
string
image
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "operationDate": "2019-08-24",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "maintenanceItems": [
    ],
  • "distance": 0,
  • "distanceUnit": "KILOMETER",
  • "remarks": "string",
  • "image": "string"
}

Response samples

Content type
application/json
{ }

createMaintenanceForVehicleNoImage

path Parameters
vehicleId
required
string <uuid>
Request Body schema: application/json
required
id
string <uuid>
vehicleId
string <uuid>
operationDate
string <date>
createDateTime
string <date-time>
updateDateTime
string <date-time>
userId
string <uuid>
updateUserId
string <uuid>
Array of objects (MaintenanceItemValueDTO)
distance
integer <int64>
distanceUnit
string (WorkUnit)
Enum: "KILOMETER" "MILE" "HOUR"
remarks
required
string
image
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "operationDate": "2019-08-24",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "maintenanceItems": [
    ],
  • "distance": 0,
  • "distanceUnit": "KILOMETER",
  • "remarks": "string",
  • "image": "string"
}

Response samples

Content type
application/json
{
  • "violations": [
    ],
  • "message": "string"
}

findAllMaintenanceForVehicle

path Parameters
vehicleId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createMaintenanceForVehicle

path Parameters
vehicleId
required
string <uuid>
Request Body schema: multipart/form-data
required
object (MaintenanceDTO)
file
string <binary>

Responses

Response samples

Content type
application/json
{
  • "violations": [
    ],
  • "message": "string"
}

getImageForMaintenance_1

path Parameters
maintenanceId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "violations": [
    ],
  • "message": "string"
}

maintenance-request-controller-v-02

getMaintenanceRequest_1

path Parameters
maintenanceRequestId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "vehicleRegistration": "string",
  • "vehicleBrand": "string",
  • "vehicleModel": "string",
  • "inspRequest": "string",
  • "expirationDate": "2019-08-24",
  • "atKilometers": 0,
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "createDate": "2019-08-24T14:15:22Z",
  • "editUserId": "b8cb20cd-fd09-4975-ad6b-1f7347c2e8ed",
  • "editDate": "2019-08-24T14:15:22Z",
  • "doneDate": "2019-08-24T14:15:22Z",
  • "doneUserId": "72ce7f1e-7f2a-4fa5-9f68-3495d76fbecd",
  • "done": true,
  • "status": "UNSET",
  • "cyclical": true,
  • "everyDays": 0
}

updateMaintenanceRequest_1

path Parameters
maintenanceRequestId
required
string <uuid>
Request Body schema: multipart/form-data
required
object (MaintenanceRequestDTOV02)
file
string <binary>

Responses

doneMaintenanceRequest_1

path Parameters
maintenanceRequestId
required
string <uuid>
Request Body schema: application/json
required
id
string <uuid>
done
required
boolean
doneDate
string <date-time>
doneUserId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "done": true,
  • "doneDate": "2019-08-24T14:15:22Z",
  • "doneUserId": "72ce7f1e-7f2a-4fa5-9f68-3495d76fbecd"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "done": true,
  • "doneDate": "2019-08-24T14:15:22Z",
  • "doneUserId": "72ce7f1e-7f2a-4fa5-9f68-3495d76fbecd"
}

getAllMaintenanceRequestForVehicle_1

path Parameters
vehicleId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createMaintenanceRequest_1

path Parameters
vehicleId
required
string <uuid>
Request Body schema: multipart/form-data
required
object (MaintenanceRequestDTOV02)
file
string <binary>

Responses

getAllMaintenanceRequest_1

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getImageForMaintenance_2

path Parameters
maintenanceRequestId
required
string <uuid>

Responses

destination-controller

getDestinationV02 Deprecated

path Parameters
destinationId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "dutyItemIds": [
    ]
}

updateDestinationV02 Deprecated

path Parameters
destinationId
required
string <uuid>
Request Body schema: application/json
required
id
string <uuid>
name
required
string
dutyItemIds
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "dutyItemIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "dutyItemIds": [
    ]
}

getDestination_1 Deprecated

path Parameters
destinationId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "tachograph": true,
  • "fireExtinguisher": true,
  • "transportTechnicalSupervision": true,
  • "adrCertificate": true
}

updateDestination_1 Deprecated

path Parameters
destinationId
required
string <uuid>
Request Body schema: application/json
required
id
string <uuid>
name
required
string
tachograph
boolean
fireExtinguisher
boolean
transportTechnicalSupervision
boolean
adrCertificate
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "tachograph": true,
  • "fireExtinguisher": true,
  • "transportTechnicalSupervision": true,
  • "adrCertificate": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "tachograph": true,
  • "fireExtinguisher": true,
  • "transportTechnicalSupervision": true,
  • "adrCertificate": true
}

getDutiesForOrganisationV02 Deprecated

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createDestinationV02 Deprecated

Request Body schema: application/json
required
id
string <uuid>
name
required
string
dutyItemIds
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "dutyItemIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "dutyItemIds": [
    ]
}

getDutiesForOrganisation Deprecated

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createDestination_1 Deprecated

Request Body schema: application/json
required
id
string <uuid>
name
required
string
tachograph
boolean
fireExtinguisher
boolean
transportTechnicalSupervision
boolean
adrCertificate
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "tachograph": true,
  • "fireExtinguisher": true,
  • "transportTechnicalSupervision": true,
  • "adrCertificate": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "tachograph": true,
  • "fireExtinguisher": true,
  • "transportTechnicalSupervision": true,
  • "adrCertificate": true
}

vehicle-parameter-value-update-for-vehicle-controller

updateParameterValueForVehicle

path Parameters
organisationId
required
string <uuid>
vehicleId
required
string <uuid>
Request Body schema: application/json
required
vehicleParameterId
string <uuid>
value
string
vehicleId
string <uuid>
name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "vehicleParameterId": "74f97355-5ca7-4ed1-97df-b01206485647",
  • "value": "string",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "vehicleParameterId": "74f97355-5ca7-4ed1-97df-b01206485647",
  • "value": "string",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "name": "string",
  • "description": "string"
}

vehicle-parameter-get-for-organisation-controller

getParameter_1

path Parameters
organisationId
required
string <uuid>
parameterId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enabled": true,
  • "organisationId": "string",
  • "name": "string",
  • "description": "string"
}

vehicle-parameter-update-for-organisation-controller

updateParameter

path Parameters
organisationId
required
string <uuid>
parameterId
required
string <uuid>
Request Body schema: application/json
required
id
string <uuid>
enabled
boolean
organisationId
string
name
required
string [ 1 .. 64 ] characters
description
string [ 0 .. 256 ] characters

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enabled": true,
  • "organisationId": "string",
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enabled": true,
  • "organisationId": "string",
  • "name": "string",
  • "description": "string"
}

type-controller-v-01

getTypeById

path Parameters
typeId
required
string <uuid>
header Parameters
organisation-id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "trailer": true
}

updateType

path Parameters
typeId
required
string <uuid>
header Parameters
organisation-id
required
string
Request Body schema: application/json
required
id
string <uuid>
name
required
string
organisationId
string <uuid>
trailer
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "trailer": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "trailer": true
}

getTypes

header Parameters
organisation-id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createType

header Parameters
organisation-id
required
string
Request Body schema: application/json
required
id
string <uuid>
name
required
string
organisationId
string <uuid>
trailer
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "trailer": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "trailer": true
}

organisation-controller

getOrganisation

path Parameters
organisationId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "PRIVATE",
  • "featureToggles": [
    ]
}

updateOrganisationForUser

path Parameters
organisationId
required
string <uuid>
Request Body schema: application/json
required
id
string
name
string
type
string (OrganisationType)
Enum: "PRIVATE" "CORPORATE"
featureToggles
Array of strings

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "PRIVATE",
  • "featureToggles": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "PRIVATE",
  • "featureToggles": [
    ]
}

Delete particular organisation without user

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.

path Parameters
organisationId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "PRIVATE",
  • "featureToggles": [
    ]
}

getCurrentOrganisationForUser

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "PRIVATE",
  • "featureToggles": [
    ]
}

setCurrentOrganisationForUser

Request Body schema: application/json
required
id
string
name
string
type
string (OrganisationType)
Enum: "PRIVATE" "CORPORATE"
featureToggles
Array of strings

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "PRIVATE",
  • "featureToggles": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "PRIVATE",
  • "featureToggles": [
    ]
}

createOrganisationForUserV02

Request Body schema: application/json
required
id
string
name
string
type
string (OrganisationType)
Enum: "PRIVATE" "CORPORATE"
featureToggles
Array of strings

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "PRIVATE",
  • "featureToggles": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "PRIVATE",
  • "featureToggles": [
    ]
}

getUserOrganisations

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createOrganisationForUser Deprecated

Request Body schema: application/json
required
id
string
name
string
type
string (OrganisationType)
Enum: "PRIVATE" "CORPORATE"
featureToggles
Array of strings

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "PRIVATE",
  • "featureToggles": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "PRIVATE",
  • "featureToggles": [
    ]
}

member-controller

getOrganisationMembers_3

Responses

Response samples

Content type
application/json
[
  • {
    }
]

updateMember_1

Request Body schema: application/json
required
userId
required
string <uuid>
firstName
string
lastName
string
enabled
boolean
isManager
boolean

Responses

Request samples

Content type
application/json
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "firstName": "string",
  • "lastName": "string",
  • "enabled": true,
  • "isManager": true
}

Response samples

Content type
application/json
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "firstName": "string",
  • "lastName": "string",
  • "enabled": true,
  • "isManager": true
}

getOrganisationMembers_2

path Parameters
userId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "firstName": "string",
  • "lastName": "string",
  • "enabled": true,
  • "isManager": true
}

getMyPrivilegeInOrganisation_1

Responses

Response samples

Content type
application/json
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "firstName": "string",
  • "lastName": "string",
  • "enabled": true,
  • "isManager": true
}

brand-controller-v-01

getBrand

path Parameters
brandId
required
string <uuid>
header Parameters
organisation-id
required
string

Responses

Response samples

Content type
application/json
{
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "name": "string",
  • "models": [
    ]
}

updateBrand

path Parameters
brandId
required
string <uuid>
header Parameters
organisation-id
required
string
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "name": "string",
  • "models": [
    ]
}

getBrands

header Parameters
organisation-id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createBrand

header Parameters
organisation-id
required
string
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "name": "string",
  • "models": [
    ]
}

type-controller

getTypeById_1 Deprecated

path Parameters
typeId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "trailer": true
}

updateType_1 Deprecated

path Parameters
typeId
required
string <uuid>
Request Body schema: application/json
required
id
string <uuid>
name
required
string
organisationId
string <uuid>
trailer
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "trailer": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "trailer": true
}

getTypes_1 Deprecated

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createType_1 Deprecated

Request Body schema: application/json
required
id
string <uuid>
name
required
string
organisationId
string <uuid>
trailer
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "trailer": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "trailer": true
}

tire-controller

getAll_3

header Parameters
required
object (OrganisationId)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

update_3

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
tireId
string <uuid>
organisationId
string
createDateTime
string <date-time>
updateDateTime
string <date-time>
createUserId
string <uuid>
updateUserId
string <uuid>
tireLineId
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.

productionDate
string <date>

Tire production date

serialNumber
string

Tire serial number

tagRfid
string

Tire RFID

Array of objects (TireOperationDTO)
comment
string

User comment on tire

Responses

Request samples

Content type
application/json
{
  • "tireId": "3619f2ce-ce8f-4b86-abd3-1408e917f6b0",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "tireLineId": "8cf7f971-db36-49f3-85ea-90b9e60160e1",
  • "dotCode": "DOT T7D3 1BH 3218",
  • "productionDate": "2024-01-20",
  • "serialNumber": "2024-01-20",
  • "tagRfid": "123456789",
  • "tireOperations": [
    ],
  • "comment": "Second hand tire"
}

Response samples

Content type
application/json
{
  • "tireId": "3619f2ce-ce8f-4b86-abd3-1408e917f6b0",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "tireLineId": "8cf7f971-db36-49f3-85ea-90b9e60160e1",
  • "dotCode": "DOT T7D3 1BH 3218",
  • "productionDate": "2024-01-20",
  • "serialNumber": "2024-01-20",
  • "tagRfid": "123456789",
  • "tireOperations": [
    ],
  • "comment": "Second hand tire"
}

create_3

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
tireId
string <uuid>
organisationId
string
createDateTime
string <date-time>
updateDateTime
string <date-time>
createUserId
string <uuid>
updateUserId
string <uuid>
tireLineId
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.

productionDate
string <date>

Tire production date

serialNumber
string

Tire serial number

tagRfid
string

Tire RFID

Array of objects (TireOperationDTO)
comment
string

User comment on tire

Responses

Request samples

Content type
application/json
{
  • "tireId": "3619f2ce-ce8f-4b86-abd3-1408e917f6b0",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "tireLineId": "8cf7f971-db36-49f3-85ea-90b9e60160e1",
  • "dotCode": "DOT T7D3 1BH 3218",
  • "productionDate": "2024-01-20",
  • "serialNumber": "2024-01-20",
  • "tagRfid": "123456789",
  • "tireOperations": [
    ],
  • "comment": "Second hand tire"
}

Response samples

Content type
application/json
{
  • "tireId": "3619f2ce-ce8f-4b86-abd3-1408e917f6b0",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "tireLineId": "8cf7f971-db36-49f3-85ea-90b9e60160e1",
  • "dotCode": "DOT T7D3 1BH 3218",
  • "productionDate": "2024-01-20",
  • "serialNumber": "2024-01-20",
  • "tagRfid": "123456789",
  • "tireOperations": [
    ],
  • "comment": "Second hand tire"
}

updateOperation

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
tireId
string <uuid>
operationId
string <uuid>
tireLifeCycleStage
string (TireLifeCycleStage)
Enum: "NEW" "INSTALLED" "POSITION_CHANGED" "INSPECTED" "REPAIRED" "RETREADED" "UNINSTALLED" "DECOMMISSIONED"
wheelRimRotation
boolean

Tire is rotated on the rim

balanced
boolean

Tire was balanced

maintenanceId
string <uuid>

Vehicle maintenance when tire operation took place

axleNumber
integer <int32>

Axles numered from the front

axlePosition
string (TirePosition)
Enum: "LEFT_OR_LEFT_OUTER" "LEFT_INNER" "RIGHT_INNER" "RIGHT_OR_RIGHT_OUTER"
visibleDamage
boolean

Visual inspection for damage

treadDepthLeft
integer <int32>

tread depth left in [mm]

treadDepthMiddle
integer <int32>

tread depth middle in [mm]

treadDepthRight
integer <int32>

tread depth right in [mm]

comment
string

Tire operation comment

Responses

Request samples

Content type
application/json
{
  • "tireId": "3619f2ce-ce8f-4b86-abd3-1408e917f6b0",
  • "operationId": "3051932a-fdd2-48fa-b330-7e7d41535969",
  • "tireLifeCycleStage": "NEW",
  • "wheelRimRotation": true,
  • "balanced": true,
  • "maintenanceId": "1b89df27-65e7-4fe9-829e-eb29e30ff29a",
  • "axleNumber": 2,
  • "axlePosition": "LEFT_OR_LEFT_OUTER",
  • "visibleDamage": false,
  • "treadDepthLeft": 10,
  • "treadDepthMiddle": 11,
  • "treadDepthRight": 12,
  • "comment": "Installed properly"
}

Response samples

Content type
application/json
{
  • "tireId": "3619f2ce-ce8f-4b86-abd3-1408e917f6b0",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "tireLineId": "8cf7f971-db36-49f3-85ea-90b9e60160e1",
  • "dotCode": "DOT T7D3 1BH 3218",
  • "productionDate": "2024-01-20",
  • "serialNumber": "2024-01-20",
  • "tagRfid": "123456789",
  • "tireOperations": [
    ],
  • "comment": "Second hand tire"
}

addOperation

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
tireId
string <uuid>
tireLifeCycleStage
string (TireLifeCycleStage)
Enum: "NEW" "INSTALLED" "POSITION_CHANGED" "INSPECTED" "REPAIRED" "RETREADED" "UNINSTALLED" "DECOMMISSIONED"
wheelRimRotation
boolean

Tire is rotated on the rim

balanced
boolean

Tire was balanced

maintenanceId
string <uuid>

Vehicle maintenance when tire operation took place

axleNumber
integer <int32>

Axles numered from the front

axlePosition
string (TirePosition)
Enum: "LEFT_OR_LEFT_OUTER" "LEFT_INNER" "RIGHT_INNER" "RIGHT_OR_RIGHT_OUTER"
visibleDamage
boolean

Visual inspection for damage

treadDepthLeft
integer <int32>

tread depth left in [mm]

treadDepthMiddle
integer <int32>

tread depth middle in [mm]

treadDepthRight
integer <int32>

tread depth right in [mm]

comment
string

Tire operation comment

Responses

Request samples

Content type
application/json
{
  • "tireId": "3619f2ce-ce8f-4b86-abd3-1408e917f6b0",
  • "tireLifeCycleStage": "NEW",
  • "wheelRimRotation": true,
  • "balanced": true,
  • "maintenanceId": "1b89df27-65e7-4fe9-829e-eb29e30ff29a",
  • "axleNumber": 1,
  • "axlePosition": "LEFT_OR_LEFT_OUTER",
  • "visibleDamage": true,
  • "treadDepthLeft": 10,
  • "treadDepthMiddle": 11,
  • "treadDepthRight": 12,
  • "comment": "New tire"
}

Response samples

Content type
application/json
{
  • "tireId": "3619f2ce-ce8f-4b86-abd3-1408e917f6b0",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "tireLineId": "8cf7f971-db36-49f3-85ea-90b9e60160e1",
  • "dotCode": "DOT T7D3 1BH 3218",
  • "productionDate": "2024-01-20",
  • "serialNumber": "2024-01-20",
  • "tagRfid": "123456789",
  • "tireOperations": [
    ],
  • "comment": "Second hand tire"
}

get_3

path Parameters
tireId
required
string <uuid>
header Parameters
required
object (OrganisationId)

Responses

Response samples

Content type
application/json
{
  • "tireId": "3619f2ce-ce8f-4b86-abd3-1408e917f6b0",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "tireLineId": "8cf7f971-db36-49f3-85ea-90b9e60160e1",
  • "dotCode": "DOT T7D3 1BH 3218",
  • "productionDate": "2024-01-20",
  • "serialNumber": "2024-01-20",
  • "tagRfid": "123456789",
  • "tireOperations": [
    ],
  • "comment": "Second hand tire"
}

manufacture-controller

getAll_4

header Parameters
required
object (OrganisationId)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

update_4

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
manufactureId
string <uuid>
organisationId
string
createDateTime
string <date-time>
updateDateTime
string <date-time>
createUserId
string <uuid>
updateUserId
string <uuid>
name
string

The name of the tire manufacture

comment
string

Additional information about tire manufacture

Responses

Request samples

Content type
application/json
{
  • "manufactureId": "419e8723-64f8-4e03-a61e-e3e0b6dc353a",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "name": "Bridgestone",
  • "comment": "Good manufacture"
}

Response samples

Content type
application/json
{
  • "manufactureId": "419e8723-64f8-4e03-a61e-e3e0b6dc353a",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "name": "Bridgestone",
  • "comment": "Good manufacture"
}

create_4

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
manufactureId
string <uuid>
organisationId
string
createDateTime
string <date-time>
updateDateTime
string <date-time>
createUserId
string <uuid>
updateUserId
string <uuid>
name
string

The name of the tire manufacture

comment
string

Additional information about tire manufacture

Responses

Request samples

Content type
application/json
{
  • "manufactureId": "419e8723-64f8-4e03-a61e-e3e0b6dc353a",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "name": "Bridgestone",
  • "comment": "Good manufacture"
}

Response samples

Content type
application/json
{
  • "manufactureId": "419e8723-64f8-4e03-a61e-e3e0b6dc353a",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "name": "Bridgestone",
  • "comment": "Good manufacture"
}

get_4

path Parameters
manufactureId
required
string <uuid>
header Parameters
required
object (OrganisationId)

Responses

Response samples

Content type
application/json
{
  • "manufactureId": "419e8723-64f8-4e03-a61e-e3e0b6dc353a",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "name": "Bridgestone",
  • "comment": "Good manufacture"
}

line-controller

getAll_5

header Parameters
required
object (OrganisationId)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

update_5

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
lineId
string <uuid>
organisationId
string
createDateTime
string <date-time>
updateDateTime
string <date-time>
createUserId
string <uuid>
updateUserId
string <uuid>
tireManufactureId
string <uuid>
name
string

The name of the tire line or model

treadPattern
string (TreadPattern)
Enum: "DRIVE" "STEER" "TRAILER" "GENERAL"

One of tire tread patterns

tireUsage
string (TireUsage)
Enum: "ALL_SEASON" "SUMMER" "WINTER" "MUD_TERRAIN" "HIGHWAY" "SLICK"

Types of tread based on usage

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
string

Additional information about tire line

Responses

Request samples

Content type
application/json
{
  • "lineId": "e698cdee-c4ef-4d12-b0ea-7c98b2fc64a8",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "tireManufactureId": "48de747f-a9a9-456e-9907-64e5e87d58f2",
  • "name": "Turanza",
  • "treadPattern": "DRIVE",
  • "tireUsage": "ALL_SEASON",
  • "warrantyMileageLimit": 0,
  • "warrantyYearsLimit": 5,
  • "comment": "Good for TGR"
}

Response samples

Content type
application/json
{
  • "lineId": "e698cdee-c4ef-4d12-b0ea-7c98b2fc64a8",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "tireManufactureId": "48de747f-a9a9-456e-9907-64e5e87d58f2",
  • "name": "Turanza",
  • "treadPattern": "DRIVE",
  • "tireUsage": "ALL_SEASON",
  • "warrantyMileageLimit": 0,
  • "warrantyYearsLimit": 5,
  • "comment": "Good for TGR"
}

create_5

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
lineId
string <uuid>
organisationId
string
createDateTime
string <date-time>
updateDateTime
string <date-time>
createUserId
string <uuid>
updateUserId
string <uuid>
tireManufactureId
string <uuid>
name
string

The name of the tire line or model

treadPattern
string (TreadPattern)
Enum: "DRIVE" "STEER" "TRAILER" "GENERAL"

One of tire tread patterns

tireUsage
string (TireUsage)
Enum: "ALL_SEASON" "SUMMER" "WINTER" "MUD_TERRAIN" "HIGHWAY" "SLICK"

Types of tread based on usage

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
string

Additional information about tire line

Responses

Request samples

Content type
application/json
{
  • "lineId": "e698cdee-c4ef-4d12-b0ea-7c98b2fc64a8",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "tireManufactureId": "48de747f-a9a9-456e-9907-64e5e87d58f2",
  • "name": "Turanza",
  • "treadPattern": "DRIVE",
  • "tireUsage": "ALL_SEASON",
  • "warrantyMileageLimit": 0,
  • "warrantyYearsLimit": 5,
  • "comment": "Good for TGR"
}

Response samples

Content type
application/json
{
  • "lineId": "e698cdee-c4ef-4d12-b0ea-7c98b2fc64a8",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "tireManufactureId": "48de747f-a9a9-456e-9907-64e5e87d58f2",
  • "name": "Turanza",
  • "treadPattern": "DRIVE",
  • "tireUsage": "ALL_SEASON",
  • "warrantyMileageLimit": 0,
  • "warrantyYearsLimit": 5,
  • "comment": "Good for TGR"
}

get_5

path Parameters
lineId
required
string <uuid>
header Parameters
required
object (OrganisationId)

Responses

Response samples

Content type
application/json
{
  • "lineId": "e698cdee-c4ef-4d12-b0ea-7c98b2fc64a8",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "tireManufactureId": "48de747f-a9a9-456e-9907-64e5e87d58f2",
  • "name": "Turanza",
  • "treadPattern": "DRIVE",
  • "tireUsage": "ALL_SEASON",
  • "warrantyMileageLimit": 0,
  • "warrantyYearsLimit": 5,
  • "comment": "Good for TGR"
}

maintenance-controller

getMaintenanceById_1

path Parameters
maintenanceId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "operationDate": "2019-08-24",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "maintenanceItems": [
    ],
  • "distance": 0,
  • "distanceUnit": "KILOMETER",
  • "remarks": "string",
  • "image": "string"
}

updateMaintenanceForVehicle_1

path Parameters
maintenanceId
required
string <uuid>
Request Body schema: multipart/form-data
required
object (MaintenanceDTO)
file
string <binary>

Responses

Response samples

Content type
application/json
{
  • "violations": [
    ],
  • "message": "string"
}

deleteMaintenance_1

path Parameters
maintenanceId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "violations": [
    ],
  • "message": "string"
}

updateMaintenanceForVehicleNoImage_1

path Parameters
maintenanceId
required
string <uuid>
Request Body schema: application/json
required
id
string <uuid>
vehicleId
string <uuid>
operationDate
string <date>
createDateTime
string <date-time>
updateDateTime
string <date-time>
userId
string <uuid>
updateUserId
string <uuid>
Array of objects (MaintenanceItemValueDTO)
distance
integer <int64>
distanceUnit
string (WorkUnit)
Enum: "KILOMETER" "MILE" "HOUR"
remarks
required
string
image
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "operationDate": "2019-08-24",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "maintenanceItems": [
    ],
  • "distance": 0,
  • "distanceUnit": "KILOMETER",
  • "remarks": "string",
  • "image": "string"
}

Response samples

Content type
application/json
{ }

createMaintenanceForVehicleNoImage_1

path Parameters
vehicleId
required
string <uuid>
Request Body schema: application/json
required
id
string <uuid>
vehicleId
string <uuid>
operationDate
string <date>
createDateTime
string <date-time>
updateDateTime
string <date-time>
userId
string <uuid>
updateUserId
string <uuid>
Array of objects (MaintenanceItemValueDTO)
distance
integer <int64>
distanceUnit
string (WorkUnit)
Enum: "KILOMETER" "MILE" "HOUR"
remarks
required
string
image
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "operationDate": "2019-08-24",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "maintenanceItems": [
    ],
  • "distance": 0,
  • "distanceUnit": "KILOMETER",
  • "remarks": "string",
  • "image": "string"
}

Response samples

Content type
application/json
{
  • "violations": [
    ],
  • "message": "string"
}

findAllMaintenanceForVehicle_1

path Parameters
vehicleId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createMaintenanceForVehicle_1

path Parameters
vehicleId
required
string <uuid>
Request Body schema: multipart/form-data
required
object (MaintenanceDTO)
file
string <binary>

Responses

Response samples

Content type
application/json
{
  • "violations": [
    ],
  • "message": "string"
}

getImageForMaintenance_3

path Parameters
maintenanceId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "violations": [
    ],
  • "message": "string"
}

getMaintenancesForOrganisation_4 Deprecated

Responses

Response samples

Content type
application/json
{
  • "maintenances": [
    ],
  • "vehicles": {
    },
  • "models": {
    }
}

maintenance-request-controller

getMaintenanceRequest_2 Deprecated

path Parameters
maintenanceRequestId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "vehicleRegistration": "string",
  • "vehicleBrand": "string",
  • "vehicleModel": "string",
  • "inspRequest": "string",
  • "expirationDate": "2019-08-24",
  • "kilometrage": 0,
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "createDate": "2019-08-24T14:15:22Z",
  • "editUserId": "b8cb20cd-fd09-4975-ad6b-1f7347c2e8ed",
  • "editDate": "2019-08-24T14:15:22Z",
  • "doneDate": "2019-08-24T14:15:22Z",
  • "doneUserId": "72ce7f1e-7f2a-4fa5-9f68-3495d76fbecd",
  • "done": true,
  • "status": "UNSET"
}

updateMaintenanceRequest_2 Deprecated

path Parameters
maintenanceRequestId
required
string <uuid>
Request Body schema: multipart/form-data
required
object (MaintenanceRequestDTO)
file
string <binary>

Responses

Response samples

Content type
application/json
{
  • "violations": [
    ],
  • "message": "string"
}

updateMaintenanceRequestNoImage Deprecated

path Parameters
maintenanceRequestId
required
string <uuid>
Request Body schema: application/json
required
id
string <uuid>
vehicleId
string <uuid>
vehicleRegistration
string
vehicleBrand
string
vehicleModel
string
inspRequest
string
expirationDate
string <date>
kilometrage
integer <int32>
createUserId
string <uuid>
createDate
string <date-time>
editUserId
string <uuid>
editDate
string <date-time>
doneDate
string <date-time>
doneUserId
string <uuid>
done
boolean
status
string (MaintenanceRequestStatus)
Enum: "UNSET" "OK" "WARN" "EXCEEDED"

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "vehicleRegistration": "string",
  • "vehicleBrand": "string",
  • "vehicleModel": "string",
  • "inspRequest": "string",
  • "expirationDate": "2019-08-24",
  • "kilometrage": 0,
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "createDate": "2019-08-24T14:15:22Z",
  • "editUserId": "b8cb20cd-fd09-4975-ad6b-1f7347c2e8ed",
  • "editDate": "2019-08-24T14:15:22Z",
  • "doneDate": "2019-08-24T14:15:22Z",
  • "doneUserId": "72ce7f1e-7f2a-4fa5-9f68-3495d76fbecd",
  • "done": true,
  • "status": "UNSET"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "vehicleRegistration": "string",
  • "vehicleBrand": "string",
  • "vehicleModel": "string",
  • "inspRequest": "string",
  • "expirationDate": "2019-08-24",
  • "kilometrage": 0,
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "createDate": "2019-08-24T14:15:22Z",
  • "editUserId": "b8cb20cd-fd09-4975-ad6b-1f7347c2e8ed",
  • "editDate": "2019-08-24T14:15:22Z",
  • "doneDate": "2019-08-24T14:15:22Z",
  • "doneUserId": "72ce7f1e-7f2a-4fa5-9f68-3495d76fbecd",
  • "done": true,
  • "status": "UNSET"
}

getAllMaintenanceRequestForVehicle_2 Deprecated

path Parameters
vehicleId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createMaintenanceRequest_2 Deprecated

path Parameters
vehicleId
required
string <uuid>
Request Body schema: multipart/form-data
required
object (MaintenanceRequestDTO)
file
string <binary>

Responses

Response samples

Content type
application/json
{
  • "violations": [
    ],
  • "message": "string"
}

createMaintenanceRequestNoImage Deprecated

path Parameters
vehicleId
required
string <uuid>
Request Body schema: application/json
required
id
string <uuid>
vehicleId
string <uuid>
vehicleRegistration
string
vehicleBrand
string
vehicleModel
string
inspRequest
string
expirationDate
string <date>
kilometrage
integer <int32>
createUserId
string <uuid>
createDate
string <date-time>
editUserId
string <uuid>
editDate
string <date-time>
doneDate
string <date-time>
doneUserId
string <uuid>
done
boolean
status
string (MaintenanceRequestStatus)
Enum: "UNSET" "OK" "WARN" "EXCEEDED"

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "vehicleRegistration": "string",
  • "vehicleBrand": "string",
  • "vehicleModel": "string",
  • "inspRequest": "string",
  • "expirationDate": "2019-08-24",
  • "kilometrage": 0,
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "createDate": "2019-08-24T14:15:22Z",
  • "editUserId": "b8cb20cd-fd09-4975-ad6b-1f7347c2e8ed",
  • "editDate": "2019-08-24T14:15:22Z",
  • "doneDate": "2019-08-24T14:15:22Z",
  • "doneUserId": "72ce7f1e-7f2a-4fa5-9f68-3495d76fbecd",
  • "done": true,
  • "status": "UNSET"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "vehicleRegistration": "string",
  • "vehicleBrand": "string",
  • "vehicleModel": "string",
  • "inspRequest": "string",
  • "expirationDate": "2019-08-24",
  • "kilometrage": 0,
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "createDate": "2019-08-24T14:15:22Z",
  • "editUserId": "b8cb20cd-fd09-4975-ad6b-1f7347c2e8ed",
  • "editDate": "2019-08-24T14:15:22Z",
  • "doneDate": "2019-08-24T14:15:22Z",
  • "doneUserId": "72ce7f1e-7f2a-4fa5-9f68-3495d76fbecd",
  • "done": true,
  • "status": "UNSET"
}

getAllMaintenanceRequest_2 Deprecated

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getImageForMaintenance_4 Deprecated

path Parameters
maintenanceRequestId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "violations": [
    ],
  • "message": "string"
}

handover-controller

getAll_6

header Parameters
required
object (OrganisationId)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

update_6

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
handoverId
string <uuid>
organisationId
string
createDateTime
string <date-time>
updateDateTime
string <date-time>
createUserId
string <uuid>
updateUserId
string <uuid>
handoverState
string (HandoverState)
Enum: "NEW" "WAITING_FOR_DRIVERS_APPROVAL" "WAITING_FOR_MANAGER_APPROVAL" "CLOSED_APPROVED" "CLOSED_REJECTED"
operationDate
string <date>
reason
string
vehicleId
string <uuid>
trailerId
string <uuid>
placeOfTransfer
string
outgoingDriverId
string <uuid>
incomingDriverId
string <uuid>
vehicleChecklistId
string <uuid>
trailerChecklistId
string <uuid>
vehicleDistance
integer <int32>
trailerDistance
integer <int32>
outgoingDriverApproved
boolean
outgoingDriverApprovalTimestamp
string <date-time>
incomingDriverApproved
boolean
incomingDriverApprovalTimestamp
string <date-time>
managerApproved
boolean
managerApprovalTimestamp
string <date-time>
outgoingDriverConditionOfVehicleComment
string
incomingDriverConditionOfVehicleComment
string
managerConditionOfVehicleComment
string
managerId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "handoverId": "67143d15-44f0-4ced-839c-8a3899adfeba",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "handoverState": "NEW",
  • "operationDate": "2019-08-24",
  • "reason": "string",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "trailerId": "d519e634-43b4-4caf-a685-a90a28153574",
  • "placeOfTransfer": "string",
  • "outgoingDriverId": "e2c72071-4035-4433-8231-f4dc75807e4a",
  • "incomingDriverId": "104b6336-56dc-4281-bd24-a3c055c9a73c",
  • "vehicleChecklistId": "f2a8860b-c279-4c31-a168-cacc3decb98e",
  • "trailerChecklistId": "6b6dbbe8-1ea7-4c78-a9a3-46ac52311455",
  • "vehicleDistance": 0,
  • "trailerDistance": 0,
  • "outgoingDriverApproved": true,
  • "outgoingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
  • "incomingDriverApproved": true,
  • "incomingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
  • "managerApproved": true,
  • "managerApprovalTimestamp": "2019-08-24T14:15:22Z",
  • "outgoingDriverConditionOfVehicleComment": "string",
  • "incomingDriverConditionOfVehicleComment": "string",
  • "managerConditionOfVehicleComment": "string",
  • "managerId": "b2c2c359-55f3-4680-a660-901475c7a693"
}

Response samples

Content type
application/json
{
  • "handoverId": "67143d15-44f0-4ced-839c-8a3899adfeba",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "handoverState": "NEW",
  • "operationDate": "2019-08-24",
  • "reason": "string",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "trailerId": "d519e634-43b4-4caf-a685-a90a28153574",
  • "placeOfTransfer": "string",
  • "outgoingDriverId": "e2c72071-4035-4433-8231-f4dc75807e4a",
  • "incomingDriverId": "104b6336-56dc-4281-bd24-a3c055c9a73c",
  • "vehicleChecklistId": "f2a8860b-c279-4c31-a168-cacc3decb98e",
  • "trailerChecklistId": "6b6dbbe8-1ea7-4c78-a9a3-46ac52311455",
  • "vehicleDistanceId": "d0447fbf-4ed2-421e-adb1-7c226e9f4b17",
  • "trailerDistanceId": "6ef67421-49f8-4042-bd6c-3208c828216f",
  • "outgoingDriverApproved": true,
  • "outgoingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
  • "incomingDriverApproved": true,
  • "incomingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
  • "managerApproved": true,
  • "managerApprovalTimestamp": "2019-08-24T14:15:22Z",
  • "outgoingDriverConditionOfVehicleComment": "string",
  • "incomingDriverConditionOfVehicleComment": "string",
  • "managerConditionOfVehicleComment": "string",
  • "managerId": "b2c2c359-55f3-4680-a660-901475c7a693"
}

create_6

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
handoverId
string <uuid>
organisationId
string
createDateTime
string <date-time>
updateDateTime
string <date-time>
createUserId
string <uuid>
updateUserId
string <uuid>
handoverState
string (HandoverState)
Enum: "NEW" "WAITING_FOR_DRIVERS_APPROVAL" "WAITING_FOR_MANAGER_APPROVAL" "CLOSED_APPROVED" "CLOSED_REJECTED"
operationDate
string <date>
reason
string
vehicleId
string <uuid>
trailerId
string <uuid>
placeOfTransfer
string
outgoingDriverId
string <uuid>
incomingDriverId
string <uuid>
vehicleChecklistId
string <uuid>
trailerChecklistId
string <uuid>
vehicleDistance
integer <int32>
trailerDistance
integer <int32>
outgoingDriverApproved
boolean
outgoingDriverApprovalTimestamp
string <date-time>
incomingDriverApproved
boolean
incomingDriverApprovalTimestamp
string <date-time>
managerApproved
boolean
managerApprovalTimestamp
string <date-time>
outgoingDriverConditionOfVehicleComment
string
incomingDriverConditionOfVehicleComment
string
managerConditionOfVehicleComment
string
managerId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "handoverId": "67143d15-44f0-4ced-839c-8a3899adfeba",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "handoverState": "NEW",
  • "operationDate": "2019-08-24",
  • "reason": "string",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "trailerId": "d519e634-43b4-4caf-a685-a90a28153574",
  • "placeOfTransfer": "string",
  • "outgoingDriverId": "e2c72071-4035-4433-8231-f4dc75807e4a",
  • "incomingDriverId": "104b6336-56dc-4281-bd24-a3c055c9a73c",
  • "vehicleChecklistId": "f2a8860b-c279-4c31-a168-cacc3decb98e",
  • "trailerChecklistId": "6b6dbbe8-1ea7-4c78-a9a3-46ac52311455",
  • "vehicleDistance": 0,
  • "trailerDistance": 0,
  • "outgoingDriverApproved": true,
  • "outgoingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
  • "incomingDriverApproved": true,
  • "incomingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
  • "managerApproved": true,
  • "managerApprovalTimestamp": "2019-08-24T14:15:22Z",
  • "outgoingDriverConditionOfVehicleComment": "string",
  • "incomingDriverConditionOfVehicleComment": "string",
  • "managerConditionOfVehicleComment": "string",
  • "managerId": "b2c2c359-55f3-4680-a660-901475c7a693"
}

Response samples

Content type
application/json
{
  • "handoverId": "67143d15-44f0-4ced-839c-8a3899adfeba",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "handoverState": "NEW",
  • "operationDate": "2019-08-24",
  • "reason": "string",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "trailerId": "d519e634-43b4-4caf-a685-a90a28153574",
  • "placeOfTransfer": "string",
  • "outgoingDriverId": "e2c72071-4035-4433-8231-f4dc75807e4a",
  • "incomingDriverId": "104b6336-56dc-4281-bd24-a3c055c9a73c",
  • "vehicleChecklistId": "f2a8860b-c279-4c31-a168-cacc3decb98e",
  • "trailerChecklistId": "6b6dbbe8-1ea7-4c78-a9a3-46ac52311455",
  • "vehicleDistanceId": "d0447fbf-4ed2-421e-adb1-7c226e9f4b17",
  • "trailerDistanceId": "6ef67421-49f8-4042-bd6c-3208c828216f",
  • "outgoingDriverApproved": true,
  • "outgoingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
  • "incomingDriverApproved": true,
  • "incomingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
  • "managerApproved": true,
  • "managerApprovalTimestamp": "2019-08-24T14:15:22Z",
  • "outgoingDriverConditionOfVehicleComment": "string",
  • "incomingDriverConditionOfVehicleComment": "string",
  • "managerConditionOfVehicleComment": "string",
  • "managerId": "b2c2c359-55f3-4680-a660-901475c7a693"
}

approve

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
handoverId
string <uuid>
organisationId
string
createDateTime
string <date-time>
updateDateTime
string <date-time>
createUserId
string <uuid>
updateUserId
string <uuid>
handoverState
string (HandoverState)
Enum: "NEW" "WAITING_FOR_DRIVERS_APPROVAL" "WAITING_FOR_MANAGER_APPROVAL" "CLOSED_APPROVED" "CLOSED_REJECTED"
operationDate
string <date>
reason
string
vehicleId
string <uuid>
trailerId
string <uuid>
placeOfTransfer
string
outgoingDriverId
string <uuid>
incomingDriverId
string <uuid>
vehicleChecklistId
string <uuid>
trailerChecklistId
string <uuid>
vehicleDistance
integer <int32>
trailerDistance
integer <int32>
outgoingDriverApproved
boolean
outgoingDriverApprovalTimestamp
string <date-time>
incomingDriverApproved
boolean
incomingDriverApprovalTimestamp
string <date-time>
managerApproved
boolean
managerApprovalTimestamp
string <date-time>
outgoingDriverConditionOfVehicleComment
string
incomingDriverConditionOfVehicleComment
string
managerConditionOfVehicleComment
string
managerId
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "handoverId": "67143d15-44f0-4ced-839c-8a3899adfeba",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "handoverState": "NEW",
  • "operationDate": "2019-08-24",
  • "reason": "string",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "trailerId": "d519e634-43b4-4caf-a685-a90a28153574",
  • "placeOfTransfer": "string",
  • "outgoingDriverId": "e2c72071-4035-4433-8231-f4dc75807e4a",
  • "incomingDriverId": "104b6336-56dc-4281-bd24-a3c055c9a73c",
  • "vehicleChecklistId": "f2a8860b-c279-4c31-a168-cacc3decb98e",
  • "trailerChecklistId": "6b6dbbe8-1ea7-4c78-a9a3-46ac52311455",
  • "vehicleDistance": 0,
  • "trailerDistance": 0,
  • "outgoingDriverApproved": true,
  • "outgoingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
  • "incomingDriverApproved": true,
  • "incomingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
  • "managerApproved": true,
  • "managerApprovalTimestamp": "2019-08-24T14:15:22Z",
  • "outgoingDriverConditionOfVehicleComment": "string",
  • "incomingDriverConditionOfVehicleComment": "string",
  • "managerConditionOfVehicleComment": "string",
  • "managerId": "b2c2c359-55f3-4680-a660-901475c7a693"
}

Response samples

Content type
application/json
{
  • "handoverId": "67143d15-44f0-4ced-839c-8a3899adfeba",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "handoverState": "NEW",
  • "operationDate": "2019-08-24",
  • "reason": "string",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "trailerId": "d519e634-43b4-4caf-a685-a90a28153574",
  • "placeOfTransfer": "string",
  • "outgoingDriverId": "e2c72071-4035-4433-8231-f4dc75807e4a",
  • "incomingDriverId": "104b6336-56dc-4281-bd24-a3c055c9a73c",
  • "vehicleChecklistId": "f2a8860b-c279-4c31-a168-cacc3decb98e",
  • "trailerChecklistId": "6b6dbbe8-1ea7-4c78-a9a3-46ac52311455",
  • "vehicleDistanceId": "d0447fbf-4ed2-421e-adb1-7c226e9f4b17",
  • "trailerDistanceId": "6ef67421-49f8-4042-bd6c-3208c828216f",
  • "outgoingDriverApproved": true,
  • "outgoingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
  • "incomingDriverApproved": true,
  • "incomingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
  • "managerApproved": true,
  • "managerApprovalTimestamp": "2019-08-24T14:15:22Z",
  • "outgoingDriverConditionOfVehicleComment": "string",
  • "incomingDriverConditionOfVehicleComment": "string",
  • "managerConditionOfVehicleComment": "string",
  • "managerId": "b2c2c359-55f3-4680-a660-901475c7a693"
}

get_6

path Parameters
handoverId
required
string <uuid>
header Parameters
required
object (OrganisationId)

Responses

Response samples

Content type
application/json
{
  • "handoverId": "67143d15-44f0-4ced-839c-8a3899adfeba",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "handoverState": "NEW",
  • "operationDate": "2019-08-24",
  • "reason": "string",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "trailerId": "d519e634-43b4-4caf-a685-a90a28153574",
  • "placeOfTransfer": "string",
  • "outgoingDriverId": "e2c72071-4035-4433-8231-f4dc75807e4a",
  • "incomingDriverId": "104b6336-56dc-4281-bd24-a3c055c9a73c",
  • "vehicleChecklistId": "f2a8860b-c279-4c31-a168-cacc3decb98e",
  • "trailerChecklistId": "6b6dbbe8-1ea7-4c78-a9a3-46ac52311455",
  • "vehicleDistance": 0,
  • "trailerDistance": 0,
  • "outgoingDriverApproved": true,
  • "outgoingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
  • "incomingDriverApproved": true,
  • "incomingDriverApprovalTimestamp": "2019-08-24T14:15:22Z",
  • "managerApproved": true,
  • "managerApprovalTimestamp": "2019-08-24T14:15:22Z",
  • "outgoingDriverConditionOfVehicleComment": "string",
  • "incomingDriverConditionOfVehicleComment": "string",
  • "managerConditionOfVehicleComment": "string",
  • "managerId": "b2c2c359-55f3-4680-a660-901475c7a693"
}

refueling-controller

getAll_7

header Parameters
required
object (OrganisationId)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

update_7

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
refuelingId
string <uuid>
organisationId
string
createDateTime
string <date-time>
updateDateTime
string <date-time>
createUserId
string <uuid>
updateUserId
string <uuid>
operationDate
string <date>

Operation date

vehicleId
string <uuid>
fuel
string (Fuel)
Enum: "PETROL" "DIESEL" "COMPRESSED_NATURAL_GAS" "LIQUEFIED_PETROLEUM_GAS" "HYDROGEN" "ELECTRIC"

Fuel type

distance
integer <int32>

Vehicle distance

amount
integer <int32>

Amount of fuel

invoiceNumber
string

The purchase invoice number.

comment
string

Additional information about refuelling

Responses

Request samples

Content type
application/json
{
  • "refuelingId": "472a8ee6-eb9c-4aa4-a142-61abdab47cb3",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "operationDate": "2024-03-12",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "fuel": "PETROL",
  • "distance": 234000,
  • "amount": 123,
  • "invoiceNumber": "123/2024",
  • "comment": "Good price"
}

Response samples

Content type
application/json
{
  • "refuelingId": "472a8ee6-eb9c-4aa4-a142-61abdab47cb3",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "operationDate": "2024-03-12",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "fuel": "PETROL",
  • "distanceId": "63d9d003-740a-4ba4-8816-e7d01b8ebc22",
  • "amount": 123,
  • "invoiceNumber": "123/2024",
  • "comment": "Good price"
}

create_7

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
refuelingId
string <uuid>
organisationId
string
createDateTime
string <date-time>
updateDateTime
string <date-time>
createUserId
string <uuid>
updateUserId
string <uuid>
operationDate
string <date>

Operation date

vehicleId
string <uuid>
fuel
string (Fuel)
Enum: "PETROL" "DIESEL" "COMPRESSED_NATURAL_GAS" "LIQUEFIED_PETROLEUM_GAS" "HYDROGEN" "ELECTRIC"

Fuel type

distance
integer <int32>

Vehicle distance

amount
integer <int32>

Amount of fuel

invoiceNumber
string

The purchase invoice number.

comment
string

Additional information about refuelling

Responses

Request samples

Content type
application/json
{
  • "refuelingId": "472a8ee6-eb9c-4aa4-a142-61abdab47cb3",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "operationDate": "2024-03-12",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "fuel": "PETROL",
  • "distance": 234000,
  • "amount": 123,
  • "invoiceNumber": "123/2024",
  • "comment": "Good price"
}

Response samples

Content type
application/json
{
  • "refuelingId": "472a8ee6-eb9c-4aa4-a142-61abdab47cb3",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "operationDate": "2024-03-12",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "fuel": "PETROL",
  • "distanceId": "63d9d003-740a-4ba4-8816-e7d01b8ebc22",
  • "amount": 123,
  • "invoiceNumber": "123/2024",
  • "comment": "Good price"
}

get_7

path Parameters
refuelingId
required
string <uuid>
header Parameters
required
object (OrganisationId)

Responses

Response samples

Content type
application/json
{
  • "refuelingId": "472a8ee6-eb9c-4aa4-a142-61abdab47cb3",
  • "organisationId": "string",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "operationDate": "2024-03-12",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "fuel": "PETROL",
  • "distance": 234000,
  • "amount": 123,
  • "invoiceNumber": "123/2024",
  • "comment": "Good price"
}

duty-item-controller

getDutyItem_1 Deprecated

path Parameters
dutyItemId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "itemId": "f11b669d-7201-4c21-88af-d85092f0c005",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "name": "string",
  • "type": "DATE",
  • "status": "UNSET",
  • "expirationDate": "2019-08-24",
  • "updateTimestamp": "2019-08-24T14:15:22Z",
  • "updateUser": "361e814f-eb1f-4bf2-8c47-35f1bcb2124e"
}

updateDutyItem_1 Deprecated

path Parameters
dutyItemId
required
string <uuid>
Request Body schema: application/json
required
name
required
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "itemId": "f11b669d-7201-4c21-88af-d85092f0c005",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "name": "string",
  • "type": "DATE",
  • "status": "UNSET",
  • "expirationDate": "2019-08-24",
  • "updateTimestamp": "2019-08-24T14:15:22Z",
  • "updateUser": "361e814f-eb1f-4bf2-8c47-35f1bcb2124e"
}

getDutyItems_1 Deprecated

Responses

Response samples

Content type
application/json
[
  • {
    }
]

addDutyItem_1 Deprecated

Request Body schema: application/json
required
name
required
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "itemId": "f11b669d-7201-4c21-88af-d85092f0c005",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "name": "string",
  • "type": "DATE",
  • "status": "UNSET",
  • "expirationDate": "2019-08-24",
  • "updateTimestamp": "2019-08-24T14:15:22Z",
  • "updateUser": "361e814f-eb1f-4bf2-8c47-35f1bcb2124e"
}

duty-controller

getDuty_1 Deprecated

path Parameters
dutyId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "itemId": "f11b669d-7201-4c21-88af-d85092f0c005",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "name": "string",
  • "type": "DATE",
  • "status": "UNSET",
  • "expirationDate": "2019-08-24",
  • "updateTimestamp": "2019-08-24T14:15:22Z",
  • "updateUser": "361e814f-eb1f-4bf2-8c47-35f1bcb2124e"
}

updateDuty_1 Deprecated

path Parameters
dutyId
required
string <uuid>
Request Body schema: application/json
required
expirationDate
string <date>

Responses

Request samples

Content type
application/json
{
  • "expirationDate": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "itemId": "f11b669d-7201-4c21-88af-d85092f0c005",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "name": "string",
  • "type": "DATE",
  • "status": "UNSET",
  • "expirationDate": "2019-08-24",
  • "updateTimestamp": "2019-08-24T14:15:22Z",
  • "updateUser": "361e814f-eb1f-4bf2-8c47-35f1bcb2124e"
}

getDutiesForVehicle_1 Deprecated

path Parameters
vehicleId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

distance-controller

updateDistance_1 Deprecated

Request Body schema: application/json
required
id
object (DistanceId)
vehicleId
string <uuid>
operationDate
string <date>
userId
string <uuid>
createDateTime
string <date-time>
updateUserId
string <uuid>
updateDateTime
string <date-time>
distance
integer <int64>
distanceUnit
string (WorkUnit)
Enum: "KILOMETER" "MILE" "HOUR"
distanceType
string (DistanceType)
Enum: "DISTANCE" "MAINTENANCE" "DUTY" "COUPLING" "HANDOVER" "REFUELING"
externalId
string <uuid>
remarks
string [ 0 .. 1024 ] characters

Responses

Request samples

Content type
application/json
{
  • "id": { },
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "operationDate": "2019-08-24",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "distance": 0,
  • "distanceUnit": "KILOMETER",
  • "distanceType": "DISTANCE",
  • "externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
  • "remarks": "string"
}

Response samples

Content type
application/json
{ }

createDistance_1 Deprecated

Request Body schema: application/json
required
id
object (DistanceId)
vehicleId
string <uuid>
operationDate
string <date>
userId
string <uuid>
createDateTime
string <date-time>
updateUserId
string <uuid>
updateDateTime
string <date-time>
distance
integer <int64>
distanceUnit
string (WorkUnit)
Enum: "KILOMETER" "MILE" "HOUR"
distanceType
string (DistanceType)
Enum: "DISTANCE" "MAINTENANCE" "DUTY" "COUPLING" "HANDOVER" "REFUELING"
externalId
string <uuid>
remarks
string [ 0 .. 1024 ] characters

Responses

Request samples

Content type
application/json
{
  • "id": { },
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "operationDate": "2019-08-24",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "distance": 0,
  • "distanceUnit": "KILOMETER",
  • "distanceType": "DISTANCE",
  • "externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
  • "remarks": "string"
}

Response samples

Content type
application/json
{ }

getDistance_1 Deprecated

path Parameters
distanceId
required
object (DistanceId)

Responses

Response samples

Content type
application/json
{
  • "id": { },
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "operationDate": "2019-08-24",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "distance": 0,
  • "distanceUnit": "KILOMETER",
  • "distanceType": "DISTANCE",
  • "externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
  • "remarks": "string"
}

deleteDistance_1 Deprecated

path Parameters
distanceId
required
object (DistanceId)

Responses

Response samples

Content type
application/json
{
  • "violations": [
    ],
  • "message": "string"
}

getDistanceForVehicle_1 Deprecated

path Parameters
vehicleId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

coupling-controller

getCoupling

path Parameters
couplingId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "decoupledDateTime": "2019-08-24T14:15:22Z",
  • "updatePersonId": "069b7006-3570-4408-a633-a325fbeb33e1",
  • "carId": "566dcc5d-30ab-488e-96e1-c09dec523f18",
  • "carRegistration": "string",
  • "carBrand": "string",
  • "carModel": "string",
  • "coupledDate": "2019-08-24",
  • "coupledDistance": 0,
  • "coupledTrailerDistance": 0,
  • "coupledPersonId": "6c41767c-738c-45d1-85ff-44593d0abedf",
  • "coupledRemarks": "string",
  • "decoupledDate": "2019-08-24",
  • "decoupledDistance": 0,
  • "decoupledTrailerDistance": 0,
  • "decoupledPersonId": "e8698e97-a658-468a-8bc7-6a9cf8a6f1ac",
  • "decoupledRemarks": "string",
  • "trailerId": "d519e634-43b4-4caf-a685-a90a28153574",
  • "trailerRegistration": "string",
  • "trailerBrand": "string",
  • "trailerModel": "string"
}

updateCoupling

path Parameters
couplingId
required
string <uuid>
Request Body schema: application/json
required
id
string <uuid>
createDateTime
string <date-time>
updateDateTime
string <date-time>
decoupledDateTime
string <date-time>
updatePersonId
string <uuid>
carId
required
string <uuid>
carRegistration
string
carBrand
string
carModel
string
coupledDate
string <date>
coupledDistance
required
integer <int64>
coupledTrailerDistance
integer <int64>
coupledPersonId
string <uuid>
coupledRemarks
string
decoupledDate
string <date>
decoupledDistance
integer <int64>
decoupledTrailerDistance
integer <int64>
decoupledPersonId
string <uuid>
decoupledRemarks
string
trailerId
required
string <uuid>
trailerRegistration
string
trailerBrand
string
trailerModel
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "decoupledDateTime": "2019-08-24T14:15:22Z",
  • "updatePersonId": "069b7006-3570-4408-a633-a325fbeb33e1",
  • "carId": "566dcc5d-30ab-488e-96e1-c09dec523f18",
  • "carRegistration": "string",
  • "carBrand": "string",
  • "carModel": "string",
  • "coupledDate": "2019-08-24",
  • "coupledDistance": 0,
  • "coupledTrailerDistance": 0,
  • "coupledPersonId": "6c41767c-738c-45d1-85ff-44593d0abedf",
  • "coupledRemarks": "string",
  • "decoupledDate": "2019-08-24",
  • "decoupledDistance": 0,
  • "decoupledTrailerDistance": 0,
  • "decoupledPersonId": "e8698e97-a658-468a-8bc7-6a9cf8a6f1ac",
  • "decoupledRemarks": "string",
  • "trailerId": "d519e634-43b4-4caf-a685-a90a28153574",
  • "trailerRegistration": "string",
  • "trailerBrand": "string",
  • "trailerModel": "string"
}

Response samples

Content type
application/json
{ }

getCouplings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createCoupling

Request Body schema: application/json
required
id
string <uuid>
createDateTime
string <date-time>
updateDateTime
string <date-time>
decoupledDateTime
string <date-time>
updatePersonId
string <uuid>
carId
required
string <uuid>
carRegistration
string
carBrand
string
carModel
string
coupledDate
string <date>
coupledDistance
required
integer <int64>
coupledTrailerDistance
integer <int64>
coupledPersonId
string <uuid>
coupledRemarks
string
decoupledDate
string <date>
decoupledDistance
integer <int64>
decoupledTrailerDistance
integer <int64>
decoupledPersonId
string <uuid>
decoupledRemarks
string
trailerId
required
string <uuid>
trailerRegistration
string
trailerBrand
string
trailerModel
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "decoupledDateTime": "2019-08-24T14:15:22Z",
  • "updatePersonId": "069b7006-3570-4408-a633-a325fbeb33e1",
  • "carId": "566dcc5d-30ab-488e-96e1-c09dec523f18",
  • "carRegistration": "string",
  • "carBrand": "string",
  • "carModel": "string",
  • "coupledDate": "2019-08-24",
  • "coupledDistance": 0,
  • "coupledTrailerDistance": 0,
  • "coupledPersonId": "6c41767c-738c-45d1-85ff-44593d0abedf",
  • "coupledRemarks": "string",
  • "decoupledDate": "2019-08-24",
  • "decoupledDistance": 0,
  • "decoupledTrailerDistance": 0,
  • "decoupledPersonId": "e8698e97-a658-468a-8bc7-6a9cf8a6f1ac",
  • "decoupledRemarks": "string",
  • "trailerId": "d519e634-43b4-4caf-a685-a90a28153574",
  • "trailerRegistration": "string",
  • "trailerBrand": "string",
  • "trailerModel": "string"
}

Response samples

Content type
application/json
{ }

getCouplingForVehicle

path Parameters
vehicleId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "coupleable": true,
  • "couplings": [
    ]
}

getCoupleableTrailers

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getCouplings_1

Responses

Response samples

Content type
application/json
[
  • {
    }
]

checklist-controller

getAll_8

header Parameters
organisation-id
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

update_8

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
checklistId
string <uuid>
organisationId
string <uuid>
createDateTime
string <date-time>
updateDateTime
string <date-time>
createUserId
string <uuid>
updateUserId
string <uuid>
name
string
description
string
operationDate
string <date>
template
boolean
vehicleId
string <uuid>
Array of objects (ChecklistItemDTO)
comment
string
closed
boolean
closedUserId
string <uuid>
closedDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "checklistId": "9c2471f0-7b0e-4603-bb5c-ee5fa92d766a",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "name": "string",
  • "description": "string",
  • "operationDate": "2019-08-24",
  • "template": true,
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "items": [
    ],
  • "comment": "string",
  • "closed": true,
  • "closedUserId": "f33cf7f8-af45-40d7-bf15-cfa1fa469453",
  • "closedDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "checklistId": "9c2471f0-7b0e-4603-bb5c-ee5fa92d766a",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "name": "string",
  • "description": "string",
  • "operationDate": "2019-08-24",
  • "template": true,
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "items": [
    ],
  • "comment": "string",
  • "closed": true,
  • "closedUserId": "f33cf7f8-af45-40d7-bf15-cfa1fa469453",
  • "closedDate": "2019-08-24T14:15:22Z"
}

create_8

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
checklistId
string <uuid>
organisationId
string <uuid>
createDateTime
string <date-time>
updateDateTime
string <date-time>
createUserId
string <uuid>
updateUserId
string <uuid>
name
string
description
string
operationDate
string <date>
template
boolean
vehicleId
string <uuid>
Array of objects (ChecklistItemDTO)
comment
string
closed
boolean
closedUserId
string <uuid>
closedDate
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "checklistId": "9c2471f0-7b0e-4603-bb5c-ee5fa92d766a",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "name": "string",
  • "description": "string",
  • "operationDate": "2019-08-24",
  • "template": true,
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "items": [
    ],
  • "comment": "string",
  • "closed": true,
  • "closedUserId": "f33cf7f8-af45-40d7-bf15-cfa1fa469453",
  • "closedDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "checklistId": "9c2471f0-7b0e-4603-bb5c-ee5fa92d766a",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "name": "string",
  • "description": "string",
  • "operationDate": "2019-08-24",
  • "template": true,
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "items": [
    ],
  • "comment": "string",
  • "closed": true,
  • "closedUserId": "f33cf7f8-af45-40d7-bf15-cfa1fa469453",
  • "closedDate": "2019-08-24T14:15:22Z"
}

close

path Parameters
checklistId
required
string <uuid>
header Parameters
required
object (OrganisationId)

Responses

Response samples

Content type
application/json
{
  • "checklistId": "9c2471f0-7b0e-4603-bb5c-ee5fa92d766a",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "name": "string",
  • "description": "string",
  • "operationDate": "2019-08-24",
  • "template": true,
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "items": [
    ],
  • "comment": "string",
  • "closed": true,
  • "closedUserId": "f33cf7f8-af45-40d7-bf15-cfa1fa469453",
  • "closedDate": "2019-08-24T14:15:22Z"
}

get_8

path Parameters
checklistId
required
string <uuid>
header Parameters
required
object (OrganisationId)

Responses

Response samples

Content type
application/json
{
  • "checklistId": "9c2471f0-7b0e-4603-bb5c-ee5fa92d766a",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "name": "string",
  • "description": "string",
  • "operationDate": "2019-08-24",
  • "template": true,
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "items": [
    ],
  • "comment": "string",
  • "closed": true,
  • "closedUserId": "f33cf7f8-af45-40d7-bf15-cfa1fa469453",
  • "closedDate": "2019-08-24T14:15:22Z"
}

brand-controller

getBrand_1 Deprecated

path Parameters
brandId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "name": "string",
  • "models": [
    ]
}

updateBrand_1 Deprecated

path Parameters
brandId
required
string <uuid>
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "name": "string",
  • "models": [
    ]
}

getBrands_1 Deprecated

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createBrand_1 Deprecated

Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "name": "string",
  • "models": [
    ]
}

getBrands_2 Deprecated

Responses

Response samples

Content type
application/json
[
  • {
    }
]

model-controller

updateModel_2 Deprecated

path Parameters
brandId
required
string <uuid>
modelId
required
string <uuid>
Request Body schema: application/json
required
modelId
required
string <uuid>
name
required
string
brandId
string <uuid>
axesCount
integer <int32> [ 2 .. 4 ]
typeId
string <uuid>
typeName
string
required
Array of objects (MaintenanceItemValueDTO)

Responses

Request samples

Content type
application/json
{
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "name": "string",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "axesCount": 2,
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "typeName": "string",
  • "maintenanceItemValues": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "typeName": "string",
  • "maintenanceItemValues": [
    ],
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "axesCount": 0,
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278"
}

getModelsForBrand_2 Deprecated

path Parameters
brandId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createModel_2 Deprecated

path Parameters
brandId
required
string <uuid>
Request Body schema: application/json
required
modelId
required
string <uuid>
name
required
string
brandId
string <uuid>
axesCount
integer <int32> [ 2 .. 4 ]
typeId
string <uuid>
typeName
string
required
Array of objects (MaintenanceItemValueDTO)

Responses

Request samples

Content type
application/json
{
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278",
  • "name": "string",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "axesCount": 2,
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "typeName": "string",
  • "maintenanceItemValues": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "typeName": "string",
  • "maintenanceItemValues": [
    ],
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "axesCount": 0,
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278"
}

getModel_2 Deprecated

path Parameters
modelId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "typeName": "string",
  • "maintenanceItemValues": [
    ],
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "axesCount": 0,
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278"
}

asset-controller

getAll_10

header Parameters
required
object (OrganisationId)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

update_9

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
assetId
string <uuid>
object (OrganisationId)
createDateTime
string <date-time>
updateDateTime
string <date-time>
createUserId
string <uuid>
updateUserId
string <uuid>
name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "organisationId": {
    },
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "organisationId": {
    },
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "name": "string",
  • "description": "string"
}

create_9

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
assetId
string <uuid>
object (OrganisationId)
createDateTime
string <date-time>
updateDateTime
string <date-time>
createUserId
string <uuid>
updateUserId
string <uuid>
name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "organisationId": {
    },
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "organisationId": {
    },
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "name": "string",
  • "description": "string"
}

get_9

path Parameters
assetId
required
string <uuid>
header Parameters
required
object (OrganisationId)

Responses

Response samples

Content type
application/json
{
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "organisationId": {
    },
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "name": "string",
  • "description": "string"
}

asset-instance-controller

getAll_11

header Parameters
required
object (OrganisationId)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

update_10

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
assetInstanceId
string <uuid>
object (OrganisationId)
createDateTime
string <date-time>
updateDateTime
string <date-time>
createUserId
string <uuid>
updateUserId
string <uuid>
amount
integer <int32>
assetId
string <uuid>
vehicleId
string <uuid>
deleted
boolean
deletedUserId
string <uuid>
deletedDateTime
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "assetInstanceId": "605efab6-99a7-4ea3-8f61-391429fbad2b",
  • "organisationId": {
    },
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "amount": 0,
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "deleted": true,
  • "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759",
  • "deletedDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "assetInstanceId": "605efab6-99a7-4ea3-8f61-391429fbad2b",
  • "organisationId": {
    },
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "amount": 0,
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "deleted": true,
  • "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759",
  • "deletedDateTime": "2019-08-24T14:15:22Z"
}

create_10

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
assetInstanceId
string <uuid>
object (OrganisationId)
createDateTime
string <date-time>
updateDateTime
string <date-time>
createUserId
string <uuid>
updateUserId
string <uuid>
amount
integer <int32>
assetId
string <uuid>
vehicleId
string <uuid>
deleted
boolean
deletedUserId
string <uuid>
deletedDateTime
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "assetInstanceId": "605efab6-99a7-4ea3-8f61-391429fbad2b",
  • "organisationId": {
    },
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "amount": 0,
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "deleted": true,
  • "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759",
  • "deletedDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "assetInstanceId": "605efab6-99a7-4ea3-8f61-391429fbad2b",
  • "organisationId": {
    },
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "amount": 0,
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "deleted": true,
  • "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759",
  • "deletedDateTime": "2019-08-24T14:15:22Z"
}

delete

header Parameters
required
object (OrganisationId)
Request Body schema: application/json
required
assetInstanceId
string <uuid>
object (OrganisationId)
createDateTime
string <date-time>
updateDateTime
string <date-time>
createUserId
string <uuid>
updateUserId
string <uuid>
amount
integer <int32>
assetId
string <uuid>
vehicleId
string <uuid>
deleted
boolean
deletedUserId
string <uuid>
deletedDateTime
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "assetInstanceId": "605efab6-99a7-4ea3-8f61-391429fbad2b",
  • "organisationId": {
    },
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "amount": 0,
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "deleted": true,
  • "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759",
  • "deletedDateTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "assetInstanceId": "605efab6-99a7-4ea3-8f61-391429fbad2b",
  • "organisationId": {
    },
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "amount": 0,
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "deleted": true,
  • "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759",
  • "deletedDateTime": "2019-08-24T14:15:22Z"
}

get_10

path Parameters
assetInstanceId
required
string <uuid>
header Parameters
required
object (OrganisationId)

Responses

Response samples

Content type
application/json
{
  • "assetInstanceId": "605efab6-99a7-4ea3-8f61-391429fbad2b",
  • "organisationId": {
    },
  • "createDateTime": "2019-08-24T14:15:22Z",
  • "updateDateTime": "2019-08-24T14:15:22Z",
  • "createUserId": "8a4236c1-1b1a-4524-8e83-af97da191e4a",
  • "updateUserId": "ca111acd-3c55-46ef-9693-09a30ec78a54",
  • "amount": 0,
  • "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "deleted": true,
  • "deletedUserId": "c86f3097-82ed-4a8c-80e7-9b6637ef5759",
  • "deletedDateTime": "2019-08-24T14:15:22Z"
}

telemetry-controller-get-v-01

getTelemetry

path Parameters
organisationId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "violations": [
    ],
  • "message": "string"
}

telemetry-controller-create-v-01

createTelemetry

path Parameters
organisationId
required
string <uuid>
Request Body schema: application/json
required
vehicleId
required
string <uuid>
operationTimestamp
string <date-time>
longitude
number <float>
latitude
number <float>
speed
number <float>
odometer
integer <int32>
fuelLevel
number <float>
fuelLevelUnit
string (VolumeUnit)
Enum: "PERCENT" "LITRE" "GALLON"
catalystLevel
number <float>
catalystLevelUnit
string (VolumeUnit)
Enum: "PERCENT" "LITRE" "GALLON"
ignition
boolean

Responses

Request samples

Content type
application/json
{
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "operationTimestamp": "2019-08-24T14:15:22Z",
  • "longitude": 0.1,
  • "latitude": 0.1,
  • "speed": 0.1,
  • "odometer": 0,
  • "fuelLevel": 0.1,
  • "fuelLevelUnit": "PERCENT",
  • "catalystLevel": 0.1,
  • "catalystLevelUnit": "PERCENT",
  • "ignition": true
}

Response samples

Content type
application/json
{
  • "violations": [
    ],
  • "message": "string"
}

vehicle-parameter-get-all-for-organisation-controller

getParameter

path Parameters
organisationId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

vehicle-parameter-create-for-organisation-controller

createParameter

path Parameters
organisationId
required
string <uuid>
Request Body schema: application/json
required
id
string <uuid>
enabled
boolean
organisationId
string
name
required
string [ 1 .. 64 ] characters
description
string [ 0 .. 256 ] characters

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enabled": true,
  • "organisationId": "string",
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enabled": true,
  • "organisationId": "string",
  • "name": "string",
  • "description": "string"
}

invite-controller

getInvitations

Responses

Response samples

Content type
application/json
{
  • "violations": [
    ],
  • "message": "string"
}

createInvitation

Request Body schema: application/json
required
invitationId
string <uuid>
email
string
invitedByUser
string <uuid>
createdTimestamp
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "invitationId": "550a4884-8473-4f2e-a6cf-551c16767d59",
  • "email": "string",
  • "invitedByUser": "10957437-f7aa-4d04-927c-ea43f27b0b5d",
  • "createdTimestamp": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "violations": [
    ],
  • "message": "string"
}

getInvitation

path Parameters
invitationId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "violations": [
    ],
  • "message": "string"
}

deleteInvitation

path Parameters
invitationId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "violations": [
    ],
  • "message": "string"
}

prompt-controller

getMaintenancesForOrganisation

header Parameters
organisation-id
required
string <uuid>
Request Body schema: application/json
required
prompt
string

Responses

Request samples

Content type
application/json
{
  • "prompt": "string"
}

Response samples

Content type
application/json
{
  • "response": "string"
}

maintenances-for-organisation-controller-v-22

getMaintenancesForOrganisation_1

path Parameters
organisationId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

maintenances-for-organisation-controller-v-21

getMaintenancesForOrganisation_2 Deprecated

Responses

Response samples

Content type
application/json
[
  • {
    }
]

duty-report-controller-v-03

getDutyReportForDutyItemId

path Parameters
organisationId
required
string <uuid>
dutyItemId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

model-controller-query-v-03

getModelsForBrand

path Parameters
organisationId
required
string <uuid>
brandId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getModel

path Parameters
organisationId
required
string <uuid>
modelId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "typeName": "string",
  • "maintenanceItemValues": [
    ],
  • "selectedVehicleParameters": [
    ],
  • "workUnit": "KILOMETER",
  • "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",
  • "axesCount": 0,
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "modelId": "17563eeb-82d7-4210-ac9b-1a20c7d67278"
}

maintenance-report-controller-v-02

getWarnReport

path Parameters
organisationId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getExceedReport

path Parameters
organisationId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

maintenance-request-report-controller-v-02

getWarnReport_1

path Parameters
organisationId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getExceedReport_1

path Parameters
organisationId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

flight-recorder-controller-v-02

getEpisodes

path Parameters
organisationId
required
string <uuid>
query Parameters
required
object (Pageable)

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": [
    ],
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "first": true,
  • "last": true,
  • "empty": true
}

maintenance-vehicle-indicators-controller-v-02

getVehicleIndicatorsReport

path Parameters
vehicleId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getVehicleIndicatorsReport_1

path Parameters
vehicleId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

duty-report-controller-v-02

getDutyReportForDutyItemId_1 Deprecated

path Parameters
dutyItemId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

vehicle-parameter-value-get-vehicle-controller

getParameterValueForVehicle

path Parameters
organisationId
required
string <uuid>
vehicleId
required
string <uuid>
parameterId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "vehicleParameterId": "74f97355-5ca7-4ed1-97df-b01206485647",
  • "value": "string",
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "name": "string",
  • "description": "string"
}

telemetry-get-for-vehicle-v-01-controller

getTelemetry_1

path Parameters
organisationId
required
string <uuid>
vehicleId
required
string <uuid>
query Parameters
from
required
string <date-time>
to
required
string <date-time>

Responses

Response samples

Content type
application/json
{
  • "from": "2019-08-24T14:15:22Z",
  • "to": "2019-08-24T14:15:22Z",
  • "telemetries": [
    ]
}

vehicle-parameter-get-for-vehicle-controller

getParametersForVehicle

path Parameters
organisationId
required
string <uuid>
vehicleId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

vehicle-parameter-value-get-all-for-vehicle-controller

getParameterValuesForVehicle

path Parameters
organisationId
required
string <uuid>
vehicleId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

flight-recorder-controller

getEpisodes_1 Deprecated

query Parameters
required
object (Pageable)

Responses

Response samples

Content type
application/json
{
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ],
  • "number": 0,
  • "sort": [
    ],
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "first": true,
  • "last": true,
  • "empty": true
}

user-controller

getUser

path Parameters
userId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "phone": "string"
}

createUseIfNotExist

Responses

Response samples

Content type
application/json
{
  • "canDeleteAccount": true
}

vehicle-timeline-controller

getTimeLineForVehicle

path Parameters
vehicleId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

maintenance-vehicle-indicators-controller

getVehicleIndicatorsReport_2

path Parameters
vehicleId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getVehicleIndicatorsReport_3

path Parameters
vehicleId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

maintenance-report-controller

getWarnReport_2 Deprecated

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getExceedReport_2 Deprecated

Responses

Response samples

Content type
application/json
[
  • {
    }
]

maintenance-request-report-controller

getWarnReport_3 Deprecated

Responses

Response samples

Content type
application/json
{
  • "violations": [
    ],
  • "message": "string"
}

getExceedReport_3 Deprecated

Responses

Response samples

Content type
application/json
[
  • {
    }
]

grow-report-controller

getGrowReportForOrganisation

header Parameters
required
object (OrganisationId)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

duty-report-controller

getDutyReport Deprecated

path Parameters
dutyName
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

sign-up-controller

createUseIfNotExist_1 Deprecated

Responses

Response samples

Content type
application/json
{
  • "violations": [
    ],
  • "message": "string"
}

maintenances-for-organisation-controller-v-2

getMaintenancesForOrganisation_3 Deprecated

Responses

Response samples

Content type
application/json
[
  • {
    }
]

maintenance-item-vehicle-controller

getMaintenanceItems_1

path Parameters
vehicleId
required
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

invite-accept-controller

accept

path Parameters
invitationId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "organisationName": "string",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98"
}

estimation-controller

getEstimation

path Parameters
vehicleId
required
string <uuid>
query Parameters
date
string <date>

Responses

Response samples

Content type
application/json
{
  • "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  • "distance": 0,
  • "distanceUnit": "KILOMETER",
  • "dailyDistance": 0.1,
  • "status": "OK",
  • "errorMessage": "string"
}

dashboard-controller

getTotalSpeed

Responses

Response samples

Content type
application/json
{
  • "totalSpeed": 0.1
}

audit-controller

getAll_9

Responses

Response samples

Content type
application/json
[
  • {
    }
]

user-delete-controller

Delete all organisation for logged user

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.

Responses

Response samples

Content type
application/json
{
  • "organisations": [
    ]
}