# References (Android)
## Vehicle
| Field | Type | Description |
| ------------------ | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| vehicleId | String | Unique identifier of the vehicle |
| name | String? | Name of the vehicle
Default value: null
|
| brand | String? | Vehicle brand
Default value: null
|
| model | String? | Vehicle model
Default value: null
|
| version | String? | Model version
Default value: null
|
| year | String? | Year version of the vehicle
Default value: “0”
|
| typeIndex | Int | Vehicle body type.
Possible values are listed in TypeIndex.
Default value : -1
|
| engineIndex | Int | Engine type. Possible values are listed here.
Default value : -1
|
| power | Double | Vehicle power \[ hp ]. This value must be entered in horsepower. In case you only have the engine power in kW you can apply the following formula:
P \[ hp ] = P \[ kW ] / 0.7355
Min: 40 hp
Max: 450 hp
Default value : -1
|
| mass | Double | Vehicle mass \[ kg ]
Min: 700 kg
Max: 3500 kg
Default value : -1
|
| engineDisplacement | Double | Engine displacement in liter
Default value : -1
|
| gearboxIndex | Int | Gearbox type. Possible values are listed here.
Default value : -1
|
| autoGearboxNumber | Int | Number of gear ratios for the automatic gearbox. This parameter is taken into account only if « carGearboxIndex » is set to 1.
Default value : -1
|
| consumption | Float | Combined fuel consumption \[l/100km] measured during the New European Driving Cycle (NEDC).
Min: 3 l/100km
Max: 20 l/100km
Default value : -1
|
| frontTireSize | String? | Front tire size
Default value : null
|
| rearTireSize | String? | Rear tire size
Default value : null
|
| length | Double | Vehicle’s length in meter
Default value : -1
|
| width | Double | Vehicle’s width in meter
Default value : -1
|
| height | Double | Vehicle’s height in meter
Default value : -1
|
| driveWheels | Int | Number of wheels of the vehicle. Possible values are listed here.
Default value : -1
|
| engineCylinderNb | Int | Number of cylinders
Default value : -1
|
| dqIndex | String? | DriveQuant vehicle index reference
Default value: null
|
| detectionMode | [DetectionMode](#detectionmode) | Detection mode for the vehicle.
Default value: DISABLED
|
| liteConfig | Boolean | Only for advanced configuration. This parameter is usually set to `false`. |
| ptac | Double? | Total permissible laden weight in kg of the vehicle if its a truck.
Default value : -1
|
| extraData | Map\ | Only for advanced configuration. Map intended for adding some additional information for the vehicle. |
| beacon | [Beacon](#beacon)? | Beacon paired to the vehicle.
Default value : null
|
| bluetooth | [Bluetooth](#bluetooth)? | Bluetooth device paired to the vehicle.
Default value : null
|
{% hint style="info" %}
If your vehicle has a characteristic value to `-1`, DriveQuant servers will use default values to analyze your trip.
{% endhint %}
## VehicleBaseCharacteristics
See [Vehicle](#vehicle) for corresponding fields.
## CarCharacteristics
| Field | Type | Description |
| ----- | --------------------------------------------------------- | -------------------------- |
| base | [VehicleBaseCharacteristics](#vehiclebasecharacteristics) | Characteristics of the car |
## TruckCharacteristics
| Field | Type | Description |
| ----- | --------------------------------------------------------- | ------------------------------------------------- |
| base | [VehicleBaseCharacteristics](#vehiclebasecharacteristics) | Characteristics of the truck |
| ptac | Double | Total permissible laden weight in kg of the truck |
## TypeIndex
| Value | Is car? | Is truck? | Corresponding vehicle category |
|---|
| 1 | ✅ | ❌ | MICRO |
| 1 | ✅ | ❌ | COMPACT |
| 2 | ✅ | ❌ | SEDAN |
| 6 | ✅ | ❌ | SUV |
| 5 | ✅ | ❌ | MINIVAN |
| 9 | ✅ | ❌ | COMMERCIAL |
| 3 | ✅ | ❌ | LUXURY |
| 7 | ✅ | ❌ | SPORT |
| 200 | ❌ | ✅ | TWO_AXLES_STRAIGHT_TRUCK |
| 201 | ❌ | ✅ | THREE_AXLES_STRAIGHT_TRUCK |
| 202 | ❌ | ✅ | FOUR_AXLES_STRAIGHT_TRUCK |
| 203 | ❌ | ✅ | TWO_AXLES_TRACTOR |
| 204 | ❌ | ✅ | THREE_AXLES_TRACTOR |
| 205 | ❌ | ✅ | FOUR_AXLES_TRACTOR |
## DetectionMode
| Value | Description |
|---|
| DISABLED | The vehicle is disabled. It means that no trip can be assigned to this vehicle. If it is the unique vehicle of the account, autostart will be disabled. |
| GPS | Each trip will be assigned by default to this vehicle. If the account has other vehicles with Beacon or Bluetooth detection modes, every trip where these peripherals are not seen will be assigned to this vehicle. |
| BEACON | If the vehicle has this detection mode and a configured beacon, every trip where the beacon is seen will be assigned to this vehicle. If there is no other vehicle with GPS mode, trips will be canceled if the Beacon is not seen during a trip. |
| BLUETOOTH | If the vehicle has this detection mode and a configured Bluetooth device, every trip where the peripheral is seen will be assigned to this vehicle. If there is no other vehicle with GPS mode, trips will be canceled if the Bluetooth device is not seen during a trip. |
## Beacon
| Field | Type | Description |
| ------------- | ------ | ------------------------------------------------------------------ |
| proximityUuid | String | UUID of the beacon |
| major | Int | Major code |
| minor | Int | Minor code |
| code | String | Unique code that identifies the beacon in our DriveQuant database. |
## Bluetooth
| Field | Type | Description |
| ---------- | ------ | ---------------------- |
| macAddress | String | Peripheral MAC address |
| name | String | Bluetooth device name |
## VehicleSyncStatus
| Value | Description |
| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| NO\_ERROR | Synchronization request has been successfully executed. List of vehicles (if they exist) are available in vehicles. |
| CACHE\_DATA\_ONLY | Method has been called with the SynchronizationType parameter to `CACHE` so the list of vehicles stored in the local database request has been successfully executed. List of vehicles (if they exist) are returned in vehicles. |
| FAILED\_TO\_SYNC\_VEHICLES\_CACHE\_ONLY | Synchronization request has failed, for example if the user has no network. List of vehicles stored in the local database (if they exist) are returned in vehicles.
|
| SYNC\_ALREADY\_IN\_PROGRESS | Synchronization request is already called, so the list of vehicles stored in the local database request has been successfully executed. List of vehicles (if they exist) are returned in vehicles. |
## VehicleReplaceStatus
| Value | Description |
| ---------------- | -------------------------------------------------------------------------------------------- |
| SUCCESS | Vehicle is successfully replaced and changes are saved in the local database. |
| INVALID\_VEHICLE | Error thrown when the provided vehicleId is incorrect and/or if characteristics are invalid. |
| ERROR | An error occurred when trying to replace the vehicle. (e.g: device has no network) |
## DetectionModeStatus
| Value | Description |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| SUCCESS | The detection mode of the specified vehicle has been successfully updated. The new detection mode is automatically saved in the local database. |
| ERROR | An error occurred when trying to update the detection mode of the vehicle. |
| GPS\_MODE\_ALREADY\_EXISTS | The detection mode of the specified vehicle could not have been updated to GPS because the account already has a vehicle with that detection mode.
If you still want to do that, you must set forceGPSVehicleUpdate parameter to true.
|
## VehicleBluetoothStatus
| Value | Description |
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| SUCCESS | The Bluetooth device has been successfully paired to the specified vehicle. The vehicle data in the local database is automatically updated. |
| ERROR | An error occurred when trying to pair the Bluetooth device to the vehicle |
| UNKNOWN\_VEHICLE | An error occurred: the specified vehicle does not belong to you. |
| UNAVAILABLE\_BLUETOOTH | The provided Bluetooth device is currently paired to another vehicle. You must unpair the device to that vehicle before in order to pair it to your desired vehicle. |
## VehicleRemoveBluetoothStatus
| Value | Description |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| SUCCESS | The Bluetooth device has been successfully unpaired to the specified vehicle. The vehicle data in the local database is automatically updated. |
| ERROR | An error occurred when trying to unpair the Bluetooth device to the vehicle |
| UNKNOWN\_VEHICLE | An error occurred: the specified vehicle does not belong to the user. |
## OdometerSyncStatus
| Value | Description |
| ----------------------------------- | ----------------------------------------------------------------------------------- |
| SUCCESS | Synchronization has been successfully performed. |
| FAILED\_TO\_SYNC\_CACHE\_DATA\_ONLY | Synchronization has failed, only odometer data previously synchronized are returned |
| VEHICLE\_NOT\_FOUND | An error occurred: the specified vehicle does not belong to the user. |
| CACHE\_DATA\_ONLY | `SynchronizationType` has been set to `CACHE`. |
## OdometerAddHistoryStatus
| Value | Description |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| SUCCESS | The history entry has been successfully added to the odometer’s vehicle |
| FAILED | An error occurred, for example if the user has no network. |
| VEHICLE\_NOT\_FOUND | An error occurred: the specified vehicle does not belong to the user. |
| BAD\_DISTANCE | An invalid distance value has been filled, for example if the provided distance is lower than the last distance odometer entry. |
## OdometerUpdateHistoryStatus
| Value | Description |
| ------------------- | -------------------------------------------------------------------------------- |
| SUCCESS | The history entry has been successfully updated. |
| FAILED | An error occurred, for example if the user has no network. |
| HISTORY\_NOT\_FOUND | There is no matching odometer’s history for the provided historyId and vehicleId |
| VEHICLE\_NOT\_FOUND | An error occurred: the specified vehicle does not belong to the user. |
| BAD\_DISTANCE | An invalid distance value has been filled. |
## OdometerDeleteHistoryStatus
| Value | Description |
| --------------------- | -------------------------------------------------------------------------------- |
| SUCCESS | The history entry has been successfully deleted. |
| FAILED | An error occurred, for example if the user has no network. |
| HISTORY\_NOT\_FOUND | There is no matching odometer’s history for the provided historyId and vehicleId |
| VEHICLE\_NOT\_FOUND | An error occurred: the specified vehicle does not belong to the user. |
| LAST\_ODOMETER\_ERROR | An error occurred: it is not possible to delete the last odometer history. |
## VehicleOdometer
| Field | Type | Description |
| --------------------- | ------ | ----------------------------------------------------------------------------- |
| vehicleId | String | Unique identifier of the vehicle |
| analyzedDistance | Double | Distance accumulated during all the analyzed trips in km |
| distance | Double | Odometer last distance entry |
| estimatedYearDistance | Double | Estimated traveled distance for year in km |
| estimatedYearNbTrip | Double | Estimated number of trip for the current year |
| offsetDistance | Double | Difference between the real odometer distance and the analyzed distance in km |
| realDistance | Double | Real odometer distance in km |
| yearAnalyzedDistance | Double | Distance accumulated during all the analyzed trips for the current year in km |
| updateDate | Date? | Last update of the vehicle’s odometer |
## VehicleOdometerHistory
| Field | Type | Description |
| -------------------- | ------ | ----------------------------------------------------------------------------------------- |
| vehicleId | String | Unique identifier of the vehicle |
| historyId | Int | Unique history identifier of the vehicle |
| analyzedDistance | Double | Distance accumulated during all the analyzed trips in km |
| distance | Double | Mileage in km for this history |
| offsetDistance | Double | Difference between the real odometer distance and the analyzed distance in km |
| realDistance | Double | Real odometer distance in km |
| updateDate | Date? | Date of the odometer history entry |
| yearAnalyzedDistance | Double | Distance accumulated during all the analyzed trips for the current year
|