Configuration
This service provides vehicle configuration information based on its unique identifier:
Vehicle name.
Detection mode configured (GPS, beacon, Bluetooth).
Creation date.
Status (active, deleted).
Beacon attributes (proximity UUID, major, minor) if a beacon is paired to the vehicle.
Beacon pairing date if a beacon is paired to the vehicle.
The Bluetooth attributes (mac address, name) if a Bluetooth device is paired to the vehicle.
Identifiers of the vehicle's owner (id, firstname, lastname).
If you have your admin API key, you can try the API via this link.
Vehicle configuration
GET
https://service.drivequant.com/v3/drivekit/admin/vehicles/{vehicleId}/configuration
Retrieve vehicle configuration 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 |
Response
The table below summarizes the list of vehicle configuration parameters.
Field | Type | Description |
---|---|---|
id |
| Vehicle unique id |
name |
| Vehicle name |
detectionMode |
| Vehicle detection mode (GPS, BEACON, BLUETOOTH, DISABLED) |
creationDate |
| Vehicle creation date |
status |
| Vehicle status (ACTIVE, DELETED) |
beaconIdentifier | Beacon identifier | |
beaconPairingDate |
| Beacon pairing date |
bluetoothIdentifier | Bluetooth identifier | |
user | User informations |
BeaconIdentifier
Field | Type | Description |
---|---|---|
proximityUuid |
| Beacon proximity UUID |
major |
| Beacon major |
minor |
| Beacon minor |
BluetoothIdentifier
Field | Type | Description |
---|---|---|
macAddress |
| Bluetooth device mac address |
name |
| Bluetooth device name |
User
Field | Type | Description |
---|---|---|
id |
| User unique identifier |
firstname |
| User firstname |
lastname |
| User lastname |
Last updated