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
  • Vehicle body type
  • Engine type
  • Gearbox type
  • Drive wheels type
  • Weather code
  • Transportation Mode
  • Road conditions
  • Error codes

Was this helpful?

Export as PDF
  1. Trip analysis
  2. REST services

References

This section describes the main response codes of the trip analysis API.

Vehicle body type

Value
Type
Description

1

Car

Compact

2

Car

Sedan

3

Car

Luxury vehicle

4

Car

Estate car

5

Car

Minivan

6

Car

4x4, SUV

7

Car

Sports car

8

Car

Convertible

9

Car

Commercial vehicle

200

Truck

2-axle trailer

201

Truck

3-axle trailer

202

Truck

4-axle trailer

203

Truck

2-axle tractor

204

Truck

3-axle tractor

Engine type

Value
Description

1

Gasoline

2

Diesel

3

Electric vehicle

4

Gasoline-electric hybrid

5

Diesel-electric hybrid

6

Biofuel

7

Bi-fuel gasoline bioethanol

8

Dual-fuel gasoline NGV

9

Dual-fuel gasoline LPG

10

Not available

11

Plug-in gasoline hybrid

12

Hydrogen

Gearbox type

Value
Description

1

Automatic

2

Manual 5-speed

3

Manual 6-speed

4

Manual 7-speed

5

Manual 8-speed

Drive wheels type

Value
Description

0

Front-wheel drive

1

Rear-wheel drive

2

Four-wheel drive

Weather code

Value
Description

0

Unknown

1

Clear sky

2

Cloudy

3

Foggy

4

Rainy

5

Snowy

6

Icy

Transportation Mode

Value
Description

0

Unknown

1

Passenger car

2

Motorcycle

3

Heavy-duty vehicle

4

Bus

5

Coach

6

Rail trip

7

Boat trip

8

Bike trip

9

Plane

10

Ski

11

On foot

12

Idle

13

Other

Road conditions

Value
Description
Comment

0

Traffic jam

This corresponds to vehicle displacements of less than 100 meters and performed with speeds below 10 km/h

1

Heavy urban traffic

Speed below 30 km/h and distance between two stops greater than 100 m

2

City

30 km/h < Speed < 65 km/h

3

Suburban

65 km/h < Speed < 96 km/h

4

Expressways

Speed > 96 km/h

Error codes

Status
Code
Comment
Description

true

0

OK

The data are correct and the process ran fine

false

10

Mandatory account object not found

The « account» block is not set

false

13

Mandatory route object not found

The « route » block is not available → The trip analysis is not possible

false

14

Invalid route definition

Error when parsing the Route block

false

15

Velocity data is missing

The vehicle or GPS velocity is not available → The trip analysis is not possible

true

16

Engine speed not available

The engine speed is not available → The trip analysis is performed with an estimated value of the engine speed

true

17

Engine speed is null

The engine speed is always at 0 rpm while the vehicle is moving → The trip analysis is performed but with an estimated value of the engine speed

true

18

One or more vehicle parameters are missing (<list of missing parameters>). Default values are used

The vehicle characteristics are not set or some values are missing → The trip analysis is performed with generic vehicle model parameters

false

19

Invalid sampling period: one second recording interval is recommended for input variables

The input variables have an invalid acquisition period → The trip analysis is not possible

true

20

More than 25% of data loss

More than 25% of data loss is detected during the trip

false

21

Invalid customerId

Unknown account value. Unauthorized access.

false

23

Date data is missing

The field vehicleDate or gpsDate is not available → The trip analysis is not possible

false

24

Daily request number is reached

The maximum daily request number is reached

true

25

The trip distance is lower than 1 km

This error message indicates that the trip was analysed but the distance is not sufficient to provide an accurate energy analysis

false

26

Your request could not be processed. If the problem persist, please contact us

The service failed to process your data. There is a need to diagnose your data to determine the origin of this problem

false

27

Your request could not be processed. If the problem persist, please contact us

The service failed to process your data. There is a need to diagnose your data to determine the origin of this problem

true

28

One or more vehicle parameters are out of bound (<list of missing parameters>)

The vehicle characteristics are not in the range of available values. See vehicle characteristics for range limits

false

29

Beacon is missing

The beacon has not been detected and it is required to validate the trip analysis

false

30

Invalid beacon data

A beacon was detected during the trip but it does not have the correct identifiers

false

31

A similar trip has already been processed and stored with same account

The duplicate trip feature is enabled and the trip has already been analyzed

true

32

The vehicleId is invalid

No vehicle found for the vehicleId provided into the API request

false

33

The total of GPS points are under 10

There is not enough GPS points to perform an analysis

false

34

The account of this driver is disabled

The driver account is disabled

false

35

The automatic driver account creation is disabled

The automatic creation is disabled, use a valid authentication process to create the driver account

false

36

All the dates are negatives

The field vehicleDate or gpsDate contains negative values → The trip analysis is not possible

false

37

Your request could not be processed. If the problem persist, please contact us

The service failed to process your data. There is a need to diagnose your data to determine the origin of this problem

false

38

Unable to create a new driver: maximum number of drivers reached for the account

The trip's driver cannot be created automatically, because you reached the maximum allowed number of drivers for your account. Please contact us to increase this threshold.

PreviousTripNextTrip Simulator

Last updated 1 year ago

Was this helpful?