Configuration

This service provides beacon configuration information based on its identifiers

• Beacon status (paired, available)

• Vehicle to which beacon is paired

  • Vehicle's unique identifier

  • Name

  • Detection mode (BEACON)

  • Creation date

  • Beacon identifiers

  • Beacon pairing date

• Identifiers of the vehicle's owner (id, firstname, lastname).

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

Get a beacon's configuration

GEThttps://service.drivequant.com/v3/drivekit/admin/beacon/configuration

Query parameters

Header parameters

Response

200401404500

OK

Body

application/json

pairedStatus*enum

FREEPAIRED

vehicleobject

null if there is no vehicle paired to the beacon

userobject

Request

JavaScriptCurlPython

const response = await fetch('https://service.drivequant.com/v3/drivekit/admin/beacon/configuration?proximityuuid=text', {
    method: 'GET',
    headers: {
      "DriveKit-Admin-API-Key": "text"
    },
});
const data = await response.json();

Response

200401404500

{
  "pairedStatus": "FREE",
  "vehicle": {
    "id": "text",
    "name": "text",
    "detectionMode": "DISABLED",
    "creationDate": "2024-11-21T06:23:31.062Z",
    "beaconIdentifier": {
      "proximityUuid": "text"
    },
    "beaconPairingDate": "2024-11-21T06:23:31.062Z"
  },
  "user": {
    "id": "text",
    "firstname": "text",
    "lastname": "text"
  }
}

Parameters

The table below summarizes the list of query parameters.

Field	Type	Description	Required ?
proximityuuid	string	Beacon proximity UUID	yes
major	int	Beacon major	yes
minor	int	Beacon minor	yes

Response

The table below summarizes the list of beacon configuration parameters.

Field	Type	Description
pairedStatus	string	Beacon paired status Allowed values: PAIRED, FREE
vehicle	Vehicle	Vehicle paired to the beacon (null if the beacon is not paired)
user	User	User informations

Vehicle

Field	Type	Description
id	string	Vehicle unique identifier
name	string	Vehicle name
detectionMode	string	Detection mode Allowed values: DISABLED, GPS, BEACON, BLUETOOTH
creationDate	date	Creation date Date format: YYYY-MM-dd’T’HH:mm:ss.SSSZ
beaconIdentifier	BeaconIdentifier	Beacon paired to the vehicle
beaconPairingDate	date	Beacon pairing date

BeaconIdentifier

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

User

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