Create a vehicle

This API must be used to create a new vehicle that will belong to your organization. After the vehicle is created, you can add the vehicleId in the trip API request to get the trip scores and data described in the trip analysis section.
We recommend to add a vehicle before requesting the trip analysis service if you need to monitor the vehicle. For each request, the unique vehicle identifier must be added in the trip analysis request.
If you have your admin API key, you can try the API via this link.
post
https://service.drivequant.com/
v3/drivekit/admin/vehicle
Vehicle creation
Request
vehiculeCharacteristics
Field
Type
Description
brand
string
Vehicle brand
model
string
Vehicle model
version
double
Model version
year
double
Vehicle year
typeIndex
int
​Vehicle body type​
engineIndex
int
​Engine type​
power
double
Vehicle power in hp. This value must be entered in horsepower. In case you only have the engine power in kW you can apply the following formula: P [hp] = P [kW] / 0.7355
mass
double
Vehicle mass in kg
engineDisplacement
double
Engine displacement in liters
gearboxIndex
int
​Gearbox type​
autoGearboxNumber
int
Number of gear ratios for the automatic gearbox. This parameter is taken into account only if carGearboxIndex is set to 1
consumption
double
Combined fuel consumption [l/100km] measured during the New European Driving Cycle (NEDC)
frontTireSize
string
Front tire size
rearTireSize
string
Rear tire size
length
double
Vehicle length in meter
width
double
Vehicle width in meter
height
double
Vehicle height in meter
driveWheels
int
​Drive wheels type​
engineCylinderNb
int
Number of cylinders
beaconIdentifier
Field
Type
Description
major
int
Major
minor
int
Minor
proximityUuid
string
Proximity UUID
uniqueId
string
Beacon unique identifier
Example of JSON body request
1
{
2
	"vehiclename": "My car",
3
	"vehicleId": "<UNIQUE VEHICLE ID>",
4
	"vehicleCharacteristics": {
5
     	 "brand": "Renault",
6
        "model": "Clio 5",
7
        "version": "V 1.0 SCE 65 LIFE",
8
        "year": "2020",
9
    	  "typeIndex": 2,
10
        "engineIndex": 4,
11
        "power": 65.0,
12
        "mass": 1137.0,
13
        "engineDisplacement": 1.0,
14
        "gearboxIndex": 1,
15
        "consumption": 4.82,
16
        "autoGearboxNumber": 0, 
17
        "frontTireSize": "185/65/15",
18
        "rearTireSize": "185/65/15",
19
        "length": 4.05,
20
        "width": 1.79,
21
        "height": 1.44,
22
        "driveWheels": 0,
23
        "engineCylinderNb": 3
24
	},
25
	"username": "<UNIQUE DRIVER ID>"	
26
}
Copied!
Error codes
ErrorCode
Comment
0
Success
1
Invalid characteristics
2
The vehicle unique identifier already exists
3
Server error. In this case, we recommend that you try again. If the error persists, please contact [email protected]​
4
Beacon already used

REST SERVICES - Previous

Vehicle

Vehicle statistics

Last modified 5mo ago

Export as PDF

Copy link

Contents

post

Vehicle creation

Request

vehiculeCharacteristics

beaconIdentifier

Example of JSON body request

Error codes