# 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).

{% hint style="info" %}
If you have your **admin API key**, you can try the API via this [**link**](https://drivequant.stoplight.io/docs/drivequant-public/f58f397da4c2b-get-vehicle-configuration).
{% endhint %}

## GET /drivekit/admin/vehicles/{vehicleId}/configuration

> Get vehicle configuration

```json
{"openapi":"3.0.3","info":{"title":"DKAdminVehiclesV3","version":"1.0"},"servers":[{"url":"https://service.drivequant.com/v3","description":"Prod"}],"security":[{"api-key":[]}],"components":{"securitySchemes":{"api-key":{"name":"DriveKit-Admin-API-Key","type":"apiKey","in":"header"}},"schemas":{"ErrorResponse":{"title":"ErrorResponse","type":"object","properties":{"message":{"type":"string"},"code":{"type":"integer"},"messageKey":{"type":"string"}}}}},"paths":{"/drivekit/admin/vehicles/{vehicleId}/configuration":{"get":{"summary":"Get vehicle configuration","tags":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Vehicle unique id"},"name":{"type":"string","description":"Vehicle name"},"detectionMode":{"type":"string","enum":["DISABLED","GPS","BEACON","BLUETOOTH"],"description":"Detection mode"},"creationDate":{"type":"string","description":"Creation date","format":"date-time"},"status":{"type":"string","description":"Vehicle status (active or deleted)","enum":["ACTIVE","DELETED"]},"beaconIdentifier":{"type":"object","description":"Beacon paired to the vehicle. This field might return null if there is no beacon paired with the vehicle","properties":{"proximityUuid":{"type":"string","description":"Beacon proximity UUID (Universally Unique IDentifier)"},"major":{"type":"integer","description":"Beacon major"},"minor":{"type":"integer","description":"Beacon minor"}}},"bluetoothIdentifier":{"type":"object","description":"Bluetooth device attached to the vehicle","properties":{"macAddress":{"type":"string","description":"MAC Adress of the Bluetooth device"},"name":{"type":"string","description":"Public name of the Bluetooth device"}}},"beaconPairingDate":{"type":"string","format":"date-time","description":"Beacon pairing date"},"user":{"type":"object","description":"Owner of the vehicle. This field might return null if no driver is attached to the vehicle","properties":{"id":{"type":"string","description":"Unique identifier of the user to whom the vehicle is attached"},"firstname":{"type":"string","description":"User firstname"},"lastname":{"type":"string","description":"User lastname"}}}}}}}},"401":{"description":"Invalid API key"},"404":{"description":"Vehicle Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"operationId":"get-drivekit-admin-vehicles-vehicleId","parameters":[{"schema":{"type":"string"},"in":"header","name":"DriveKit-Admin-API-Key","required":true,"description":"DrveKit Admin API key"}],"description":""}}}}
```

## Response

The table below summarizes the list of vehicle configuration parameters.

<table><thead><tr><th width="194">Field</th><th width="184.34375">Type</th><th>Description</th></tr></thead><tbody><tr><td>id</td><td><code>string</code></td><td>Vehicle unique id</td></tr><tr><td>name</td><td><code>string</code></td><td>Vehicle name</td></tr><tr><td>detectionMode</td><td><code>string</code></td><td><p>Vehicle detection mode</p><p><em>Allowed values: <code>GPS</code>, <code>BEACON</code>, BLUETOOTH, <code>DISABLED</code></em></p></td></tr><tr><td>creationDate</td><td><code>string</code></td><td>Vehicle creation date</td></tr><tr><td>status</td><td><code>string</code></td><td><p>Vehicle status</p><p><em>Allowed values: <code>ACTIVE</code>, <code>DELETED</code></em></p></td></tr><tr><td>beaconIdentifier</td><td><a href="#beaconidentifier">BeaconIdentifier</a></td><td>Beacon identifier</td></tr><tr><td>beaconPairingDate</td><td><code>string</code></td><td>Beacon pairing date</td></tr><tr><td>bluetoothIdentifier</td><td><a href="#bluetoothidentifier">BluetoothIdentifier</a></td><td>Bluetooth identifier</td></tr><tr><td>user</td><td><a href="#user">User</a></td><td>User informations</td></tr></tbody></table>

### 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          |