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

200

{
  "id": "vehicleId",
  "name": "vehicle name",
  "detectionMode": "BEACON",
  "creationDate": "2019-08-24T14:15:22.123+0200",
  "status": "ACTIVE",
  "beaconIdentifier": {
    "proximityUuid": "uuid",
    "major": 0,
    "minor": 0
  },
  "bluetoothIdentifier": {
    "macAddress": "mac address",
    "name": "name"
  },
  "beaconPairingDate": "2019-08-26T15:45:52.123+0200",
  "user": {
    "id": "userId",
    "firstname": "firstname",
    "lastname": "lastname"
  }
}

401

Invalid API key

404

Vehicle Not found

Response

The table below summarizes the list of vehicle configuration parameters.

Field	Type	Description
id	string	Vehicle unique id
name	string	Vehicle name
detectionMode	string	Vehicle detection mode (GPS, BEACON, BLUETOOTH, DISABLED)
creationDate	string	Vehicle creation date
status	string	Vehicle status (ACTIVE, DELETED)
beaconIdentifier	BeaconIdentifier	Beacon identifier
beaconPairingDate	string	Beacon pairing date
bluetoothIdentifier	BluetoothIdentifier	Bluetooth identifier
user	User	User informations

BeaconIdentifier

Field	Type	Description
proximityUuid	string	Beacon proximity UUID
major	int	Beacon major
minor	int	Beacon minor

BluetoothIdentifier

Field	Type	Description
macAddress	string	Bluetooth device mac address
name	string	Bluetooth device name

User

Field	Type	Description
id	string	User unique identifier
firstname	string	User firstname
lastname	string	User lastname