API docs by Redocly

OpenAPI definition (v0)

Download OpenAPI specification:Download

vehicle-controller

getVehicle Deprecated

path Parameters
vehicleId
required
string <uuid>

Responses

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
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
}

updateVehicleV1_2_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
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
}

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
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
}

getVehicles Deprecated

query Parameters
enabled
boolean
Default: true

Responses

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
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
}

createVehicleV12_1 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
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
}

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
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
}

vehicle-controller-v-13

getVehicle_1

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

Responses

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
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
}

getVehicles_1

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

Responses

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
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
}

maintenance-item-controller

updateMaintenanceItem_V1_1

Request Body schema: application/json
required
id
string <uuid>
name
string
description
string
type
string
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
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"
}

getMaintenanceItems

Responses

updateMaintenanceItem

Request Body schema: application/json
required
id
string <uuid>
name
string
description
string
type
string
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
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"
}

createMaintenanceItem

Request Body schema: application/json
required
id
string <uuid>
name
string
description
string
type
string
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
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"
}

getMaintenanceItem

path Parameters
itemId
required
string <uuid>

Responses

duty-item-controller-v-02

getDutyItem

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

Responses

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"
}

getDutyItems

path Parameters
organisationId
required
string <uuid>

Responses

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"
}

duty-controller-v-02

getDuty

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

Responses

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"
}

getDutiesForVehicle

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

Responses

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>
distanceType
string
Enum: "DISTANCE" "MAINTENANCE" "DUTY" "COUPLING"
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,
  • "distanceType": "DISTANCE",
  • "externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
  • "remarks": "string"
}

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>
distanceType
string
Enum: "DISTANCE" "MAINTENANCE" "DUTY" "COUPLING"
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,
  • "distanceType": "DISTANCE",
  • "externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
  • "remarks": "string"
}

getDistance

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

Responses

deleteDistance

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

Responses

getDistanceForVehicle

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

Responses

model-controller-v-02

updateModel

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": [
    ]
}

getModelsForBrand

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

Responses

createModel

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": [
    ]
}

getModel

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

Responses

destination-controller

getDestinationV02

path Parameters
destinationId
required
string <uuid>

Responses

updateDestinationV02

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": [
    ]
}

getDestination Deprecated

path Parameters
destinationId
required
string <uuid>

Responses

updateDestination 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
}

getDutiesForOrganisationV02

Responses

createDestinationV02

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": [
    ]
}

getDutiesForOrganisation Deprecated

Responses

createDestination 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
}

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"
}

vehicle-parameter-get-for-organisation-controller

getParameter_1

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

Responses

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
object (OrganisationId)
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": { },
  • "name": "string",
  • "description": "string"
}

organisation-controller

getOrganisation

path Parameters
organisationId
required
string <uuid>

Responses

updateOrganisationForUser

path Parameters
organisationId
required
string <uuid>
Request Body schema: application/json
required
id
object (OrganisationId)
name
string
type
string
Enum: "PRIVATE" "CORPORATE"

Responses

Request samples

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

getCurrentOrganisationForUser

Responses

setCurrentOrganisationForUser

Request Body schema: application/json
required
id
object (OrganisationId)
name
string
type
string
Enum: "PRIVATE" "CORPORATE"

Responses

Request samples

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

createOrganisationForUserV02

Request Body schema: application/json
required
id
object (OrganisationId)
name
string
type
string
Enum: "PRIVATE" "CORPORATE"

Responses

Request samples

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

getUserOrganisations

Responses

createOrganisationForUser Deprecated

Request Body schema: application/json
required
id
object (OrganisationId)
name
string
type
string
Enum: "PRIVATE" "CORPORATE"

Responses

Request samples

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

member-controller

getOrganisationMembers_1

Responses

updateMember

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
}

getOrganisationMembers

path Parameters
userId
required
string <uuid>

Responses

getMyPrivilegeInOrganisation

Responses

type-controller

getBrand

path Parameters
typeId
required
string <uuid>

Responses

updateType

path Parameters
typeId
required
string <uuid>
Request Body schema: application/json
required
id
string <uuid>
name
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
}

getTypes

Responses

createType

Request Body schema: application/json
required
id
string <uuid>
name
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
}

maintenance-controller

getMaintenanceById

path Parameters
maintenanceId
required
string <uuid>

Responses

updateMaintenanceForVehicle

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

Responses

deleteMaintenance

path Parameters
maintenanceId
required
string <uuid>

Responses

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>
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,
  • "remarks": "string",
  • "image": "string"
}

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>
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,
  • "remarks": "string",
  • "image": "string"
}

findAllMaintenanceForVehicle

path Parameters
vehicleId
required
string <uuid>

Responses

createMaintenanceForVehicle

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

Responses

getImageForMaintenance

path Parameters
maintenanceId
required
string <uuid>

Responses

getMaintenancesForOrganisation_3 Deprecated

Responses

maintenance-request-controller

getMaintenanceRequest

path Parameters
maintenanceRequestId
required
string <uuid>

Responses

updateMaintenanceRequest

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

Responses

updateMaintenanceRequestNoImage

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
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"
}

getAllMaintenanceRequestForVehicle

path Parameters
vehicleId
required
string <uuid>

Responses

createMaintenanceRequest

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

Responses

createMaintenanceRequestNoImage

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
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"
}

