Vehicles

This service is designed to retrieve the vehicles linked to a user's account and the vehicle configuration parameters.

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

User vehicles

GET https://service.drivequant.com/v3/drivekit/admin/drivers/{userId}/vehicles

Get all vehicles configured by the user

Path Parameters

Name	Type	Description
userId*	String	User unique identifier

Headers

Name	Type	Description
DriveKit-Admin-API-Key *	String	Admin API key

200: OK

{
  "id": "vehicleId",
  "name": "vehicle name",
  "detectionMode": "BEACON",
  "creationDate": "2019-08-24T14:15:22Z",
  "status": "ACTIVE",
  "beaconIdentifier": {
    "proximityUuid": "uuid",
    "major": 0,
    "minor": 0
  },
  "bluetoothIdentifier": {
    "macAddress": "bluetooth mac address",
    "name": "bluetooth name"
  },
  "beaconPairingDate": "2019-08-24T14:15:22Z"
}

401: Unauthorized

Invalid API key

404: Not Found

User not found

Response

The table below summarizes the list of vehicle configuration parameters.

Field	Type	Description
id	string	Vehicle unique identifier
name	string	Vehicle name
detectionMode	string	Vehicle detection mode. Possible values are: GPS, BEACON, BLUETOOTH, DISABLED
creationDate	string	Vehicle creation date
status	string	ACTIVE or DELETED
beaconIdentifier	BeaconIdentifier	Beacon identifier
beaconPairingDate	string	Beacon pairing date
bluetoothIdentifier	BluetoothIdentifier	Bluetooth identifier

BeaconIdentifier

Field	Type	Description
proximityUuid	string	beacon proximity uuid
major	int	beacon major
minor	int	beacon minor

BluetoothIdentifier

Field	Type	Description
macAddress	string	Mac address of the Bluetooth device
name	string	Name of the Bluetooth device