Public API (0.0.1)

Download OpenAPI specification:

DKV Live API Support: support@live.dkv-mobility.com URL: https://www.dkv-mobility.com/en/digital-products/dkv-live/

Technical documentation of the DKVLive Public API.

Conventions for all paths and operations

Every operation may return a 500 Internal Server Error response.
- Every operation with a security tag may return a 401 Unauthorized response if the access token is missing or invalid.
- Every operation with a security tag may return a 403 Forbidden response if the user has no permission to access the resource.

Telemetry Data Management

Operations regarding telemetry data

Returns gps data for a vehicle

List GNSS and FMS data by vehicle ID in the given time interval with the given resolution The admissible time resolution is:

10 s for time intervals ≤ 24 h
60 s for time intervals ≤ 7 days
5 min or 10 min for time intervals ≤ 1 month

Required permission

view_vehicle_trace (organization, division)

Authorizations:

bearerAuth

path Parameters

organizationId required	integer <int64> Organization ID
vehicleId required	integer <int64> Vehicle ID

query Parameters

filter required	string Example: filter=[{"f":"timestamp","o":"gte","v":"2022-01-19T23:00:00Z"},{"f":"timestamp","o":"lte","v":"2022-01-25T23:00:00Z"},{"f":"resolution","o":"eq","v":"600"}] Filters the results based on the given field names. A typical filter is structured like: `[ { "f": "field_name", "o": "operator", // eq, not, gt, gte, lt, lte, in, contains, startsWith "s": "separator", // if left empty a comma "," is used as separator "v": "value", // single value, multi value separated by separator } ]` Filtering is required, and must be done by: resolution (eq): resolution is of type integer and in seconds; admissible values are 10, 60, 300, 600 timestamp (lte, gte): string of format date-time according to the RFC3339 standard; must provide two values, one with lte operator (end time), and one with gte (start time). The maximum admissible interval is 1 month.
showTotal	boolean Defines if the return parameter total is included.
offset	integer Defines what is the offset from the first result.
pageSize	integer Defines how many results are returned.

Responses

Response samples

200
400
404

Content type

application/json

{"messages": [{"severity": "string",
"title": "string",
"body": "string",
"params": ["string"
]
}
],
"pagination": {"totalUnfiltered": 0,
"total": 0,
"pageSize": 0
},
"payload": [{"timestamp": "2019-08-24T14:15:22Z",
"latitude": 23.98437,
"longitude": 41.92744,
"gpsSpeed": 50.21,
"altitude": 321.5,
"inclination": 5.5
}
]
}

Vehicle Management

Operations regarding vehicles

Returns all vehicles.

Authorizations:

bearerAuth

path Parameters

organizationId

required

integer <int64>

Organization ID

query Parameters

showTotal	boolean Defines if the return parameter total is included.
offset	integer Defines what is the offset from the first result.
pageSize	integer Defines how many results are returned.
search	string The field is used for free text search by licensePlate, VIN, vehicle name and model (by prefix).
filter	string Example: filter=[{"o":"or","i":[{"f":"trailerable","o":"eq","v":"1"},{"f":"trailerable","o":"nex"}]}, {"f":"productionDate","o" :"gte","v":"2021-10-15T12:30:00Z"}, {"f":"productionDate","o" :"lte","v":"2023-10-05T15:20:30Z"}, {"f":"hasFuelCard","o":"eq","v":"0"}] Filters the results based on the given field names. A typical filter is structured like: `[ { "f": "field_name", "o": "operator", // eq, not, gt, gte, lt, lte, in, contains, startsWith "s": "separator", // if left empty a comma "," is used as separator "v": "value", // single value, multi value separated by separator } ]` Filtering is allowed by: vehicleId (eq, in) `uint` divisionId (eq, in) `uint` productionDate (gte, gt, lte, lt) `date-time according to the RFC3339 standard` weightClassification (eq, in) `string(s)` pollutantCategory (eq, in) `string(s)` trailerable (eq, in, ex, nex) `string(s) bool(1,0) or null` name (eq, in, contains) `string(s)` licensePlate (eq, in, contains) `string(s)` fuelType (eq, in) `string(s)` vehicleType (eq, in) `string(s)` fuelCapacity (gte, gt, lte, lt) `uint` status (eq, in) `string(s)` registrationCountry (eq, in, contains) `string(s)` createdAt (gte, lte) `date-time according to the RFC3339 standard` hasFuelCard (eq) `bool(1,0)`
sort	string Example: sort=-vin,brand Sorts the results based on the given field names. If the field name is given, the results are sorted by given field name in ascending order. Adding a minus in front of the field name, the results are ordered in descending order. Sorting of the results is allowed by: productionDate registrationCountry licensePlate vin name divisionName brand vehicleType weightClassification pollutantCategory trailerable fuelType fuelCapacity permissibleTotalWeight numberOfAxles createdAt updatedAt hasDevice

Responses

Response samples

200
400
404

Content type

application/json

{"messages": [{"severity": "string",
"title": "string",
"body": "string",
"params": ["string"
]
}
],
"pagination": {"totalUnfiltered": 0,
"total": 0,
"pageSize": 0
},
"payload": [{"divisionId": 0,
"name": "string",
"licensePlate": "string",
"registrationCountry": "string",
"permissibleTotalWeight": 60000,
"vin": "stringstringstrin",
"vehicleType": "bus",
"vehicleBodyType": "box",
"trailerable": true,
"mileage": 0,
"engineHours": 0,
"brand": "Alfa Romeo",
"model": "string",
"productionDate": "2019-08-24T14:15:22Z",
"weightClassification": "n1",
"height": 99999,
"length": 99999,
"width": 99999,
"numberOfAxles": 0,
"fuelType": "diesel",
"fuelCapacity": 2000,
"pollutantCategory": "euro_1",
"status": "active",
"id": 0,
"organizationId": 0,
"online": true,
"createdAt": "string",
"createdBy": 0,
"updatedAt": "string",
"updatedBy": 0,
"version": 0,
"divisionName": "string",
"hasDevice": true
}
]
}