LogoLogo
ProductsUse casesDocsSupport
  • Introducing DriveKit
  • DriveKit Guides
  • Get started with drivekit
    • Trip recording lifecycle
    • iOS
      • 🚀Quick start
      • Advanced configurations
      • References
      • iOS DriveKit Demo App
    • Android
      • 🚀Quick start
      • Advanced configurations
      • References
      • Android DriveKit Demo App
      • Android 15 Migration guide
      • Android 14 Migration guide
      • Troubleshooting
  • Trip analysis
    • Introduction
    • iOS
      • Permissions
      • Trip management
      • TripListener
      • Crash Detection
      • Beacon usage
      • Bluetooth usage
      • Custom metadata
      • References (iOS)
    • Android
      • Runtime permissions
      • Trip management
      • TripListener
      • Crash Detection
      • Beacon usage
      • Bluetooth usage
      • Custom metadata
      • References (Android)
    • User interface
      • iOS
        • Get started
        • Working hours
        • Driver alert in case of crash
        • Trip recording widget
        • Location sharing
      • Android
        • Get started
        • Working hours
        • Driver alert in case of crash
        • Trip recording widget
        • Location sharing
    • REST services
      • Trip
      • References
    • Trip Simulator
      • iOS
      • Android
  • PERMISSIONS UTILS
    • Introduction
    • User interface
      • iOS
        • Get started
        • Main configurations
      • Android
        • Get started
        • Main configurations
  • COMMON UI
    • Introduction
    • iOS
      • Get started
    • Android
      • Get started
    • References
  • DRIVER DATA
    • Introduction
    • iOS
      • Get started
      • References (iOS)
    • Android
      • Get started
      • References (Android)
    • User interface
      • iOS
        • Get started
        • Advanced configurations
        • Trips widgets
        • My Synthesis
        • My Driver Profile
      • Android
        • Get Started
        • Advanced configurations
        • Trips widgets
        • My Synthesis
        • My Driver Profile
  • Driver Data Timeline UI
    • Introduction
    • iOS
      • Get started
    • Android
      • Get started
  • Vehicle
    • Introduction
    • iOS
      • Get started
      • Vehicle management
      • Beacon management
      • Bluetooth device management
      • Odometer
      • References (iOS)
    • Android
      • Get started
      • Vehicle management
      • Beacon management
      • Bluetooth device management
      • Odometer
      • References (Android)
    • User interface
      • iOS
        • Get started
        • Main configurations
        • Advanced configurations
      • Android
        • Get started
        • Main configurations
        • Advanced configurations
  • DRIVER ACHIEVEMENT
    • Introduction
    • iOS
      • Get started
    • Android
      • Get Started
    • User interface
      • iOS
      • Android
  • CHALLENGE
    • Introduction
    • Important challenge rules
    • iOS
      • Get started
      • References (iOS)
    • Android
      • Get started
      • References (Android)
    • User interface
      • iOS
        • Get started
      • Android
        • Get started
  • GROUP
    • Introduction
    • iOS
      • Get started
    • Android
      • Get started
  • React Native
    • Get started
    • Integration
  • Flutter
    • Get started
    • Integration
  • Push services
    • Introduction
    • Push Trip Data
    • Push Deleted trip
    • Push Crash Data
    • Push Diagnosis Data
  • ADMIN SERVICES
    • Beacon
      • Add
      • Replace
      • Delete
      • Configuration
    • Challenges
      • List of challenges
      • Challenge details
      • Registered users
      • Challenge ranking
      • Users' progress
      • Definitions
    • Customer
      • Activity timeline
    • Driver
      • Timeline
      • Synthesis
      • Identity
      • Status
      • Add or update a metadata
      • Vehicles
      • Profile
      • Application diagnoses
    • Drivers
      • Account
      • Statistics
      • Ranking
      • Expired accounts
    • Group
      • Timeline
      • Synthesis
    • Trips
      • Add or update a metadata
      • Delete a metadata
    • Vehicle
      • Create
      • Characteristics
      • Configuration
      • Statistics
      • Update mileage
      • Tire and brake wear update
      • References
  • Crashes
    • Annotate a crash
    • Revoke crash location URL
  • ENTERPRISE SERVICES
    • Introduction
    • Teams
      • Create a team
      • List of teams
      • Enable or disable a team
    • Hyper-admins
      • Create a hyper-admin
      • List of hyper-admins
      • Delete a hyper-admin
    • Monitoring
      • Get a push trip data report
      • Get a push crash data report
      • Request to retry failed trips
      • Request to retry failed crashes
      • Get the status of a task
  • Release notes
    • Changelog
      • iOS
      • Android
      • UI iOS
      • UI Android
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. ADMIN SERVICES
  2. Beacon

Configuration

PreviousDeleteNextChallenges

Last updated 6 months ago

Was this helpful?

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 .

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 paired to the beacon (null if the beacon is not paired)

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

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

Vehicle
User
BeaconIdentifier
link

Get a beacon's configuration

get
Query parameters
proximityuuidstringRequired

Beacon proximity uuid

majorintegerRequired

Beacon major value

minorintegerRequired

Beacon minor value

Header parameters
DriveKit-Admin-API-KeystringRequired

DriveKit Admin API key

Responses
200
OK
application/json
401
Invalid API Key
application/json
404
Beacon Not Found
application/json
500
Failed to retrieve vehicle configuration
application/json
get
GET /v3/drivekit/admin/beacon/configuration HTTP/1.1
Host: service.drivequant.com
DriveKit-Admin-API-Key: text
Accept: */*
{
  "pairedStatus": "FREE",
  "vehicle": {
    "id": "text",
    "name": "text",
    "detectionMode": "DISABLED",
    "creationDate": "2025-05-29T16:03:05.189Z",
    "beaconIdentifier": {
      "proximityUuid": "text",
      "major": 1,
      "minor": 1
    },
    "beaconPairingDate": "2025-05-29T16:03:05.189Z"
  },
  "user": {
    "id": "text",
    "firstname": "text",
    "lastname": "text"
  }
}
  • GETGet a beacon's configuration
  • Parameters
  • Response
  • Vehicle
  • BeaconIdentifier
  • User