All pages
Powered by GitBook
1 of 8

Vehicle

DriveQuant services evaluate driver behaviour and the impact of driving style on the vehicle. The data returned to drivers are mostly driver scores. Vehicle data include the total distance and the evolution of tire and brake wear.

A set of services allow to manage your fleet. In this section, you will find information to answer the following questions:

  • How to create a new vehicle?

  • How to set or to initialize distances and wear levels for tires and brakes?

  • How to set the vehicle distance?

  • How to retrieve the vehicle’s main statistics?

Create

Vehicle creation

POST https://service.drivequant.com/v3/drivekit/admin/vehicle

Create a new vehicle belonging to your organisation.

Headers

Request Body

Request

beaconIdentifier

Example of JSON body request

Error codes

ErrorCode
Comment

0

Success

1

Invalid characteristics

2

The vehicle unique identifier already exists

3

4

Beacon already used

Characteristics

For each vehicle in your fleet, you can access to technical characteristics set when you create a vehicle or retrieved in DriveQuant vehicle database:

  • Brand, model and version of the vehicle

  • Engine configuration

  • Consumption data

  • Gearbox configuration

  • Vehicle dimensions

  • Tyre dimensions

If you have your admin API key, you can try the API via this link.

Vehicle characteristics

GET https://service.drivequant.com/v3/drivekit/admin/vehicles/{vehicleId}/characteristics

Retrieve vehicle characteristics using the vehicle unique identifier.

Path Parameters

Name
Type
Description

vehicleId*

string

Vehicle unique identifier

Headers

Name
Type
Description

DriveKit-Admin-API-Key*

string

Admin API Key

{
  "brand": "Bmw",
  "model": "Serie 1 F21 M 3 Portes",
  "version": "(F21) (2) 140I M PERFORMANCE 3P",
  "year": "2016",
  "typeIndex": 2,
  "engineIndex": 1,
  "power": 340,
  "mass": 1520,
  "engineDisplacement": 2998,
  "gearboxIndex": 3,
  "consumption": 7.8,
  "autoGearboxNumber": 0,
  "frontTireSize": "225/40/18",
  "rearTireSize": "245/35/18",
  "length": 4.32,
  "width": 1.76,
  "height": 1.42,
  "engineCylinderNb": 6,
  "driveWheels": 1
}
Unauthorized
Vehicle Not found

Response

Description of each vehicle characteristics is available here.

Loading...

Loading...

Update mileage

Once a vehicle is declared, the distances of all trips are aggregated to calculate the total analyzed distance.

If the vehicle has already been driven before it has been registered on the platform, there will be an offset between the vehicle odometer and the total analyzed distance (computed by DriveQuant services).

If you find an offset between the vehicle's odometer and the total analyzed distance, you can set vehicle mileage.

The vehicle mileage value is updated :

  1. Every time a trip is analyzed.

  2. Each time the odometer update API is used.

If you have your admin API key, you can try the API via this link.

Vehicle mileage update

PUT https://service.drivequant.com/v3/drivekit/admin/vehicles/{vehicleId}/distance

Update the vehicle mileage unsing the vehicle unique identifier.

Path Parameters

Name
Type
Description

vehicleId

string

Vehicle unique identifier

Headers

Name
Type
Description

DriveKit-Admin-API-Key

string

Admin API Key

Request Body

Name
Type
Description

distance

number

Vehicle odometer reading in kilometer

{
  "analyzedDistance": 4589,
  "creationDate": "2020-01-10T10:00:00.125+0200",
  "distance": 10052,
  "offsetDistance": 5463
}
Not Found
Unprocessable Entity

Tire and brake wear update

The tire and brake wear estimator returns the level of wear expressed in percent and the autonomy in kilometer.

It is possible to update the distance and the wear percentage based on observations made by a mechanic or during a technical inspection or a maintenance intervention on the vehicle.

In the case of a replacement, the distance and the wear must be set back to 0 km and 0% for the new component.

If you have your admin API key, you can try the API via this link.

Wear value update

PUT https://service.drivequant.com/v3/drivekit/admin/vehicles/{vehicleId}/wear

Update the front/rear tire and brake wear values using the vehicle unique identifier.

Path Parameters

Name
Type
Description

vehicleId

string

Vehicle unique identifier

Headers

Name
Type
Description

DriveKit-Admin-API-Key

string

Admin API Key

Request Body

Name
Type
Description

component

integer

Component to update

drive

integer

Drivetrain of the component

wear

number

Level of wear in %

distance

number

Component distance in kilometer

{
  "analyzedDistance": 93,
  "creationDate": "2018-09-10T10:00:00.125+0200",
  "distance": 102,
  "offsetDistance": 9
}
Unprocessable Entity

Request

updateVehicleWearRequest

Field
Type
Description

component

int

Component considered for the update:

(1) Tires

(2) Brakes

drive

int

Drivetrain considered for the update:

(1) Front drive

(2) Rear drive

wear

double

Level of wear observed for the considered component.

This value is in percent (min. = 0% / max. = 100%)

distance

double

Distance traveled with the component in kilometer

min. = 0 km / max. = 300 000 km

  • The date of the recalibration is equal to the date of the request.

  • The parameters wear and distance are mandatory.

  • A component replacement is declared with wearPct = 0 % and declaredDistance = 0 km.

  • If the component is replaced, all synthesis data will be reset automatically.

  • It is not possible to reset the front and rear axle components at the same time. It is necessary to make two separated requests.

Example of JSON body request

To declare that the front tires of the vehicle have a wear level of 40% after 14,000 km, the body of the request is as follows:

{
  "component": 1,
  "distance": 14000,
  "drive": 1,
  "wear": 40
}

To declare that the rear brakes of the vehicle have just been changed, the body of the request must be as shown below:

{
  "component": 2,
  "distance": 0,
  "drive": 2,
  "wear": 0
}

References

VehicleCharacteristics

Vehicle body type

Engine type

Gearbox type

Drive wheels type