References (iOS)
Last updated
Last updated
Value | Description |
---|---|
Field | Type | Description |
---|---|---|
Value | Description |
---|---|
Value | Description |
---|---|
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
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
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.
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
id
String
Group identifier
label
String
Label of the group
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.
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
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.
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
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
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)
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