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
  • ChallengesSyncStatus
  • DKChallenge
  • Theme code
  • DKChallengeGroup
  • DKChallengeStatus
  • ChallengeDetailSyncStatus
  • DKChallengeDetail
  • DKDriverStats
  • DKChallengeStats
  • DKDriverRanked
  • JoinChallengeSyncStatus

Was this helpful?

Export as PDF
  1. CHALLENGE
  2. iOS

References (iOS)

ChallengesSyncStatus

Value
Description

success

Synchronization has been successfully performed.

cacheDataOnly

SynchronizationType has been set to .cache.

failedToSyncChallengesCacheOnly

Synchronization has failed, only challenges previously synchronized are returned

syncAlreadyInProgress

Another challenge list synchronization is already in progress

DKChallenge

Field
Type
Description

id

String

Unique identifier of the challenge

title

String

Title of the challenge

challengeDescription

String

Description of the challenge

conditionsDescription

String?

Description of the challenge’s conditions to be filled.

startDate

Date

Challenge’s start date

endDate

Date

Challenge’s end date

conditions

[String, Any]

Required conditions to participate.

Possible keys of the dictionary are: km and nbTrip.

Remark: All conditions must be met in order to participate.

rankKey

String?

Deprecated.

themeCode

Int

Deprecated.

type

Int

Deprecated.

isRegistered

Bool

Equals true if the user participates in the challenge.

conditionsFilled

Bool

Equals true if the conditions are filled by the user to access the challenge.

driverConditions

[String, Any]

Current driver values for conditions to participate in the challenge.

Possible keys of the dictionary are: km and nbTrip

groups

Groups that can view and participate to the challenge

rules

String?

Rules of the current challenge

optinText

String?

Opt-in text of the current challenge

status

Current status of the challenge

nbDriverRegistered

Int

Number of drivers registered for this challenge

nbDriverRanked

Int

Number of drivers ranked for this challenge

rank

Int

Current rank of the driver. Equals 0 if the driver is not registered or not ranked for this challenge.

Theme code

Value
Description

101

Challenge based on eco driving score

201

Challenge based on safety score

205

Challenge based on the number of hard brakings

209

Challenge based on the number of hard acceleration

221

Challenge based on distraction score

401

Challenge based on speeding score

DKChallengeGroup

Field
Type
Description

id

String

Group identifier

label

String

Label of the group

DKChallengeStatus

Value
Description

finished

The challenge is finished.

scheduled

The challenge has not started yet.

pending

The challenge is in progress.

archived

The challenge is finished and is archived. It should not appear in the list

draft

Internal status. Should not happen.

undefined

Internal status. Should not happen.

ChallengeDetailSyncStatus

Value
Description

success

Synchronisation has been successfully performed.

notFound

There is no existing challenge with this challengeId.

cacheDataOnly

synchronizationType has been set to .cache.

failedToSyncChallengeCacheOnly

Synchronisation has failed, only challenge detail previously synchronized is returned.

syncAlreadyInProgress

Another challenge detail retrieval for this identifier is already in progress

DKChallengeDetail

Field
Type
Description

challengeId

String

Identifier of the challenge

driverStats

Driver’s statistics of the challenge

challengeStats

Global statistics of the challenge

driverRanked

Ranked drivers list.

userIndex

Int

Position of the user in the driverRanked list

nbDriverRegistered

Int

Number of drivers registered for this challenge

nbDriverRanked

Int

Number of drivers ranked for this challenge

isRegistered

Bool

Equals true if the user is registered to the challenge

conditionsFilled

Bool

Equals true if the user has filled the condition to be ranked.

itinIds

[String]

List of itinerary IDs made by the user during the challenge.

DKDriverStats

Field
Type
Description

rank

Int

Driver’s rank for this challenge

numberTrip

Int

Number of trips made during the challenge

distance

Double

Total distance (in km) made during the challenge

duration

Double

Total duration (in hours) of the trips made during the challenge

score

Double

Score for the challenge

DKChallengeStats

Field
Type
Description

numberDriver

Int

Total number of drivers participating in the challenge

numberTrip

Int

Total number of trips done for this challenge

distance

Double

Total distance (in km) travelled for this challenge

duration

Double

Total trips duration (in hours) of the challenge

score

Double

Average challenge score

minScore

Double

Lowest score for this challenge

maxScore

Double

Best score for this challenge

DKDriverRanked

Field
Type
Description

pseudo

String?

Pseudo of the driver

rank

Int

Driver’s rank

score

Double

Driver’s score on ten

previousRank

Int

Driver’s previous rank

distance

Double

Distance travelled by the driver (in km)

JoinChallengeSyncStatus

Value
Description

success

The challenge is joined successfully

alreadyJoined

The user has already joined the given challenge

notFound

There is no existing challenge with this challengeId

failedToJoin

Couldn’t join the challenge. Can occur for example if the user has no network

alreadyInProgress

The request to join the challenge is already in progress

PreviousGet startedNextAndroid

Last updated 1 year ago

Was this helpful?

[]

[]

DKChallengeGroup
DKChallengeStatus
DKDriverStats
DKChallengeStats
DKDriverRanked