Create
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.
Vehicle creation
POST
https://service.drivequant.com/v3/drivekit/admin/vehicle
Create a new vehicle belonging to your organisation.
Headers
Name | Type | Description |
---|---|---|
DriveKit-Admin-API-Key | string | Admin API Key |
Request Body
Name | Type | Description |
---|---|---|
username | string | Unique driver identifier |
beaconIdentifier | object | Parameters of the beacon linked to the vehicle |
vehicleId | string | Vehicle unique identifier |
vehicleCharacteristics | object | |
vehiclename | string | Vehicle name |
Request
beaconIdentifier
Field | Type | Description |
---|---|---|
major |
| Major |
minor |
| Minor |
proximityUuid |
| Proximity UUID |
uniqueId |
| Beacon unique identifier |
Example of JSON body request
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 support@drivequant.com |
4 | Beacon already used |
Last updated