getAllMaintenanceRequest

Responses

getImageForMaintenance_1

path Parameters
maintenanceRequestId
required
string <uuid>

Responses

duty-item-controller

getDutyItem_1

path Parameters
dutyItemId
required
string <uuid>

Responses

updateDutyItem_1

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"
}

getDutyItems_1

Responses

addDutyItem_1

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

Responses

Request samples

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

duty-controller

getDuty_1 Deprecated

path Parameters
dutyId
required
string <uuid>

Responses

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"
}

getDutiesForVehicle_1 Deprecated

path Parameters
vehicleId
required
string <uuid>

Responses

distance-controller

updateDistance_1

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>
distanceType
string
Enum: "DISTANCE" "MAINTENANCE" "DUTY" "COUPLING"
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,
  • "distanceType": "DISTANCE",
  • "externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
  • "remarks": "string"
}

createDistance_1

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>
distanceType
string
Enum: "DISTANCE" "MAINTENANCE" "DUTY" "COUPLING"
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,
  • "distanceType": "DISTANCE",
  • "externalId": "3200d382-adfe-4314-ab30-798cdd0fcdb5",
  • "remarks": "string"
}

getDistance_1

path Parameters
distanceId
required
object (DistanceId)

Responses

deleteDistance_1

path Parameters
distanceId
required
object (DistanceId)

Responses

getDistanceForVehicle_1

path Parameters
vehicleId
required
string <uuid>

Responses

coupling-controller

getCoupling

path Parameters
couplingId
required
string <uuid>

Responses

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"
}

getCouplings

Responses

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"
}

getCouplingForVehicle

path Parameters
vehicleId
required
string <uuid>

Responses

getCoupleableTrailers

Responses

brand-controller

getBrand_1

path Parameters
brandId
required
string <uuid>

Responses

updateBrand

path Parameters
brandId
required
string <uuid>
Request Body schema: application/json
required
brandId
string <uuid>
name
required
string
Array of objects (ModelResponse)

Responses

Request samples

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

getBrands

Responses

createBrand

Request Body schema: application/json
required
brandId
string <uuid>
name
required
string
Array of objects (ModelResponse)

Responses

Request samples

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

model-controller

updateModel_1

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": [
    ]
}

getModelsForBrand_1

path Parameters
brandId
required
string <uuid>

Responses

createModel_1

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": [
    ]
}

getModel_1

path Parameters
modelId
required
string <uuid>

Responses

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

getParameter

path Parameters
organisationId
required
string <uuid>

Responses

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
object (OrganisationId)
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": { },
  • "name": "string",
  • "description": "string"
}

invite-controller

getInvitations

Responses

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"
}

getInvitation

path Parameters
invitationId
required
string <uuid>

Responses

deleteInvitation

path Parameters
invitationId
required
string <uuid>

Responses

maintenances-for-organisation-controller-v-22

getMaintenancesForOrganisation

path Parameters
organisationId
required
string <uuid>

Responses

maintenances-for-organisation-controller-v-21

getMaintenancesForOrganisation_1 Deprecated

Responses

duty-report-controller-v-03

getDutyReportForDutyItemId

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

Responses

maintenance-report-controller-v-02

getWarnReport

path Parameters
organisationId
required
string <uuid>

Responses

getExceedReport

path Parameters
organisationId
required
string <uuid>

Responses

maintenance-request-report-controller-v-02

getWarnReport_1

path Parameters
organisationId
required
string <uuid>

Responses

getExceedReport_1

path Parameters
organisationId
required
string <uuid>

Responses

flight-recorder-controller-v-02

getEpisodes

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

Responses

duty-report-controller-v-02

getDutyReportForDutyItemId_1 Deprecated

path Parameters
dutyItemId
required
string <uuid>

Responses

vehicle-parameter-value-get-vehicle-controller

getParameterValueForVehicle

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

Responses

vehicle-parameter-get-for-vehicle-controller

getParametersForVehicle

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

Responses

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

getParameterValuesForVehicle

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

Responses

flight-recorder-controller

getEpisodes_1 Deprecated

query Parameters
required
object (Pageable)

Responses

user-controller

getUser

path Parameters
userId
required
string <uuid>

Responses

createUseIfNotExist

Responses

deleteUserAndPrivateOrganisation

Responses

vehicle-timeline-controller

getTimeLineForVehicle

path Parameters
vehicleId
required
string <uuid>

Responses

maintenance-vehicle-indicators-controller

getVehicleIndicatorsReport

path Parameters
vehicleId
required
string <uuid>

Responses

maintenance-report-controller

getWarnReport_2 Deprecated

Responses

getExceedReport_2 Deprecated

Responses

maintenance-request-report-controller

getWarnReport_3 Deprecated

Responses

getExceedReport_3 Deprecated

Responses

duty-report-controller

getDutyReport Deprecated

path Parameters
dutyName
required
string

Responses

sign-up-controller

createUseIfNotExist_1 Deprecated

Responses

maintenances-for-organisation-controller-v-2

getMaintenancesForOrganisation_2 Deprecated

Responses

maintenance-item-vehicle-controller

getMaintenanceItems_1

path Parameters
vehicleId
required
string <uuid>

Responses

estimation-controller

getEstimation

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

Responses

dashboard-controller

getTotalSpeed

Responses

audit-controller

getAll

Responses