WEB API

for fleet owner

API Reference - References

Edit
Info: Stellantis Fleet Owner API for ex Groupe PSA brands (Citroën, DS, Peugeot, Opel and Vauxhall) is made for organisations owning fleet of vehicles.

Changelog: history and versioning of WEB API Fleet Owner v3.
API BaseURL https://api-cert.groupe-psa.com/connectedcar/v3
API docs by Redocly

Groupe PSA Connected Car B2B API (3.19.2)

Download OpenAPI specification:Download

License: Groupe PSA Licence

Business Partner Connected Fleet API

Introduction

This is the description of the Groupe PSA Connected Car V3 B2B API. This specification is written in OpenAPI Specification version 3 and can be displayed using ReDoc or Swagger. This REST API allows applications to fetch data from the connected Vehicles data platform.

Authentication

PSA Connected Car B2B APIs uses the HTTPS Authentication (with provided PSA SSL Certificate) to access to fleet vehicles data.

Paging:

To make this necessary feature easy to use when retrieving a collection of results, this API uses a token (computed and interpreted by the server only) as a context that contains all necessary information allowing the navigation through pages. Token acts as an <code>HTTP COOKIE</code> on the client-side, so the server does not keep any cache or session settings to continue paging and keep all request stateless.

Paging:

To make this necessary feature easy to use when retrieving a collection of results, this API uses a token (computed and interpreted by the server only) as a context that contains all necessary information allowing the navigation through pages. Token acts as an HTTP COOKIE on the client-side, so the server does not keep any cache or session settings to continue paging and keep all request stateless.

Errors:

<strong>Errors are returned as a generic error response:</strong> * See <code>ErrorCodeDefaultResponse</code> model.

Errors:

Error codes returned by all APIs comply with the standard. Nevertheless, PSA Services (callers) need to have more detailed data structures (even when the answer is not Http-OK) to better categorize the type of error by providing application code, message and debugging code(for investigation purposes). The HTTP code of the response is managed by the protocol itself (in the header).

These APIS are likely to report the following HTTP code:

Code Description Case
200 The request has succeeded and the resource data has been sent. GET APIs.
202 The request has been accepted for processing, but not yet acted upon. An id of processing is returned. POST/PUT requests:
-Create monitor
-Create Remote callback.
204 The request has been accepted and there is no additional content DELTE APIs:
-Delete monitor.
-Delete remote callback.
400 Request cannot be processed due to invalid query parameter value of body content (for POST/PUT verbs) ALL APIs.
401 Unauthorized request due to lack of valid authentication credentials. All APIs.
403 Unauthorized request due to insufficient credentials to grant access. All APIs.
404 Target resource not found. All APIs. Even POST, PUT or DELETE if the resource id is unknown.
500 Unexpected condition that prevented from fulfilling the request. All APIs.

Errors are returned as a generic error response: * See ErrorCodeDefaultResponse model.

API output:

Data profile

B2B partners need to return vehicle data with an end-user profile. To do this, the data APIs allow to use an end-user profile according to a query parameter named profile. Remote, Monitor, Fleets and Vehicles getter APIs are not affected by this parameter.

Data format

All APIs return data in JSON format. The application who uses them must take into account the evolving character of them and more precisely regarding the schemas of the exposed data. Indeed:

  • The missing of known data fields should not cause an error.
  • It should (correctly) deal with JSON content with unknown properties also. Indeed, data schema extensions should be supported without errors even if they are not used.

for example:

Assuming a given exposed resource with this data schema:

   data:
    type: object
    description: Data model
    properties:
      field1:
        type: string
      field2:
        type: number

The application should be able to deal with those possible valid JSON contents:

All fields: { "field1":"value1", "field2": 1 }

Missing field2: { "field1":"value1" }

Unknow field3: { "field1":"value1", "field3": 2.5 }

Capabilities

Access to Vehicles details & onboard capabilities

List of vehicles characteristics & capabilities

Returns vehicle'scharacteristics & capabilities

Authorizations:
(BasicAuthClientId)
path Parameters
vin
required
string
Example: VF3ABCDE0FG123456

Results will only be related to this Vehicle Identification Number.

query Parameters
locale
string

Locale is used for rendering text according to language and country for. It should match the REGEX \w(-\w)?. For more details about possible standard values, please refer to locals list.

extension
Array of strings (VehicleExtensionType) [ 1 .. 3 ] items
Items Enum: "onboardCapabilities" "branding" "pictures"
Example: extension=branding

Additional data set that will be included in embedded field(the number of elements in this array must be between 1 and 3).

Responses

Response Schema: application/hal+json
vin
required
string

Serial number of a vehicle

motorization
string
Enum: "Electric" "Hybrid" "Thermic" "Hydrogen"

Motorization of the vehicle.

object

Response samples

Content type
application/hal+json
{
  • "vin": "VF3ABCDE0FG123456",
  • "motorization": "Thermic",
  • "_embedded": {
    }
}

Fleet

To retreive Fleet details and access resources in batch mode (without vehicle or trip filtering).

Fleets owned by a partner

Returns all Fleets owned by a partner.

Authorizations:
(BasicAuthClientId)
query Parameters
pageSize
integer [ 1 .. 60 ]
Default: 60

The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. The range for this parameter is [1...60]

pageToken
string

Start-Page marker, this token is used (by the backend) for continuing serving from the previous results page to the next one. (Disclaimer: It is built and used only by the server).

Responses

Response Schema: application/hal+json
required
object (Tab_Links)

HAL (Hypertext Application Language) link collection

total
required
integer
totalPage
required
integer
currentPage
required
integer
required
object

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "total": 0,
  • "totalPage": 0,
  • "currentPage": 0,
  • "_embedded": {
    }
}

Fleet's information

Returns the Fleet's information.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

Responses

Response Schema: application/hal+json
updatedAt
string <date-time>

Date when the resource has been updated.

createdAt
string <date-time>

Date when the resource has been created.

required
object
name
string

Name of the Fleet

id
required
string

The id of the Fleet

description
string

The description of the Fleet

Response samples

Content type
application/hal+json
{
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "_links": {
    },
  • "name": "string",
  • "id": "0a123bc5d1e873066454b4d9",
  • "description": "string"
}

Fleet Vehicles status. Deprecated

Returns the latest vehicles status for a given fleet. HyperLink (HAL) resolutions of resources within the returned collection are associate to vehicle.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

query Parameters
profile
string (DataProfile)
Enum: "fleet" "endUser"

Results will contain a relative view of the data depending on the selected profile. Indeed, endUser will expose only the data available to the end-user as if there were no intermediaries between him and the vehicle (case of B-2-B-2-C). If not specified, this parameter will be set tofleetvalue (deault value).

  • Disclaimer: Since thefleetprofile has a larger data scope, selectingendUserprofile will potentially result in not found status depending on its granted rights and privacy level.
indexRange
string (indexRange) \d+-\d*
Default: "0-"

Results indexes will be included in this range (see indexRange model).

default: 0-

example: 0-, 0-5

pageSize
integer [ 1 .. 60 ]
Default: 60

The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. The range for this parameter is [1...60]

pageToken
string

Start-Page marker, this token is used (by the backend) for continuing serving from the previous results page to the next one. (Disclaimer: It is built and used only by the server).

Responses

Response Schema: application/hal+json
required
object (Tab_Links)

HAL (Hypertext Application Language) link collection

total
required
integer
totalPage
required
integer
currentPage
required
integer
required
object

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "total": 0,
  • "totalPage": 0,
  • "currentPage": 0,
  • "_embedded": {
    }
}

Fleet Vehicles maintenances. Deprecated

Returns the latest vehicles maintenance list for a given fleet. HyperLink (HAL) resolutions of resources within the returned collection are associate to vehicle.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

query Parameters
profile
string (DataProfile)
Enum: "fleet" "endUser"

Results will contain a relative view of the data depending on the selected profile. Indeed, endUser will expose only the data available to the end-user as if there were no intermediaries between him and the vehicle (case of B-2-B-2-C). If not specified, this parameter will be set tofleetvalue (deault value).

  • Disclaimer: Since thefleetprofile has a larger data scope, selectingendUserprofile will potentially result in not found status depending on its granted rights and privacy level.
indexRange
string (indexRange) \d+-\d*
Default: "0-"

Results indexes will be included in this range (see indexRange model).

default: 0-

example: 0-, 0-5

pageSize
integer [ 1 .. 60 ]
Default: 60

The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. The range for this parameter is [1...60]

pageToken
string

Start-Page marker, this token is used (by the backend) for continuing serving from the previous results page to the next one. (Disclaimer: It is built and used only by the server).

Responses

Response Schema: application/hal+json
required
object (Tab_Links)

HAL (Hypertext Application Language) link collection

total
required
integer
totalPage
required
integer
currentPage
required
integer
required
object

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "total": 0,
  • "totalPage": 0,
  • "currentPage": 0,
  • "_embedded": {
    }
}

Fleet Vehicles alerts. Deprecated

Returns the vehicles alerts list for a given fleet. HyperLink (HAL) resolutions of resources within the returned collection are associate to vehicle.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

query Parameters
profile
string (DataProfile)
Enum: "fleet" "endUser"

Results will contain a relative view of the data depending on the selected profile. Indeed, endUser will expose only the data available to the end-user as if there were no intermediaries between him and the vehicle (case of B-2-B-2-C). If not specified, this parameter will be set tofleetvalue (deault value).

  • Disclaimer: Since thefleetprofile has a larger data scope, selectingendUserprofile will potentially result in not found status depending on its granted rights and privacy level.
timestamps
Array of strings [ 1 .. 10 ] items [ items\w?/\w? ]

Array of "timestamp" ranges. Results will contain results whose timestamps are included in those date-time ranges (see timestamp data model)."timestamp" items should be expressed as in 'RFC3339'. Each element of the array expresses a time range (with the pattern \w?/\w? or R\d?/w/w(/w)?) which is the period between two or more times. The range can be expressed by tw o times Points (start and end Timestamps), by a start Timestamp Point and a Duration or as a repeating interval. All of them should be expressed using the RFC3339 and the interval format is based on ISO8601

  • 'T1/T2' interval time from low limit T1 to hight T2
  • 'T1/D' interval time from low limit T1 with duration = D ( T2=T1+D)
  • 'T/' endless range, known start Timestamp but no end Timestamp. The current time will be used as the high time limit.
  • '/T' startless range, known end date but no start date. No lower limit will be used to retrieve results.
  • Rn/T/D/[d] repeat the interval of D n times starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H
  • R/T/D/[d] unbounded number of repetitions starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H.
  • T is a timestamp and D is a duration as defined in RFC3339.
    • 2018-01-01T09:00:00+01:00/2018-01-01T12:00:00+01:00* known low and hight limits.
    • 2018-01-03T12:00:00+01:00/P3Y6M4DT12H30M5S known low limit, hight limit = start + duration.
    • 2018-01-03T12:00:00+01:00/ known low limit, hight limit = current time.
    • R5/2018-01-03T12:00:00Z/P6H/P2H repeate duration 6H wiht interval period of 2H for 5 times starting at 2018-01-03T12:00:00Z.
indexRange
string (indexRange) \d+-\d*
Default: "0-"

Results indexes will be included in this range (see indexRange model).

default: 0-

example: 0-, 0-5

pageSize
integer [ 1 .. 60 ]
Default: 60

The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. The range for this parameter is [1...60]

pageToken
string

Start-Page marker, this token is used (by the backend) for continuing serving from the previous results page to the next one. (Disclaimer: It is built and used only by the server).

Responses

Response Schema: application/hal+json
required
object (Tab_Links)

HAL (Hypertext Application Language) link collection

total
required
integer
totalPage
required
integer
currentPage
required
integer
required
object

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "total": 0,
  • "totalPage": 0,
  • "currentPage": 0,
  • "_embedded": {
    }
}

Fleet single alert. Deprecated

Returns information about a specific alert message for a given fleet.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

aid
required
string

id of the alert.

query Parameters
profile
string (DataProfile)
Enum: "fleet" "endUser"

Results will contain a relative view of the data depending on the selected profile. Indeed, endUser will expose only the data available to the end-user as if there were no intermediaries between him and the vehicle (case of B-2-B-2-C). If not specified, this parameter will be set tofleetvalue (deault value).

  • Disclaimer: Since thefleetprofile has a larger data scope, selectingendUserprofile will potentially result in not found status depending on its granted rights and privacy level.

Responses

Response Schema: application/hal+json
createdAt
required
string <date-time>

Date when the resource has been created.

updatedAt
string <date-time>

Date when the resource has been updated.

required
object
id
required
string
vin
required
string (Vin)

Identifier of a vehicle. Set when retrieving resource in batch mode.

active
required
boolean
type
required
string (AlertMsgEnum)
Enum: "AbsBrakingSystemFault" "ActiveSpoilerFault" "AdBlueFault" "AdBlueFaultStartingImpossible" "AdBlueFaultStartingImpossibleSoon" "AddWasherFluid" "AirbagOrSeatBeltPretensionerOrActiveHoodFailure" "AssistanceButtonFault" "AutomaticBrakingDeactivated" "AutomaticHeadlightAdjustmentFault" "BatteryChargeOrElectricalCircuitSystemFailure" "BrakingSystemFailure" "ChargingFailure" "CheckTheCenterBrakeLamp" "CollisionDetectionSystemFault" "CollisionMitigationSystemFault" "CoolantLevellow" "DrivingAssistanceSensorBlind" "ElectricTractionSystemFailureLimitSpeed" "ElectricTractionSystemFailureStopVehicle" "ElectricTractionSystemFault" "ElectronicImmobiliserFault" "EmissionSystemOrAdBlueQualityFailueStartingImpossible" "EmissionSystemOrAdBlueQualityFailueStartingImpossibleSoon" "EmissionSystemOrAdBlueQualityFailure" "EngineFailure" "EngineFault" "EngineMisfiringFuel" "EngineOilPressureFailure" "EngineTemperatureFailure" "EspAsrSystemFault" "FrontLeftFlashingIndicatorFault" "FrontLeftFogLampsFault" "FrontLeftParkingLampsFault" "FrontRightFlashingIndicatorFault" "FrontRightFogLampsFault" "FrontRightParkingLampsFault" "FuelLevelLow" "GearboxFault" "HeadlightsFault" "InstalledSpareWheelFault" "InterVehicleTimeMeasurementFault" "LaneChangeAssistanceFault" "LaneDepartureWarningSystemFault" "LeftBrakeLampFault" "LeftFrontDoorOpen" "LeftFrontDoorOpenLowSpeed" "LeftFrontTirePressurSensorFault" "LeftFrontTirePuncture" "LeftFrontTireUnderInflated" "LeftRearDoorOpen" "LeftRearDoorOpenLowSpeed" "LeftRearTirePressurSensorFault" "LeftRearTirePuncture" "LeftRearTireUnderInflated" "LeftReverseLampFault" "OilLevelLow" "ParkAssistSystemFault" "ParkingBrakeOrHillStartSystemFailure" "ParticleFilterAdditiveLevelTooLow" "ParticleFilterFull" "ParticleFilterRegenerating" "PowerSteeringFailure" "PowerSteeringFault" "PreheatingPreventilationDeactivatedBatteryLow" "PreheatingPreventilationDeactivatedClockUnset" "PreheatingPreventilationDeactivatedFuelLevelLow" "RearLeftFlashingIndicatorFault" "RearLeftFogLampsFault" "RearLeftParkingLampsFault" "RearRightFlashingIndicatorFault" "RearRightFogLampsFault" "RearRightParkingLampsFault" "RearWindowOpen" "RearWindowOpenLowSpeed" "ReplaceBrakePads" "ReplaceTheRemoteControlBattery" "RetractableRoofMechanismFault" "RightBrakeLampFault" "RightFrontDoorOpenLowSpeed" "RightFrontDoorOpen" "RightFrontTirePressurSensorFault" "RightFrontTirePuncture" "RightFrontTireUnderInflated" "RightRearDoorOpen" "RightRearDoorOpenLowSpeed" "RightRearTirePressurSensorFault" "RightRearTirePuncture" "RightRearTireUnderInflated" "RightReverseLampFault" "RiskOfIce" "RoofOperationNotPossibleSpeedUnknown" "RoofOperationNotPossibleTooHighTemp" "ShiftToPark" "SteeringLockFault" "SuspensionFault" "SuspensionFaultLimitSpeed" "SuspensionFaultRepaireVehicle" "TireUnderInflationDetectionSystemFault" "TooManyRoofOperation" "TrailerConnectionFault" "TrunkOrHoodOpen" "TrunkOrHoodOpenLowSpeed" "WaterInTheDieselFuelFilter"

MPH alert list

severity
string
Enum: "Information" "Warning" "Critical"

Alert severity level.

Severity Description
Information Better to fix but it is operating accurately.
Warning Should fix it asap.
Critical Starting prohibited without repair.
startedAt
required
string <date-time>
endAt
string <date-time>
object (Position)

The position (last vehicle known one) where the alert appears.

object (Position)

The position (last vehicle known one) where the alert disappears.

Response samples

Content type
application/hal+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "_links": {
    },
  • "id": "0a9de72cc3803b12a74418acd20dcd66634fa82e44b2ec7060bca91462dc5772199559905caefe168812918d47f67253f33d477b645bb59afdd1268b81e382999",
  • "vin": "VF3ABCDE0FG123456",
  • "active": true,
  • "type": "AbsBrakingSystemFault",
  • "severity": "Information",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "endAt": "2019-08-24T14:15:22Z",
  • "startPosition": {
    },
  • "endPosition": {
    }
}

Trips of all vehicles of the fleet. Deprecated

This method returns a list of all Trips. HyperLink (HAL) resolutions of resources within the returned collection are associate to vehicle.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

query Parameters
profile
string (DataProfile)
Enum: "fleet" "endUser"

Results will contain a relative view of the data depending on the selected profile. Indeed, endUser will expose only the data available to the end-user as if there were no intermediaries between him and the vehicle (case of B-2-B-2-C). If not specified, this parameter will be set tofleetvalue (deault value).

  • Disclaimer: Since thefleetprofile has a larger data scope, selectingendUserprofile will potentially result in not found status depending on its granted rights and privacy level.
timestamps
Array of strings [ 1 .. 10 ] items [ items\w?/\w? ]

Array of "timestamp" ranges. Results will contain results whose timestamps are included in those date-time ranges (see timestamp data model)."timestamp" items should be expressed as in 'RFC3339'. Each element of the array expresses a time range (with the pattern \w?/\w? or R\d?/w/w(/w)?) which is the period between two or more times. The range can be expressed by tw o times Points (start and end Timestamps), by a start Timestamp Point and a Duration or as a repeating interval. All of them should be expressed using the RFC3339 and the interval format is based on ISO8601

  • 'T1/T2' interval time from low limit T1 to hight T2
  • 'T1/D' interval time from low limit T1 with duration = D ( T2=T1+D)
  • 'T/' endless range, known start Timestamp but no end Timestamp. The current time will be used as the high time limit.
  • '/T' startless range, known end date but no start date. No lower limit will be used to retrieve results.
  • Rn/T/D/[d] repeat the interval of D n times starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H
  • R/T/D/[d] unbounded number of repetitions starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H.
  • T is a timestamp and D is a duration as defined in RFC3339.
    • 2018-01-01T09:00:00+01:00/2018-01-01T12:00:00+01:00* known low and hight limits.
    • 2018-01-03T12:00:00+01:00/P3Y6M4DT12H30M5S known low limit, hight limit = start + duration.
    • 2018-01-03T12:00:00+01:00/ known low limit, hight limit = current time.
    • R5/2018-01-03T12:00:00Z/P6H/P2H repeate duration 6H wiht interval period of 2H for 5 times starting at 2018-01-03T12:00:00Z.
distance
string (Range) \d+-\d*
Default: "0-"

Trip distance validity interval. It allows to define the min or max duration of a trip.
Unit = Km and format : float (only one digit after the decimal point is aceepted for the interval bounds).

Example:

      * 1-150: Trip with distance between 1 Km and 150 km .

      * 0.1-: Trip with distance  greater than 100 m.

default: 0-

duration
string (Range) \d+-\d*
Default: "0-"

Trip duration validity interval. It allows to define the min or max duration of a trip. Unit = sec

Example:

      * 10-3600: Trip with duration between 10 sec and 1 hour.

      * 20-: Trip with duration greater than 20 sec.

default: 0-

states
Array of strings (TripStateEnumArray)
Items Enum: "Nominal" "Unstarted" "DataLacking" "Unfinished"

Allow to filter for Trips with defined states. Those states can be compound of : Nominal,Unstarted, DataLacking, Unfinished.

Default: All states are allowed.

indexRange
string (indexRange) \d+-\d*
Default: "0-"

Results indexes will be included in this range (see indexRange model).

default: 0-

example: 0-, 0-5

pageSize
integer [ 1 .. 60 ]
Default: 60

The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. The range for this parameter is [1...60]

pageToken
string

Start-Page marker, this token is used (by the backend) for continuing serving from the previous results page to the next one. (Disclaimer: It is built and used only by the server).

Responses

Response Schema: application/hal+json
required
object

HAL (Hypertext Application Language) link collection

total
required
integer
totalPage
required
integer
currentPage
required
integer
required
object

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "total": 0,
  • "totalPage": 0,
  • "currentPage": 0,
  • "_embedded": {
    }
}

Collisions of all vehicles' fleet. Deprecated

Returns the list of Collisions that occured on vehicles' fleet. HyperLink (HAL) resolutions of resources within the returned collection are associate to vehicle.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

query Parameters
profile
string (DataProfile)
Enum: "fleet" "endUser"

Results will contain a relative view of the data depending on the selected profile. Indeed, endUser will expose only the data available to the end-user as if there were no intermediaries between him and the vehicle (case of B-2-B-2-C). If not specified, this parameter will be set tofleetvalue (deault value).

  • Disclaimer: Since thefleetprofile has a larger data scope, selectingendUserprofile will potentially result in not found status depending on its granted rights and privacy level.
pageToken
string

Start-Page marker, this token is used (by the backend) for continuing serving from the previous results page to the next one. (Disclaimer: It is built and used only by the server).

timestamps
Array of strings [ 1 .. 10 ] items [ items\w?/\w? ]

Array of "timestamp" ranges. Results will contain results whose timestamps are included in those date-time ranges (see timestamp data model)."timestamp" items should be expressed as in 'RFC3339'. Each element of the array expresses a time range (with the pattern \w?/\w? or R\d?/w/w(/w)?) which is the period between two or more times. The range can be expressed by tw o times Points (start and end Timestamps), by a start Timestamp Point and a Duration or as a repeating interval. All of them should be expressed using the RFC3339 and the interval format is based on ISO8601

  • 'T1/T2' interval time from low limit T1 to hight T2
  • 'T1/D' interval time from low limit T1 with duration = D ( T2=T1+D)
  • 'T/' endless range, known start Timestamp but no end Timestamp. The current time will be used as the high time limit.
  • '/T' startless range, known end date but no start date. No lower limit will be used to retrieve results.
  • Rn/T/D/[d] repeat the interval of D n times starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H
  • R/T/D/[d] unbounded number of repetitions starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H.
  • T is a timestamp and D is a duration as defined in RFC3339.
    • 2018-01-01T09:00:00+01:00/2018-01-01T12:00:00+01:00* known low and hight limits.
    • 2018-01-03T12:00:00+01:00/P3Y6M4DT12H30M5S known low limit, hight limit = start + duration.
    • 2018-01-03T12:00:00+01:00/ known low limit, hight limit = current time.
    • R5/2018-01-03T12:00:00Z/P6H/P2H repeate duration 6H wiht interval period of 2H for 5 times starting at 2018-01-03T12:00:00Z.
indexRange
string (indexRange) \d+-\d*
Default: "0-"

Results indexes will be included in this range (see indexRange model).

default: 0-

example: 0-, 0-5

pageSize
integer [ 1 .. 60 ]
Default: 60

The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. The range for this parameter is [1...60]

Responses

Response Schema: application/hal+json
required
object (Tab_Links)

HAL (Hypertext Application Language) link collection

total
required
integer
totalPage
required
integer
currentPage
required
integer
required
object

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "total": 0,
  • "totalPage": 0,
  • "currentPage": 0,
  • "_embedded": {
    }
}

An identified collision that occurred on a fleet. Deprecated

Returns the Collision that matches the fleet id and the Collision cid.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

cid
required
string

Results will only contain the Collision related to this Collision ID.

query Parameters
profile
string (DataProfile)
Enum: "fleet" "endUser"

Results will contain a relative view of the data depending on the selected profile. Indeed, endUser will expose only the data available to the end-user as if there were no intermediaries between him and the vehicle (case of B-2-B-2-C). If not specified, this parameter will be set tofleetvalue (deault value).

  • Disclaimer: Since thefleetprofile has a larger data scope, selectingendUserprofile will potentially result in not found status depending on its granted rights and privacy level.

Responses

Response Schema: application/hal+json
createdAt
required
string <date-time>

Date when the resource has been created.

Array of objects (CollisionDetails)
id
required
string
vin
required
string (Vin)

Identifier of a vehicle. Set when retrieving resource in batch mode.

tippedOver
boolean

Indicates if the car tipped over during the collision. Warning : This information is applicable only on vehicles equipped with dedicated sensor and is optionnal.

pedestrian
boolean

Indicates if the collision involve a pedestrian. Warning : This information is applicable only on vehicles equipped with dedicated sensor and is optionnal

updatedAt
string <date-time>
required
object

Response samples

Content type
application/hal+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "details": [
    ],
  • "id": "055d8f0a0089d7b9226989ce2db42511e2e19df8cc106a7fb7d0c7fb92ab2320c0720e94be1ee517b3172da70dd05446a934cccca524172d9add54d8dbce51b14",
  • "vin": "VF3ABCDE0FG123456",
  • "tippedOver": true,
  • "pedestrian": false,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Vehicles

Access to Vehicles details.

List of vehicles

Returns the Vehicles associated with the Fleet.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

query Parameters
pageSize
integer [ 1 .. 60 ]
Default: 60

The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. The range for this parameter is [1...60]

pageToken
string

Start-Page marker, this token is used (by the backend) for continuing serving from the previous results page to the next one. (Disclaimer: It is built and used only by the server).

locale
string

Locale is used for rendering text according to language and country for. It should match the REGEX \w(-\w)?. For more details about possible standard values, please refer to locals list.

extension
Array of strings (VehiclesExtensionType) [ 1 .. 2 ] items
Items Enum: "branding" "pictures"
Example: extension=pictures

Additional data set that will be included in embedded field(the number of elements in this array must be between 1 and 2).

vinPrefix
string

Allows filtering on VINs that start with the same prefix.

Responses

Response Schema: application/hal+json
required
object (Tab_Links)

HAL (Hypertext Application Language) link collection

total
required
integer
totalPage
required
integer
currentPage
required
integer
required
object

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "total": 0,
  • "totalPage": 0,
  • "currentPage": 0,
  • "_embedded": {}
}

Details of a vehicle.

Returns detailed information about a Vehicle.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

vid
required
string

Resource is related to this Vehicle ID only.

query Parameters
locale
string

Locale is used for rendering text according to language and country for. It should match the REGEX \w(-\w)?. For more details about possible standard values, please refer to locals list.

extension
Array of strings (VehicleExtensionType) [ 1 .. 3 ] items
Items Enum: "onboardCapabilities" "branding" "pictures"
Example: extension=branding

Additional data set that will be included in embedded field(the number of elements in this array must be between 1 and 3).

Responses

Response Schema: application/hal+json
updatedAt
string <date-time>

Date when the resource has been updated.

createdAt
string <date-time>

Date when the resource has been created.

required
object
id
string
vin
string

Serial number of a vehicle

motorization
string
Enum: "Electric" "Hybrid" "Thermic" "Hydrogen"

Motorization of the vehicle.

brand
string
Deprecated

Brand of a vehicle

pictures
Array of strings (Url) [ 1 .. 12 ] items
Deprecated

With the links it's possible to see the pictures of the vehicle

object

Response samples

Content type
application/hal+json
{}

Last position identified Deprecated

Returns the latest GPS Position of the Vehicle.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

vid
required
string

Resource is related to this Vehicle ID only.

query Parameters
profile
string (DataProfile)
Enum: "fleet" "endUser"

Results will contain a relative view of the data depending on the selected profile. Indeed, endUser will expose only the data available to the end-user as if there were no intermediaries between him and the vehicle (case of B-2-B-2-C). If not specified, this parameter will be set tofleetvalue (deault value).

  • Disclaimer: Since thefleetprofile has a larger data scope, selectingendUserprofile will potentially result in not found status depending on its granted rights and privacy level.

Responses

Response Schema: application/vnd.geo+json
type
required
string
Default: "Feature"
Value: "Feature"
required
object (Point)

This object expresses a GeoJSON Point as specified by rfc7946.

https://tools.ietf.org/html/rfc7946#section-3.1
required
object

Response samples

Content type
application/vnd.geo+json
{
  • "type": "Feature",
  • "geometry": {
    },
  • "properties": {
    }
}

Collisions of a vehicle.

Returns the list of Collisions that occurred for a given vehicle (id) during the timestamp ranges and bounded by an index range.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

vid
required
string

Resource is related to this Vehicle ID only.

query Parameters
profile
string (DataProfile)
Enum: "fleet" "endUser"

Results will contain a relative view of the data depending on the selected profile. Indeed, endUser will expose only the data available to the end-user as if there were no intermediaries between him and the vehicle (case of B-2-B-2-C). If not specified, this parameter will be set tofleetvalue (deault value).

  • Disclaimer: Since thefleetprofile has a larger data scope, selectingendUserprofile will potentially result in not found status depending on its granted rights and privacy level.
timestamps
Array of strings [ 1 .. 10 ] items [ items\w?/\w? ]

Array of "timestamp" ranges. Results will contain results whose timestamps are included in those date-time ranges (see timestamp data model)."timestamp" items should be expressed as in 'RFC3339'. Each element of the array expresses a time range (with the pattern \w?/\w? or R\d?/w/w(/w)?) which is the period between two or more times. The range can be expressed by tw o times Points (start and end Timestamps), by a start Timestamp Point and a Duration or as a repeating interval. All of them should be expressed using the RFC3339 and the interval format is based on ISO8601

  • 'T1/T2' interval time from low limit T1 to hight T2
  • 'T1/D' interval time from low limit T1 with duration = D ( T2=T1+D)
  • 'T/' endless range, known start Timestamp but no end Timestamp. The current time will be used as the high time limit.
  • '/T' startless range, known end date but no start date. No lower limit will be used to retrieve results.
  • Rn/T/D/[d] repeat the interval of D n times starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H
  • R/T/D/[d] unbounded number of repetitions starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H.
  • T is a timestamp and D is a duration as defined in RFC3339.
    • 2018-01-01T09:00:00+01:00/2018-01-01T12:00:00+01:00* known low and hight limits.
    • 2018-01-03T12:00:00+01:00/P3Y6M4DT12H30M5S known low limit, hight limit = start + duration.
    • 2018-01-03T12:00:00+01:00/ known low limit, hight limit = current time.
    • R5/2018-01-03T12:00:00Z/P6H/P2H repeate duration 6H wiht interval period of 2H for 5 times starting at 2018-01-03T12:00:00Z.
indexRange
string (indexRange) \d+-\d*
Default: "0-"

Results indexes will be included in this range (see indexRange model).

default: 0-

example: 0-, 0-5

pageSize
integer [ 1 .. 60 ]
Default: 60

The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. The range for this parameter is [1...60]

pageToken
string

Start-Page marker, this token is used (by the backend) for continuing serving from the previous results page to the next one. (Disclaimer: It is built and used only by the server).

Responses

Response Schema: application/hal+json
required
object (Tab_Links)

HAL (Hypertext Application Language) link collection

total
required
integer
totalPage
required
integer
currentPage
required
integer
required
object

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "total": 0,
  • "totalPage": 0,
  • "currentPage": 0,
  • "_embedded": {
    }
}

An identified collision that occurred on a vehicle.

Returns the Collision that matches the vehicle id and the Collision cid.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

vid
required
string

Resource is related to this Vehicle ID only.

cid
required
string

Results will only contain the Collision related to this Collision ID.

query Parameters
profile
string (DataProfile)
Enum: "fleet" "endUser"

Results will contain a relative view of the data depending on the selected profile. Indeed, endUser will expose only the data available to the end-user as if there were no intermediaries between him and the vehicle (case of B-2-B-2-C). If not specified, this parameter will be set tofleetvalue (deault value).

  • Disclaimer: Since thefleetprofile has a larger data scope, selectingendUserprofile will potentially result in not found status depending on its granted rights and privacy level.

Responses

Response Schema: application/hal+json
createdAt
required
string <date-time>

Date when the resource has been created.

Array of objects (CollisionDetails)
id
required
string
vin
required
string (Vin)

Identifier of a vehicle. Set when retrieving resource in batch mode.

tippedOver
boolean

Indicates if the car tipped over during the collision. Warning : This information is applicable only on vehicles equipped with dedicated sensor and is optionnal.

pedestrian
boolean

Indicates if the collision involve a pedestrian. Warning : This information is applicable only on vehicles equipped with dedicated sensor and is optionnal

updatedAt
string <date-time>
required
object

Response samples

Content type
application/hal+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "details": [
    ],
  • "id": "055d8f0a0089d7b9226989ce2db42511e2e19df8cc106a7fb7d0c7fb92ab2320c0720e94be1ee517b3172da70dd05446a934cccca524172d9add54d8dbce51b14",
  • "vin": "VF3ABCDE0FG123456",
  • "tippedOver": true,
  • "pedestrian": false,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Maintenance details of a vehicle.

Returns the latest Maintenance information for a Vehicle.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

vid
required
string

Resource is related to this Vehicle ID only.

query Parameters
profile
string (DataProfile)
Enum: "fleet" "endUser"

Results will contain a relative view of the data depending on the selected profile. Indeed, endUser will expose only the data available to the end-user as if there were no intermediaries between him and the vehicle (case of B-2-B-2-C). If not specified, this parameter will be set tofleetvalue (deault value).

  • Disclaimer: Since thefleetprofile has a larger data scope, selectingendUserprofile will potentially result in not found status depending on its granted rights and privacy level.

Responses

Response Schema: application/hal+json
createdAt
required
string <date-time>

Date when the resource has been created.

updatedAt
string <date-time>

Date when the resource has been updated.

vin
required
string (Vin)

Identifier of a vehicle. Set when retrieving resource in batch mode.

daysBeforeMaintenance
integer
mileageBeforeMaintenance
number <float>
required
object

Response samples

Content type
application/hal+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "vin": "VF3ABCDE0FG123456",
  • "daysBeforeMaintenance": 0,
  • "mileageBeforeMaintenance": 0.1,
  • "_links": {
    }
}

Vehicle status.

Returns the latest vehicle status.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

vid
required
string

Resource is related to this Vehicle ID only.

query Parameters
profile
string (DataProfile)
Enum: "fleet" "endUser"

Results will contain a relative view of the data depending on the selected profile. Indeed, endUser will expose only the data available to the end-user as if there were no intermediaries between him and the vehicle (case of B-2-B-2-C). If not specified, this parameter will be set tofleetvalue (deault value).

  • Disclaimer: Since thefleetprofile has a larger data scope, selectingendUserprofile will potentially result in not found status depending on its granted rights and privacy level.

Responses

Response Schema: application/hal+json
createdAt
required
string <date-time>

Date when the resource has been created.

updatedAt
string <date-time>

Date when the resource has been updated.

required
object
vin
required
string (Vin)

Identifier of a vehicle. Set when retrieving resource in batch mode.

object (Ignition)
object (Position)
object (Preconditioning)

Preconditioning the vehicle for driver and passenger.

Array of objects (Energy)
Array of objects (Engine)
object (Transmission)
object (Powertrain)
object (Adas)
object (DoorsState)
object (Privacy)
object (Battery)

Describe the car (with combustion engine) battery status.

object (ServiceType)
Deprecated
object (Safety)
object (VehicleOdometer)
object (Kinetic)

Everything related to the movement of the vehicle. Speed, acceleration..

object (Environment)
object (DrivingBehavior)
object (WipingBladesState)
object (LightingSystem)

Expresses the Directional, Fog and Position vehicle lights.

object (VehicleStatusAlarm)

Describes the vehicle alarm status or trigger. Only one is present.

object (StolenObj)

Vehicle Stolen active status (only returns when vehicle is reported stolen).

object

Response samples

Content type
application/hal+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "_links": {
    },
  • "vin": "VF3ABCDE0FG123456",
  • "ignition": {
    },
  • "lastPosition": {
    },
  • "preconditioning": {
    },
  • "energies": [
    ],
  • "engines": [
    ],
  • "transmission": {
    },
  • "powertrain": {
    },
  • "adas": {
    },
  • "doorsState": {
    },
  • "privacy": {
    },
  • "battery": {
    },
  • "service": {
    },
  • "safety": {
    },
  • "odometer": {
    },
  • "kinetic": {
    },
  • "environment": {
    },
  • "drivingBehavior": {
    },
  • "wipingBlades": {
    },
  • "lightingSystem": {
    },
  • "alarm": {
    },
  • "stolen": {
    },
  • "_embedded": {
    }
}

Alerts related to a vehicle.

Returns the latest alert messages for a Vehicle.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

vid
required
string

Resource is related to this Vehicle ID only.

query Parameters
profile
string (DataProfile)
Enum: "fleet" "endUser"

Results will contain a relative view of the data depending on the selected profile. Indeed, endUser will expose only the data available to the end-user as if there were no intermediaries between him and the vehicle (case of B-2-B-2-C). If not specified, this parameter will be set tofleetvalue (deault value).

  • Disclaimer: Since thefleetprofile has a larger data scope, selectingendUserprofile will potentially result in not found status depending on its granted rights and privacy level.
timestamps
Array of strings [ 1 .. 10 ] items [ items\w?/\w? ]

Array of "timestamp" ranges. Results will contain results whose timestamps are included in those date-time ranges (see timestamp data model)."timestamp" items should be expressed as in 'RFC3339'. Each element of the array expresses a time range (with the pattern \w?/\w? or R\d?/w/w(/w)?) which is the period between two or more times. The range can be expressed by tw o times Points (start and end Timestamps), by a start Timestamp Point and a Duration or as a repeating interval. All of them should be expressed using the RFC3339 and the interval format is based on ISO8601

  • 'T1/T2' interval time from low limit T1 to hight T2
  • 'T1/D' interval time from low limit T1 with duration = D ( T2=T1+D)
  • 'T/' endless range, known start Timestamp but no end Timestamp. The current time will be used as the high time limit.
  • '/T' startless range, known end date but no start date. No lower limit will be used to retrieve results.
  • Rn/T/D/[d] repeat the interval of D n times starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H
  • R/T/D/[d] unbounded number of repetitions starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H.
  • T is a timestamp and D is a duration as defined in RFC3339.
    • 2018-01-01T09:00:00+01:00/2018-01-01T12:00:00+01:00* known low and hight limits.
    • 2018-01-03T12:00:00+01:00/P3Y6M4DT12H30M5S known low limit, hight limit = start + duration.
    • 2018-01-03T12:00:00+01:00/ known low limit, hight limit = current time.
    • R5/2018-01-03T12:00:00Z/P6H/P2H repeate duration 6H wiht interval period of 2H for 5 times starting at 2018-01-03T12:00:00Z.
indexRange
string (indexRange) \d+-\d*
Default: "0-"

Results indexes will be included in this range (see indexRange model).

default: 0-

example: 0-, 0-5

pageSize
integer [ 1 .. 60 ]
Default: 60

The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. The range for this parameter is [1...60]

pageToken
string

Start-Page marker, this token is used (by the backend) for continuing serving from the previous results page to the next one. (Disclaimer: It is built and used only by the server).

Responses

Response Schema: application/hal+json
required
object (Tab_Links)

HAL (Hypertext Application Language) link collection

total
required
integer
totalPage
required
integer
currentPage
required
integer
required
object

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "total": 0,
  • "totalPage": 0,
  • "currentPage": 0,
  • "_embedded": {
    }
}

An alert related to a vehicle.

Returns information about a specific alert messages for a Vehicle.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

vid
required
string

Resource is related to this Vehicle ID only.

aid
required
string

id of the alert.

query Parameters
profile
string (DataProfile)
Enum: "fleet" "endUser"

Results will contain a relative view of the data depending on the selected profile. Indeed, endUser will expose only the data available to the end-user as if there were no intermediaries between him and the vehicle (case of B-2-B-2-C). If not specified, this parameter will be set tofleetvalue (deault value).

  • Disclaimer: Since thefleetprofile has a larger data scope, selectingendUserprofile will potentially result in not found status depending on its granted rights and privacy level.

Responses

Response Schema: application/hal+json
createdAt
required
string <date-time>

Date when the resource has been created.

updatedAt
string <date-time>

Date when the resource has been updated.

required
object
id
required
string
vin
required
string (Vin)

Identifier of a vehicle. Set when retrieving resource in batch mode.

active
required
boolean
type
required
string (AlertMsgEnum)
Enum: "AbsBrakingSystemFault" "ActiveSpoilerFault" "AdBlueFault" "AdBlueFaultStartingImpossible" "AdBlueFaultStartingImpossibleSoon" "AddWasherFluid" "AirbagOrSeatBeltPretensionerOrActiveHoodFailure" "AssistanceButtonFault" "AutomaticBrakingDeactivated" "AutomaticHeadlightAdjustmentFault" "BatteryChargeOrElectricalCircuitSystemFailure" "BrakingSystemFailure" "ChargingFailure" "CheckTheCenterBrakeLamp" "CollisionDetectionSystemFault" "CollisionMitigationSystemFault" "CoolantLevellow" "DrivingAssistanceSensorBlind" "ElectricTractionSystemFailureLimitSpeed" "ElectricTractionSystemFailureStopVehicle" "ElectricTractionSystemFault" "ElectronicImmobiliserFault" "EmissionSystemOrAdBlueQualityFailueStartingImpossible" "EmissionSystemOrAdBlueQualityFailueStartingImpossibleSoon" "EmissionSystemOrAdBlueQualityFailure" "EngineFailure" "EngineFault" "EngineMisfiringFuel" "EngineOilPressureFailure" "EngineTemperatureFailure" "EspAsrSystemFault" "FrontLeftFlashingIndicatorFault" "FrontLeftFogLampsFault" "FrontLeftParkingLampsFault" "FrontRightFlashingIndicatorFault" "FrontRightFogLampsFault" "FrontRightParkingLampsFault" "FuelLevelLow" "GearboxFault" "HeadlightsFault" "InstalledSpareWheelFault" "InterVehicleTimeMeasurementFault" "LaneChangeAssistanceFault" "LaneDepartureWarningSystemFault" "LeftBrakeLampFault" "LeftFrontDoorOpen" "LeftFrontDoorOpenLowSpeed" "LeftFrontTirePressurSensorFault" "LeftFrontTirePuncture" "LeftFrontTireUnderInflated" "LeftRearDoorOpen" "LeftRearDoorOpenLowSpeed" "LeftRearTirePressurSensorFault" "LeftRearTirePuncture" "LeftRearTireUnderInflated" "LeftReverseLampFault" "OilLevelLow" "ParkAssistSystemFault" "ParkingBrakeOrHillStartSystemFailure" "ParticleFilterAdditiveLevelTooLow" "ParticleFilterFull" "ParticleFilterRegenerating" "PowerSteeringFailure" "PowerSteeringFault" "PreheatingPreventilationDeactivatedBatteryLow" "PreheatingPreventilationDeactivatedClockUnset" "PreheatingPreventilationDeactivatedFuelLevelLow" "RearLeftFlashingIndicatorFault" "RearLeftFogLampsFault" "RearLeftParkingLampsFault" "RearRightFlashingIndicatorFault" "RearRightFogLampsFault" "RearRightParkingLampsFault" "RearWindowOpen" "RearWindowOpenLowSpeed" "ReplaceBrakePads" "ReplaceTheRemoteControlBattery" "RetractableRoofMechanismFault" "RightBrakeLampFault" "RightFrontDoorOpenLowSpeed" "RightFrontDoorOpen" "RightFrontTirePressurSensorFault" "RightFrontTirePuncture" "RightFrontTireUnderInflated" "RightRearDoorOpen" "RightRearDoorOpenLowSpeed" "RightRearTirePressurSensorFault" "RightRearTirePuncture" "RightRearTireUnderInflated" "RightReverseLampFault" "RiskOfIce" "RoofOperationNotPossibleSpeedUnknown" "RoofOperationNotPossibleTooHighTemp" "ShiftToPark" "SteeringLockFault" "SuspensionFault" "SuspensionFaultLimitSpeed" "SuspensionFaultRepaireVehicle" "TireUnderInflationDetectionSystemFault" "TooManyRoofOperation" "TrailerConnectionFault" "TrunkOrHoodOpen" "TrunkOrHoodOpenLowSpeed" "WaterInTheDieselFuelFilter"

MPH alert list

severity
string
Enum: "Information" "Warning" "Critical"

Alert severity level.

Severity Description
Information Better to fix but it is operating accurately.
Warning Should fix it asap.
Critical Starting prohibited without repair.
startedAt
required
string <date-time>
endAt
string <date-time>
object (Position)

The position (last vehicle known one) where the alert appears.

object (Position)

The position (last vehicle known one) where the alert disappears.

Response samples

Content type
application/hal+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "_links": {
    },
  • "id": "0a9de72cc3803b12a74418acd20dcd66634fa82e44b2ec7060bca91462dc5772199559905caefe168812918d47f67253f33d477b645bb59afdd1268b81e382999",
  • "vin": "VF3ABCDE0FG123456",
  • "active": true,
  • "type": "AbsBrakingSystemFault",
  • "severity": "Information",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "endAt": "2019-08-24T14:15:22Z",
  • "startPosition": {
    },
  • "endPosition": {
    }
}

Telemetry of vehicle

Returns the latest Telemetry messages that occurred during a selective timestamp-ranges and bounded by an index range.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

vid
required
string

Resource is related to this Vehicle ID only.

query Parameters
profile
string (DataProfile)
Enum: "fleet" "endUser"

Results will contain a relative view of the data depending on the selected profile. Indeed, endUser will expose only the data available to the end-user as if there were no intermediaries between him and the vehicle (case of B-2-B-2-C). If not specified, this parameter will be set tofleetvalue (deault value).

  • Disclaimer: Since thefleetprofile has a larger data scope, selectingendUserprofile will potentially result in not found status depending on its granted rights and privacy level.
timestamps
Array of strings [ 1 .. 10 ] items [ items\w?/\w? ]

Array of "timestamp" ranges. Results will contain results whose timestamps are included in those date-time ranges (see timestamp data model)."timestamp" items should be expressed as in 'RFC3339'. Each element of the array expresses a time range (with the pattern \w?/\w? or R\d?/w/w(/w)?) which is the period between two or more times. The range can be expressed by tw o times Points (start and end Timestamps), by a start Timestamp Point and a Duration or as a repeating interval. All of them should be expressed using the RFC3339 and the interval format is based on ISO8601

  • 'T1/T2' interval time from low limit T1 to hight T2
  • 'T1/D' interval time from low limit T1 with duration = D ( T2=T1+D)
  • 'T/' endless range, known start Timestamp but no end Timestamp. The current time will be used as the high time limit.
  • '/T' startless range, known end date but no start date. No lower limit will be used to retrieve results.
  • Rn/T/D/[d] repeat the interval of D n times starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H
  • R/T/D/[d] unbounded number of repetitions starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H.
  • T is a timestamp and D is a duration as defined in RFC3339.
    • 2018-01-01T09:00:00+01:00/2018-01-01T12:00:00+01:00* known low and hight limits.
    • 2018-01-03T12:00:00+01:00/P3Y6M4DT12H30M5S known low limit, hight limit = start + duration.
    • 2018-01-03T12:00:00+01:00/ known low limit, hight limit = current time.
    • R5/2018-01-03T12:00:00Z/P6H/P2H repeate duration 6H wiht interval period of 2H for 5 times starting at 2018-01-03T12:00:00Z.
indexRange
string (indexRange) \d+-\d*
Default: "0-"

Results indexes will be included in this range (see indexRange model).

default: 0-

example: 0-, 0-5

pageSize
integer [ 1 .. 2000 ]
Default: 60

The maximum number of results (for a collection results response) to return per page for high frequency data upload. When not set, at most 60 results will be returned. The range for this parameter is [1...2000]

pageToken
string

Start-Page marker, this token is used (by the backend) for continuing serving from the previous results page to the next one. (Disclaimer: It is built and used only by the server).

type
Array of strings (TelemetryEnum) [ 1 .. 17 ] items
Items Enum: "environment" "privacy" "vehicle" "vehicle.adas" "vehicle.battery" "vehicle.doorsState" "vehicle.energies" "vehicle.engines" "vehicle.ignition" "vehicle.lighting" "vehicle.lightingSystem" "vehicle.safety" "vehicle.transmission" "vehicle.drivingBehavior" "vehicle.alarm.status" "vehicle.alarm.trigger" "vehicle.wipingBlades"

Results will only contain Telemetry messages of this kind. You can add more than one message type. By default, if no type is selected then all telemetries will be taken (the number of elements in this array must be between 1 and 17).

  • Disclaimer: vehicle.lighting is deprecated
extension
Array of strings (TelemetryExtensionType) [ 1 .. 2 ] items
Items Enum: "location" "maintenance"

Additional data set that will be included in embedded field(the number of elements in this array must be between 1 and 2).

Responses

Response Schema: application/hal+json
required
object (Tab_Links)

HAL (Hypertext Application Language) link collection

total
required
integer
totalPage
required
integer
currentPage
required
integer
required
object

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "total": 0,
  • "totalPage": 0,
  • "currentPage": 0,
  • "_embedded": {
    }
}

Vehicle's Alarms

Returns a (filtered) list of alarm for a Vehicle. Note: Timestamp filtering concerns the creation date for status or trigger.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

vid
required
string

Resource is related to this Vehicle ID only.

query Parameters
type
Array of strings (AlarmTypeEnum)
Items Enum: "vehicle.alarm.status" "vehicle.alarm.trigger"

Results will only contain Alarm messages of this type. If no filtering type is selected then all alarms will be taken .

timestamps
Array of strings [ 1 .. 10 ] items [ items\w?/\w? ]

Array of "timestamp" ranges. Results will contain results whose timestamps are included in those date-time ranges (see timestamp data model)."timestamp" items should be expressed as in 'RFC3339'. Each element of the array expresses a time range (with the pattern \w?/\w? or R\d?/w/w(/w)?) which is the period between two or more times. The range can be expressed by tw o times Points (start and end Timestamps), by a start Timestamp Point and a Duration or as a repeating interval. All of them should be expressed using the RFC3339 and the interval format is based on ISO8601

  • 'T1/T2' interval time from low limit T1 to hight T2
  • 'T1/D' interval time from low limit T1 with duration = D ( T2=T1+D)
  • 'T/' endless range, known start Timestamp but no end Timestamp. The current time will be used as the high time limit.
  • '/T' startless range, known end date but no start date. No lower limit will be used to retrieve results.
  • Rn/T/D/[d] repeat the interval of D n times starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H
  • R/T/D/[d] unbounded number of repetitions starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H.
  • T is a timestamp and D is a duration as defined in RFC3339.
    • 2018-01-01T09:00:00+01:00/2018-01-01T12:00:00+01:00* known low and hight limits.
    • 2018-01-03T12:00:00+01:00/P3Y6M4DT12H30M5S known low limit, hight limit = start + duration.
    • 2018-01-03T12:00:00+01:00/ known low limit, hight limit = current time.
    • R5/2018-01-03T12:00:00Z/P6H/P2H repeate duration 6H wiht interval period of 2H for 5 times starting at 2018-01-03T12:00:00Z.
indexRange
string (indexRange) \d+-\d*
Default: "0-"

Results indexes will be included in this range (see indexRange model).

default: 0-

example: 0-, 0-5

pageSize
integer [ 1 .. 60 ]
Default: 60

The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. The range for this parameter is [1...60]

pageToken
string

Start-Page marker, this token is used (by the backend) for continuing serving from the previous results page to the next one. (Disclaimer: It is built and used only by the server).

Responses

Response Schema: application/hal+json
required
object (Tab_Links)

HAL (Hypertext Application Language) link collection

total
required
integer
totalPage
required
integer
currentPage
required
integer
required
object

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "total": 0,
  • "totalPage": 0,
  • "currentPage": 0,
  • "_embedded": {
    }
}

Vehicle's Alarm

Returns information about a specific alarm for a vehicle.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

vid
required
string

Resource is related to this Vehicle ID only.

aid
required
string

id of the alarm.

Responses

Response Schema: application/hal+json
id
required
string
object (AlarmTrigger)

Describe a vehicle alarm trigger.

object (AlarmStatus)

Describe a vehicle alarm status.

Response samples

Content type
application/hal+json
{
  • "trigger": {
    },
  • "status": {
    }
}

Vehicle's stolen history.

Returns list of stolen state for a vehicle.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

vid
required
string

Resource is related to this Vehicle ID only.

query Parameters
timestamps
Array of strings [ 1 .. 10 ] items [ items\w?/\w? ]

Array of "timestamp" ranges. Results will contain results whose timestamps are included in those date-time ranges (see timestamp data model)."timestamp" items should be expressed as in 'RFC3339'. Each element of the array expresses a time range (with the pattern \w?/\w? or R\d?/w/w(/w)?) which is the period between two or more times. The range can be expressed by tw o times Points (start and end Timestamps), by a start Timestamp Point and a Duration or as a repeating interval. All of them should be expressed using the RFC3339 and the interval format is based on ISO8601

  • 'T1/T2' interval time from low limit T1 to hight T2
  • 'T1/D' interval time from low limit T1 with duration = D ( T2=T1+D)
  • 'T/' endless range, known start Timestamp but no end Timestamp. The current time will be used as the high time limit.
  • '/T' startless range, known end date but no start date. No lower limit will be used to retrieve results.
  • Rn/T/D/[d] repeat the interval of D n times starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H
  • R/T/D/[d] unbounded number of repetitions starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H.
  • T is a timestamp and D is a duration as defined in RFC3339.
    • 2018-01-01T09:00:00+01:00/2018-01-01T12:00:00+01:00* known low and hight limits.
    • 2018-01-03T12:00:00+01:00/P3Y6M4DT12H30M5S known low limit, hight limit = start + duration.
    • 2018-01-03T12:00:00+01:00/ known low limit, hight limit = current time.
    • R5/2018-01-03T12:00:00Z/P6H/P2H repeate duration 6H wiht interval period of 2H for 5 times starting at 2018-01-03T12:00:00Z.
indexRange
string (indexRange) \d+-\d*
Default: "0-"

Results indexes will be included in this range (see indexRange model).

default: 0-

example: 0-, 0-5

pageSize
integer [ 1 .. 60 ]
Default: 60

The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. The range for this parameter is [1...60]

pageToken
string

Start-Page marker, this token is used (by the backend) for continuing serving from the previous results page to the next one. (Disclaimer: It is built and used only by the server).

Responses

Response Schema: application/hal+json
required
object (Tab_Links)

HAL (Hypertext Application Language) link collection

total
required
integer
totalPage
required
integer
currentPage
required
integer
required
object

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "total": 0,
  • "totalPage": 0,
  • "currentPage": 0,
  • "_embedded": {
    }
}

Vehicle's stolen state.

Returns information about a specific stolen context for a vehicle.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

vid
required
string

Resource is related to this Vehicle ID only.

sid
required
string

id of the stolen state.

Responses

Response Schema: application/hal+json
createdAt
required
string <date-time>

Date when the resource has been created.

updatedAt
string <date-time>

Date when the resource has been updated.

required
object
id
required
string
state
required
boolean

Stolen state of the vehicle (True means the vhicle is reported stolen).

startedAt
required
string <date-time>

Stolen vehicle start time.

endAt
string <date-time>

Stolen vehicle stop time.

object (Position)

The position (last vehicle known one) where the vehicle is reported stolen.

object (Position)

The position (last vehicle known one) where the stolen state is not active anymore.

Response samples

Content type
application/hal+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "_links": {
    },
  • "id": "0a9de72cc3803b12a74418acd20dcd66634fa82e44b2ec7060bca91462dc5772199559905caefe168812918d47f67253f33d477b645bb59afdd1268b81e382999",
  • "state": true,
  • "startedAt": "2019-08-24T14:15:22Z",
  • "endAt": "2019-08-24T14:15:22Z",
  • "startPosition": {
    },
  • "endPosition": {
    }
}

Vehicle's stolen position.

Returns position information about a specific stolen context for a vehicle.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

vid
required
string

Resource is related to this Vehicle ID only.

sid
required
string

id of the stolen state.

Responses

Response Schema: application/hal+json
required
object (Tab_Links)

HAL (Hypertext Application Language) link collection

total
required
integer
totalPage
required
integer
currentPage
required
integer
required
object

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "total": 0,
  • "totalPage": 0,
  • "currentPage": 0,
  • "_embedded": {
    }
}

Trips

Describe Trips of a Fleet or Vehicle

Vehicle's trip list.

This method returns a list of all Trips that a given Vehicle has taken. This will NOT include Trips that have not yet been completed.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

vid
required
string

Resource is related to this Vehicle ID only.

query Parameters
profile
string (DataProfile)
Enum: "fleet" "endUser"

Results will contain a relative view of the data depending on the selected profile. Indeed, endUser will expose only the data available to the end-user as if there were no intermediaries between him and the vehicle (case of B-2-B-2-C). If not specified, this parameter will be set tofleetvalue (deault value).

  • Disclaimer: Since thefleetprofile has a larger data scope, selectingendUserprofile will potentially result in not found status depending on its granted rights and privacy level.
timestamps
Array of strings [ 1 .. 10 ] items [ items\w?/\w? ]

Array of "timestamp" ranges. Results will contain results whose timestamps are included in those date-time ranges (see timestamp data model)."timestamp" items should be expressed as in 'RFC3339'. Each element of the array expresses a time range (with the pattern \w?/\w? or R\d?/w/w(/w)?) which is the period between two or more times. The range can be expressed by tw o times Points (start and end Timestamps), by a start Timestamp Point and a Duration or as a repeating interval. All of them should be expressed using the RFC3339 and the interval format is based on ISO8601

  • 'T1/T2' interval time from low limit T1 to hight T2
  • 'T1/D' interval time from low limit T1 with duration = D ( T2=T1+D)
  • 'T/' endless range, known start Timestamp but no end Timestamp. The current time will be used as the high time limit.
  • '/T' startless range, known end date but no start date. No lower limit will be used to retrieve results.
  • Rn/T/D/[d] repeat the interval of D n times starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H
  • R/T/D/[d] unbounded number of repetitions starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H.
  • T is a timestamp and D is a duration as defined in RFC3339.
    • 2018-01-01T09:00:00+01:00/2018-01-01T12:00:00+01:00* known low and hight limits.
    • 2018-01-03T12:00:00+01:00/P3Y6M4DT12H30M5S known low limit, hight limit = start + duration.
    • 2018-01-03T12:00:00+01:00/ known low limit, hight limit = current time.
    • R5/2018-01-03T12:00:00Z/P6H/P2H repeate duration 6H wiht interval period of 2H for 5 times starting at 2018-01-03T12:00:00Z.
distance
string (Range) \d+-\d*
Default: "0-"

Trip distance validity interval. It allows to define the min or max duration of a trip.
Unit = Km and format : float (only one digit after the decimal point is aceepted for the interval bounds).

Example:

      * 1-150: Trip with distance between 1 Km and 150 km .

      * 0.1-: Trip with distance  greater than 100 m.

default: 0-

duration
string (Range) \d+-\d*
Default: "0-"

Trip duration validity interval. It allows to define the min or max duration of a trip. Unit = sec

Example:

      * 10-3600: Trip with duration between 10 sec and 1 hour.

      * 20-: Trip with duration greater than 20 sec.

default: 0-

states
Array of strings (TripStateEnumArray)
Items Enum: "Nominal" "Unstarted" "DataLacking" "Unfinished"

Allow to filter for Trips with defined states. Those states can be compound of : Nominal,Unstarted, DataLacking, Unfinished.

Default: All states are allowed.

indexRange
string (indexRange) \d+-\d*
Default: "0-"

Results indexes will be included in this range (see indexRange model).

default: 0-

example: 0-, 0-5

pageSize
integer [ 1 .. 60 ]
Default: 60

The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. The range for this parameter is [1...60]

pageToken
string

Start-Page marker, this token is used (by the backend) for continuing serving from the previous results page to the next one. (Disclaimer: It is built and used only by the server).

Responses

Response Schema: application/hal+json
required
object

HAL (Hypertext Application Language) link collection

total
required
integer
totalPage
required
integer
currentPage
required
integer
required
object

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "total": 0,
  • "totalPage": 0,
  • "currentPage": 0,
  • "_embedded": {
    }
}

Vehicle's trip information.

This method returns the Trip that matches the Trip id (tid) a given Vehicle (id) has taken.

Authorizations:
(BasicAuthClientId)
path Parameters
vid
required
string

Resource is related to this Vehicle ID only.

tid
required
string

The ID {tid} of Trip

fid
required
string

Resource is related to this fleet ID only.

query Parameters
profile
string (DataProfile)
Enum: "fleet" "endUser"

Results will contain a relative view of the data depending on the selected profile. Indeed, endUser will expose only the data available to the end-user as if there were no intermediaries between him and the vehicle (case of B-2-B-2-C). If not specified, this parameter will be set tofleetvalue (deault value).

  • Disclaimer: Since thefleetprofile has a larger data scope, selectingendUserprofile will potentially result in not found status depending on its granted rights and privacy level.

Responses

Response Schema: application/hal+json
createdAt
required
string <date-time>

Date when the resource has been created.

updatedAt
string <date-time>

Date when the resource has been updated.

required
object
id
required
string

Identifier of a trip

vin
required
string (Vin)

Identifier of a vehicle. Set when retrieving resource in batch mode.

startedAt
string <date-time>

Date & Time when the trip started

stoppedAt
string <date-time>

Date & Time when the trip stopped

object (Position)
object (Position)
duration
integer

Duration in second of the trip

distance
number <float>

Distance in km of the trip

startMileage
number <float>

Vehicle mileage at the trip starting time.

Array of objects (LiteEnergy)

Vehicle energies levels and autonomies at the trip start time.

Array of objects (LiteEnergy)

Vehicle energies levels and autonomies at the trip end time.

Array of objects (EnergyConsumption)

The consumptions of different energies during this trip.

object

Expresses the max and average vehicle speed during this trip.

Array of objects (TripSegment)

The parts of the trip crossed for each type of propulsion.

done
boolean

Determines either this trip is finished or not.

Array of objects

Faults of this finished or in progress trip. This means that we lacked data from the vehicle to complete the trip description during one of its step (starting, progressing, or finishing).

Response samples

Content type
application/hal+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "_links": {
    },
  • "id": "string",
  • "vin": "VF3ABCDE0FG123456",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "stoppedAt": "2019-08-24T14:15:22Z",
  • "startPosition": {
    },
  • "stopPosition": {
    },
  • "duration": 0,
  • "distance": 0.1,
  • "startMileage": 0.1,
  • "startEnergies": [
    ],
  • "endEnergies": [
    ],
  • "energyConsumptions": [
    ],
  • "kinetic": {
    },
  • "segments": [
    ],
  • "done": true,
  • "faults": [
    ]
}

Vehicle's trip collision list.

Returns the list of Collisions of a vehicle that occurred during a trip and bounded (optional) by a timestamp ranges and an index range.

Authorizations:
(BasicAuthClientId)
path Parameters
vid
required
string

Resource is related to this Vehicle ID only.

fid
required
string

Resource is related to this fleet ID only.

tid
required
string

The ID {tid} of Trip

query Parameters
pageToken
string

Start-Page marker, this token is used (by the backend) for continuing serving from the previous results page to the next one. (Disclaimer: It is built and used only by the server).

timestamps
Array of strings [ 1 .. 10 ] items [ items\w?/\w? ]

Array of "timestamp" ranges. Results will contain results whose timestamps are included in those date-time ranges (see timestamp data model)."timestamp" items should be expressed as in 'RFC3339'. Each element of the array expresses a time range (with the pattern \w?/\w? or R\d?/w/w(/w)?) which is the period between two or more times. The range can be expressed by tw o times Points (start and end Timestamps), by a start Timestamp Point and a Duration or as a repeating interval. All of them should be expressed using the RFC3339 and the interval format is based on ISO8601

  • 'T1/T2' interval time from low limit T1 to hight T2
  • 'T1/D' interval time from low limit T1 with duration = D ( T2=T1+D)
  • 'T/' endless range, known start Timestamp but no end Timestamp. The current time will be used as the high time limit.
  • '/T' startless range, known end date but no start date. No lower limit will be used to retrieve results.
  • Rn/T/D/[d] repeat the interval of D n times starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H
  • R/T/D/[d] unbounded number of repetitions starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H.
  • T is a timestamp and D is a duration as defined in RFC3339.
    • 2018-01-01T09:00:00+01:00/2018-01-01T12:00:00+01:00* known low and hight limits.
    • 2018-01-03T12:00:00+01:00/P3Y6M4DT12H30M5S known low limit, hight limit = start + duration.
    • 2018-01-03T12:00:00+01:00/ known low limit, hight limit = current time.
    • R5/2018-01-03T12:00:00Z/P6H/P2H repeate duration 6H wiht interval period of 2H for 5 times starting at 2018-01-03T12:00:00Z.
indexRange
string (indexRange) \d+-\d*
Default: "0-"

Results indexes will be included in this range (see indexRange model).

default: 0-

example: 0-, 0-5

pageSize
integer [ 1 .. 60 ]
Default: 60

The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. The range for this parameter is [1...60]

Responses

Response Schema: application/hal+json
required
object (Tab_Links)

HAL (Hypertext Application Language) link collection

total
required
integer
totalPage
required
integer
currentPage
required
integer
required
object

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "total": 0,
  • "totalPage": 0,
  • "currentPage": 0,
  • "_embedded": {
    }
}

Vehicle's trip alert list.

Returns the alert message list for a given vehicle.

Authorizations:
(BasicAuthClientId)
path Parameters
vid
required
string

Resource is related to this Vehicle ID only.

tid
required
string

The ID {tid} of Trip

fid
required
string

Resource is related to this fleet ID only.

query Parameters
timestamps
Array of strings [ 1 .. 10 ] items [ items\w?/\w? ]

Array of "timestamp" ranges. Results will contain results whose timestamps are included in those date-time ranges (see timestamp data model)."timestamp" items should be expressed as in 'RFC3339'. Each element of the array expresses a time range (with the pattern \w?/\w? or R\d?/w/w(/w)?) which is the period between two or more times. The range can be expressed by tw o times Points (start and end Timestamps), by a start Timestamp Point and a Duration or as a repeating interval. All of them should be expressed using the RFC3339 and the interval format is based on ISO8601

  • 'T1/T2' interval time from low limit T1 to hight T2
  • 'T1/D' interval time from low limit T1 with duration = D ( T2=T1+D)
  • 'T/' endless range, known start Timestamp but no end Timestamp. The current time will be used as the high time limit.
  • '/T' startless range, known end date but no start date. No lower limit will be used to retrieve results.
  • Rn/T/D/[d] repeat the interval of D n times starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H
  • R/T/D/[d] unbounded number of repetitions starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H.
  • T is a timestamp and D is a duration as defined in RFC3339.
    • 2018-01-01T09:00:00+01:00/2018-01-01T12:00:00+01:00* known low and hight limits.
    • 2018-01-03T12:00:00+01:00/P3Y6M4DT12H30M5S known low limit, hight limit = start + duration.
    • 2018-01-03T12:00:00+01:00/ known low limit, hight limit = current time.
    • R5/2018-01-03T12:00:00Z/P6H/P2H repeate duration 6H wiht interval period of 2H for 5 times starting at 2018-01-03T12:00:00Z.
indexRange
string (indexRange) \d+-\d*
Default: "0-"

Results indexes will be included in this range (see indexRange model).

default: 0-

example: 0-, 0-5

pageSize
integer [ 1 .. 60 ]
Default: 60

The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. The range for this parameter is [1...60]

pageToken
string

Start-Page marker, this token is used (by the backend) for continuing serving from the previous results page to the next one. (Disclaimer: It is built and used only by the server).

profile
string (DataProfile)
Enum: "fleet" "endUser"

Results will contain a relative view of the data depending on the selected profile. Indeed, endUser will expose only the data available to the end-user as if there were no intermediaries between him and the vehicle (case of B-2-B-2-C). If not specified, this parameter will be set tofleetvalue (deault value).

  • Disclaimer: Since thefleetprofile has a larger data scope, selectingendUserprofile will potentially result in not found status depending on its granted rights and privacy level.

Responses

Response Schema: application/hal+json
required
object (Tab_Links)

HAL (Hypertext Application Language) link collection

total
required
integer
totalPage
required
integer
currentPage
required
integer
required
object

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "total": 0,
  • "totalPage": 0,
  • "currentPage": 0,
  • "_embedded": {
    }
}

Vehicle's trip specific alert.

Returns the alert message list for a given vehicle that occure during a trip.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

vid
required
string

Resource is related to this Vehicle ID only.

tid
required
string

The ID {tid} of Trip

aid
required
string

id of the alert.

query Parameters
profile
string (DataProfile)
Enum: "fleet" "endUser"

Results will contain a relative view of the data depending on the selected profile. Indeed, endUser will expose only the data available to the end-user as if there were no intermediaries between him and the vehicle (case of B-2-B-2-C). If not specified, this parameter will be set tofleetvalue (deault value).

  • Disclaimer: Since thefleetprofile has a larger data scope, selectingendUserprofile will potentially result in not found status depending on its granted rights and privacy level.

Responses

Response Schema: application/hal+json
createdAt
required
string <date-time>

Date when the resource has been created.

updatedAt
string <date-time>

Date when the resource has been updated.

required
object
id
required
string
vin
required
string (Vin)

Identifier of a vehicle. Set when retrieving resource in batch mode.

active
required
boolean
type
required
string (AlertMsgEnum)
Enum: "AbsBrakingSystemFault" "ActiveSpoilerFault" "AdBlueFault" "AdBlueFaultStartingImpossible" "AdBlueFaultStartingImpossibleSoon" "AddWasherFluid" "AirbagOrSeatBeltPretensionerOrActiveHoodFailure" "AssistanceButtonFault" "AutomaticBrakingDeactivated" "AutomaticHeadlightAdjustmentFault" "BatteryChargeOrElectricalCircuitSystemFailure" "BrakingSystemFailure" "ChargingFailure" "CheckTheCenterBrakeLamp" "CollisionDetectionSystemFault" "CollisionMitigationSystemFault" "CoolantLevellow" "DrivingAssistanceSensorBlind" "ElectricTractionSystemFailureLimitSpeed" "ElectricTractionSystemFailureStopVehicle" "ElectricTractionSystemFault" "ElectronicImmobiliserFault" "EmissionSystemOrAdBlueQualityFailueStartingImpossible" "EmissionSystemOrAdBlueQualityFailueStartingImpossibleSoon" "EmissionSystemOrAdBlueQualityFailure" "EngineFailure" "EngineFault" "EngineMisfiringFuel" "EngineOilPressureFailure" "EngineTemperatureFailure" "EspAsrSystemFault" "FrontLeftFlashingIndicatorFault" "FrontLeftFogLampsFault" "FrontLeftParkingLampsFault" "FrontRightFlashingIndicatorFault" "FrontRightFogLampsFault" "FrontRightParkingLampsFault" "FuelLevelLow" "GearboxFault" "HeadlightsFault" "InstalledSpareWheelFault" "InterVehicleTimeMeasurementFault" "LaneChangeAssistanceFault" "LaneDepartureWarningSystemFault" "LeftBrakeLampFault" "LeftFrontDoorOpen" "LeftFrontDoorOpenLowSpeed" "LeftFrontTirePressurSensorFault" "LeftFrontTirePuncture" "LeftFrontTireUnderInflated" "LeftRearDoorOpen" "LeftRearDoorOpenLowSpeed" "LeftRearTirePressurSensorFault" "LeftRearTirePuncture" "LeftRearTireUnderInflated" "LeftReverseLampFault" "OilLevelLow" "ParkAssistSystemFault" "ParkingBrakeOrHillStartSystemFailure" "ParticleFilterAdditiveLevelTooLow" "ParticleFilterFull" "ParticleFilterRegenerating" "PowerSteeringFailure" "PowerSteeringFault" "PreheatingPreventilationDeactivatedBatteryLow" "PreheatingPreventilationDeactivatedClockUnset" "PreheatingPreventilationDeactivatedFuelLevelLow" "RearLeftFlashingIndicatorFault" "RearLeftFogLampsFault" "RearLeftParkingLampsFault" "RearRightFlashingIndicatorFault" "RearRightFogLampsFault" "RearRightParkingLampsFault" "RearWindowOpen" "RearWindowOpenLowSpeed" "ReplaceBrakePads" "ReplaceTheRemoteControlBattery" "RetractableRoofMechanismFault" "RightBrakeLampFault" "RightFrontDoorOpenLowSpeed" "RightFrontDoorOpen" "RightFrontTirePressurSensorFault" "RightFrontTirePuncture" "RightFrontTireUnderInflated" "RightRearDoorOpen" "RightRearDoorOpenLowSpeed" "RightRearTirePressurSensorFault" "RightRearTirePuncture" "RightRearTireUnderInflated" "RightReverseLampFault" "RiskOfIce" "RoofOperationNotPossibleSpeedUnknown" "RoofOperationNotPossibleTooHighTemp" "ShiftToPark" "SteeringLockFault" "SuspensionFault" "SuspensionFaultLimitSpeed" "SuspensionFaultRepaireVehicle" "TireUnderInflationDetectionSystemFault" "TooManyRoofOperation" "TrailerConnectionFault" "TrunkOrHoodOpen" "TrunkOrHoodOpenLowSpeed" "WaterInTheDieselFuelFilter"

MPH alert list

severity
string
Enum: "Information" "Warning" "Critical"

Alert severity level.

Severity Description
Information Better to fix but it is operating accurately.
Warning Should fix it asap.
Critical Starting prohibited without repair.
startedAt
required
string <date-time>
endAt
string <date-time>
object (Position)

The position (last vehicle known one) where the alert appears.

object (Position)

The position (last vehicle known one) where the alert disappears.

Response samples

Content type
application/hal+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "_links": {
    },
  • "id": "0a9de72cc3803b12a74418acd20dcd66634fa82e44b2ec7060bca91462dc5772199559905caefe168812918d47f67253f33d477b645bb59afdd1268b81e382999",
  • "vin": "VF3ABCDE0FG123456",
  • "active": true,
  • "type": "AbsBrakingSystemFault",
  • "severity": "Information",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "endAt": "2019-08-24T14:15:22Z",
  • "startPosition": {
    },
  • "endPosition": {
    }
}

Vehicle's trip waypoints.

Gives the Vehicle's wayPoints for a specified Trip.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

vid
required
string

Resource is related to this Vehicle ID only.

tid
required
string

The ID {tid} of Trip

query Parameters
indexRange
string (indexRange) \d+-\d*
Default: "0-"

Results indexes will be included in this range (see indexRange model).

default: 0-

example: 0-, 0-5

timestamps
Array of strings [ 1 .. 10 ] items [ items\w?/\w? ]

Array of "timestamp" ranges. Results will contain results whose timestamps are included in those date-time ranges (see timestamp data model)."timestamp" items should be expressed as in 'RFC3339'. Each element of the array expresses a time range (with the pattern \w?/\w? or R\d?/w/w(/w)?) which is the period between two or more times. The range can be expressed by tw o times Points (start and end Timestamps), by a start Timestamp Point and a Duration or as a repeating interval. All of them should be expressed using the RFC3339 and the interval format is based on ISO8601

  • 'T1/T2' interval time from low limit T1 to hight T2
  • 'T1/D' interval time from low limit T1 with duration = D ( T2=T1+D)
  • 'T/' endless range, known start Timestamp but no end Timestamp. The current time will be used as the high time limit.
  • '/T' startless range, known end date but no start date. No lower limit will be used to retrieve results.
  • Rn/T/D/[d] repeat the interval of D n times starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H
  • R/T/D/[d] unbounded number of repetitions starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H.
  • T is a timestamp and D is a duration as defined in RFC3339.
    • 2018-01-01T09:00:00+01:00/2018-01-01T12:00:00+01:00* known low and hight limits.
    • 2018-01-03T12:00:00+01:00/P3Y6M4DT12H30M5S known low limit, hight limit = start + duration.
    • 2018-01-03T12:00:00+01:00/ known low limit, hight limit = current time.
    • R5/2018-01-03T12:00:00Z/P6H/P2H repeate duration 6H wiht interval period of 2H for 5 times starting at 2018-01-03T12:00:00Z.
tolerance
number <float>

Tolerance factor is expressed in length km unit and is used to simplify path by reducing the total number of points by is using Douglas-Peucker algorithm to find a similar curve with fewer points (find more info here: Ramer_Douglas_Peucker_algorithm ).

profile
string (DataProfile)
Enum: "fleet" "endUser"

Results will contain a relative view of the data depending on the selected profile. Indeed, endUser will expose only the data available to the end-user as if there were no intermediaries between him and the vehicle (case of B-2-B-2-C). If not specified, this parameter will be set tofleetvalue (deault value).

  • Disclaimer: Since thefleetprofile has a larger data scope, selectingendUserprofile will potentially result in not found status depending on its granted rights and privacy level.
pageSize
integer [ 1 .. 2000 ]
Default: 60

The maximum number of results (for a collection results response) to return per page for high frequency data upload. When not set, at most 60 results will be returned. The range for this parameter is [1...2000]

pageToken
string

Start-Page marker, this token is used (by the backend) for continuing serving from the previous results page to the next one. (Disclaimer: It is built and used only by the server).

Responses

Response Schema: application/hal+json
required
object (Tab_Links)

HAL (Hypertext Application Language) link collection

total
required
integer
totalPage
required
integer
currentPage
required
integer
required
object

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "total": 0,
  • "totalPage": 0,
  • "currentPage": 0,
  • "_embedded": {
    }
}

Vehicle's trip telemetry.

Returns the set of Telemetry values that occurred for a given vehicle (id) and a speific Trip (tid) during the timestamp ranges and bounded by an index range.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

vid
required
string

Resource is related to this Vehicle ID only.

tid
required
string

The ID {tid} of Trip

query Parameters
profile
string (DataProfile)
Enum: "fleet" "endUser"

Results will contain a relative view of the data depending on the selected profile. Indeed, endUser will expose only the data available to the end-user as if there were no intermediaries between him and the vehicle (case of B-2-B-2-C). If not specified, this parameter will be set tofleetvalue (deault value).

  • Disclaimer: Since thefleetprofile has a larger data scope, selectingendUserprofile will potentially result in not found status depending on its granted rights and privacy level.
timestamps
Array of strings [ 1 .. 10 ] items [ items\w?/\w? ]

Array of "timestamp" ranges. Results will contain results whose timestamps are included in those date-time ranges (see timestamp data model)."timestamp" items should be expressed as in 'RFC3339'. Each element of the array expresses a time range (with the pattern \w?/\w? or R\d?/w/w(/w)?) which is the period between two or more times. The range can be expressed by tw o times Points (start and end Timestamps), by a start Timestamp Point and a Duration or as a repeating interval. All of them should be expressed using the RFC3339 and the interval format is based on ISO8601

  • 'T1/T2' interval time from low limit T1 to hight T2
  • 'T1/D' interval time from low limit T1 with duration = D ( T2=T1+D)
  • 'T/' endless range, known start Timestamp but no end Timestamp. The current time will be used as the high time limit.
  • '/T' startless range, known end date but no start date. No lower limit will be used to retrieve results.
  • Rn/T/D/[d] repeat the interval of D n times starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H
  • R/T/D/[d] unbounded number of repetitions starting at T using d (extension of the standard and not mandatory) as range duration. The default (duration) value of d is 24 H.
  • T is a timestamp and D is a duration as defined in RFC3339.
    • 2018-01-01T09:00:00+01:00/2018-01-01T12:00:00+01:00* known low and hight limits.
    • 2018-01-03T12:00:00+01:00/P3Y6M4DT12H30M5S known low limit, hight limit = start + duration.
    • 2018-01-03T12:00:00+01:00/ known low limit, hight limit = current time.
    • R5/2018-01-03T12:00:00Z/P6H/P2H repeate duration 6H wiht interval period of 2H for 5 times starting at 2018-01-03T12:00:00Z.
indexRange
string (indexRange) \d+-\d*
Default: "0-"

Results indexes will be included in this range (see indexRange model).

default: 0-

example: 0-, 0-5

pageSize
integer [ 1 .. 2000 ]
Default: 60

The maximum number of results (for a collection results response) to return per page for high frequency data upload. When not set, at most 60 results will be returned. The range for this parameter is [1...2000]

pageToken
string

Start-Page marker, this token is used (by the backend) for continuing serving from the previous results page to the next one. (Disclaimer: It is built and used only by the server).

type
Array of strings (TelemetryEnum) [ 1 .. 17 ] items
Items Enum: "environment" "privacy" "vehicle" "vehicle.adas" "vehicle.battery" "vehicle.doorsState" "vehicle.energies" "vehicle.engines" "vehicle.ignition" "vehicle.lighting" "vehicle.lightingSystem" "vehicle.safety" "vehicle.transmission" "vehicle.drivingBehavior" "vehicle.alarm.status" "vehicle.alarm.trigger" "vehicle.wipingBlades"

Results will only contain Telemetry messages of this kind. You can add more than one message type. By default, if no type is selected then all telemetries will be taken (the number of elements in this array must be between 1 and 17).

  • Disclaimer: vehicle.lighting is deprecated
extension
Array of strings (TelemetryExtensionType) [ 1 .. 2 ] items
Items Enum: "location" "maintenance"

Additional data set that will be included in embedded field(the number of elements in this array must be between 1 and 2).

Responses

Response Schema: application/hal+json
required
object (Tab_Links)

HAL (Hypertext Application Language) link collection

total
required
integer
totalPage
required
integer
currentPage
required
integer
required
object

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "total": 0,
  • "totalPage": 0,
  • "currentPage": 0,
  • "_embedded": {
    }
}

Monitors

Vehicles monitors.

Get all monitors of the fleet.

Returns the list of subscribed Monitors of the fleet.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

query Parameters
indexRange
string (indexRange) \d+-\d*
Default: "0-"

Results indexes will be included in this range (see indexRange model).

default: 0-

example: 0-, 0-5

pageSize
integer [ 1 .. 60 ]
Default: 60

The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. The range for this parameter is [1...60]

pageToken
string

Start-Page marker, this token is used (by the backend) for continuing serving from the previous results page to the next one. (Disclaimer: It is built and used only by the server).

Responses

Response Schema: application/hal+json
required
object (Tab_Links)

HAL (Hypertext Application Language) link collection

total
required
integer
totalPage
required
integer
currentPage
required
integer
required
object

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "total": 0,
  • "totalPage": 0,
  • "currentPage": 0,
  • "_embedded": {
    }
}

Create a new Monitor.

Create a Monitor for all Vehicles of the fleet. This is a kind of vehicle monitor that generates an event following the transition state of one of the (monitored) data of the vehicles. As for example the fuel level, the moving out of a defined geographical area.

When the trigger occurs, the built event expressed as a JSON object will be sent over the subscribed callback.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

Request Body schema: application/json
label
required
string

Monitor label (usually its name).

required
object (MonitorCallbackSubscribe)

Callback subscription parameters.

extendedEventParam
Array of any
Items Enum: "vehicle.doorsState" "vehicle.status" "vehicle.maintenance" "vehicle.position" "vehicle.telemetry" "vehicle.alerts" "vehicle.collisions" "vehicle.trip" "vehicle.stolen"

Allow to set extra vehicle data (defined in data model) to add to the monitor event when publishing. The possible values are :

value description Related model
vehicle.doorsState Latest known door state (timestamped) before the eventDate DoorState
vehicle.status Latest known vehicle status (timestamped) before the eventDate Status
vehicle.maintenance Latest known maintenance(timestamped) before the eventDate Maintenance
vehicle.position Last vehicle position (timestamped) before the eventDate Position
vehicle.telemetry${.TelemetryEnum} Latest known telemetry (timestamped) before the eventDate filtered with type Telemetry
vehicle.alerts List of active alerts at the eventDate Alert
vehicle.collisions Latest known collisions before the eventDate Collision
vehicle.trip Trip related to the event that triggers the notification Trip
vehicle.stolen Vehicle Stolen context at the eventDate (only returns when vehicle is reported stolen) Stolen
  • For telemetry extension:
    • The suffix ${.TelemetryEnum} can be selected to refine with telemetry type (from the TelemetryEnum list). This value (with suffix) can be selected several times to included suitable telemetry messages with the extention.
    • Using vehicle.telemetry without suffix means to include all available telemetries.
  • The set of data will then correspond to the union of extensions used in the request.
required
object

Monitor trigger-param that allows to compound triggers by applying a boolean expression to evaluate them.

Responses

Response Schema: application/hal+json
createdAt
required
string <date-time>

Date when the resource has been created.

updatedAt
required
string <date-time>
object
monitorId
required
string (MonitorId)

Uniq monitor ID returned when the monitor was created succefully.

status
required
string (MonitorStatus)
Enum: "Running" "Paused" "Failed"

Request samples

Content type
application/json
{
  • "label": "string",
  • "subscribeParam": {
    },
  • "extendedEventParam": [
    ],
  • "triggerParam": {
    }
}

Response samples

Content type
application/hal+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "_links": {
    },
  • "monitorId": "string",
  • "status": "Running"
}

Update an existing Monitor.

Update an existing Monitor that has been posted (and accepted previously) for this fleet. The monitor object (body) provided should be complete because the aggregation is not supported for the update of the monitor. You can first retrieve this object using the GET /monitor/{mid} API, then modify it and finally publish it (via this PUT API).

Authorizations:
(BasicAuthClientId)
path Parameters
mid
required
string

id of the monitor.

fid
required
string

Resource is related to this fleet ID only.

Request Body schema: application/json
label
required
string

Monitor label (usually its name).

required
object (MonitorCallbackSubscribe)

Callback subscription parameters.

extendedEventParam
Array of any
Items Enum: "vehicle.doorsState" "vehicle.status" "vehicle.maintenance" "vehicle.position" "vehicle.telemetry" "vehicle.alerts" "vehicle.collisions" "vehicle.trip" "vehicle.stolen"

Allow to set extra vehicle data (defined in data model) to add to the monitor event when publishing. The possible values are :

value description Related model
vehicle.doorsState Latest known door state (timestamped) before the eventDate DoorState
vehicle.status Latest known vehicle status (timestamped) before the eventDate Status
vehicle.maintenance Latest known maintenance(timestamped) before the eventDate Maintenance
vehicle.position Last vehicle position (timestamped) before the eventDate Position
vehicle.telemetry${.TelemetryEnum} Latest known telemetry (timestamped) before the eventDate filtered with type Telemetry
vehicle.alerts List of active alerts at the eventDate Alert
vehicle.collisions Latest known collisions before the eventDate Collision
vehicle.trip Trip related to the event that triggers the notification Trip
vehicle.stolen Vehicle Stolen context at the eventDate (only returns when vehicle is reported stolen) Stolen
  • For telemetry extension:
    • The suffix ${.TelemetryEnum} can be selected to refine with telemetry type (from the TelemetryEnum list). This value (with suffix) can be selected several times to included suitable telemetry messages with the extention.
    • Using vehicle.telemetry without suffix means to include all available telemetries.
  • The set of data will then correspond to the union of extensions used in the request.
required
object

Monitor trigger-param that allows to compound triggers by applying a boolean expression to evaluate them.

Responses

Response Schema: application/hal+json
createdAt
required
string <date-time>

Date when the resource has been created.

updatedAt
required
string <date-time>
object
monitorId
required
string (MonitorId)

Uniq monitor ID returned when the monitor was created succefully.

status
required
string (MonitorStatus)
Enum: "Running" "Paused" "Failed"

Request samples

Content type
application/json
{
  • "label": "string",
  • "subscribeParam": {
    },
  • "extendedEventParam": [
    ],
  • "triggerParam": {
    }
}

Response samples

Content type
application/hal+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "_links": {
    },
  • "monitorId": "string",
  • "status": "Running"
}

Get the monitor by monitor Id.

Returns information about a specific Monitor for a given fleet.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

mid
required
string

id of the monitor.

Responses

Response Schema: application/hal+json
createdAt
required
string <date-time>

Date when the resource has been created.

updatedAt
required
string <date-time>
required
object
monitorId
required
string (MonitorId)

Uniq monitor ID returned when the monitor was created succefully.

required
object (MonitorParameter)

MonitorParameter

status
required
string (MonitorStatus)
Enum: "Running" "Paused" "Failed"

Response samples

Content type
application/hal+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "_links": {
    },
  • "monitorId": "string",
  • "monitor": {
    },
  • "status": "Running"
}

Delete an existing Monitor.

Stop (disable) an existing Monitor.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

mid
required
string

id of the monitor.

Responses

Set a new monitor status.

Set monitor status.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

mid
required
string

id of the monitor.

Request Body schema: application/json
status
required
string
Enum: "Running" "Paused"

Responses

Response Schema: application/hal+json
createdAt
required
string <date-time>

Date when the resource has been created.

updatedAt
required
string <date-time>
object
monitorId
required
string (MonitorId)

Uniq monitor ID returned when the monitor was created succefully.

status
required
string (MonitorStatus)
Enum: "Running" "Paused" "Failed"

Request samples

Content type
application/json
{
  • "status": "Paused"
}

Response samples

Content type
application/hal+json
{
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "_links": {
    },
  • "monitorId": "string",
  • "status": "Running"
}

Remote

Vehicle remote access.

Get all remote callbacks of a fleet.

Returns the list of subscribed remote callback of the fleet.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

query Parameters
types
Array of strings (RemoteTypes)
Items Enum: "ThermalPreconditioning" "ElectricBatteryChargingRequest" "Horn" "Doors" "Lights" "Immobilization" "Stolen" "WakeUp" "Navigation"
Example: types=Doors

Results will contain only the Remote-Callbacks of these types. If not specified then the whole callbacks are retrieved.

indexRange
string (indexRange) \d+-\d*
Default: "0-"

Results indexes will be included in this range (see indexRange model).

default: 0-

example: 0-, 0-5

pageSize
integer [ 1 .. 60 ]
Default: 60

The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. The range for this parameter is [1...60]

pageToken
string

Start-Page marker, this token is used (by the backend) for continuing serving from the previous results page to the next one. (Disclaimer: It is built and used only by the server).

Responses

Response Schema: application/hal+json
required
object (Tab_Links)

HAL (Hypertext Application Language) link collection

total
required
integer
totalPage
required
integer
currentPage
required
integer
required
object

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "total": 0,
  • "totalPage": 0,
  • "currentPage": 0,
  • "_embedded": {
    }
}

Register a new reusable remote callback.

Create a new reusable callback.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

Request Body schema: application/json
object

The retry policy to apply when notification failed.

object

Notification batch of events defined by a time window and batch size. If this field is not set, the callback will post only one event by call.

  • At least, the size parameter should be provided.
  • If the time window is not set then the default value will be applied.
required
object
label
string
remoteTypes
required
Array of strings (RemoteTypes)
Items Enum: "ThermalPreconditioning" "ElectricBatteryChargingRequest" "Horn" "Doors" "Lights" "Immobilization" "Stolen" "WakeUp" "Navigation"

Responses

Response Schema: application/hal+json
object
callbackId
string (RemoteCallbackId)

Uniq remote callback ID returned when the callback was subscribed (created) succefuly.

status
string (CallbackStatus)
Enum: "Running" "Paused" "Failed"

Request samples

Content type
application/json
{
  • "retryPolicy": {
    },
  • "batchNotify": {
    },
  • "callback": {
    },
  • "label": "string",
  • "remoteTypes": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "callbackId": "string",
  • "status": "Running"
}

Update an existing remote callback.

Update an existing Callback that has been posted (and accepted previously) for this fleet. The callback object (body) provided should be complete (aggregation is not supported for the update). This object can be retrieved using the GET /fleets/{fid}/remote/callbacks/{cbid} API then modify it and finally publish it (via this PUT API)

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

cbid
required
string([0-9a-fA-F]|-|_)*

The remote callback ID.

Request Body schema: application/json
object

The retry policy to apply when notification failed.

object

Notification batch of events defined by a time window and batch size. If this field is not set, the callback will post only one event by call.

  • At least, the size parameter should be provided.
  • If the time window is not set then the default value will be applied.
required
object
label
string
remoteTypes
required
Array of strings (RemoteTypes)
Items Enum: "ThermalPreconditioning" "ElectricBatteryChargingRequest" "Horn" "Doors" "Lights" "Immobilization" "Stolen" "WakeUp" "Navigation"

Responses

Response Schema: application/hal+json
object
callbackId
string (RemoteCallbackId)

Uniq remote callback ID returned when the callback was subscribed (created) succefuly.

status
string (CallbackStatus)
Enum: "Running" "Paused" "Failed"

Request samples

Content type
application/json
{
  • "retryPolicy": {
    },
  • "batchNotify": {
    },
  • "callback": {
    },
  • "label": "string",
  • "remoteTypes": [
    ]
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "callbackId": "string",
  • "status": "Running"
}

Get a remote callbacks of a fleet.

Returns a subscribed remote callback of the fleet by subscribe ID.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

cbid
required
string([0-9a-fA-F]|-|_)*

The remote callback ID.

Responses

Response Schema: application/hal+json
required
object

Note: remotes is a templated link.

id
required
string (RemoteCallbackId)

Uniq remote callback ID returned when the callback was subscribed (created) succefuly.

required
object (RemoteCallbackSubscribe)

Callback subscription parameters.

status
required
string (CallbackStatus)
Enum: "Running" "Paused" "Failed"

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "id": "string",
  • "subscribe": {
    },
  • "status": "Running"
}

Delete an existing callback.

Remove an existing callback if and only if there is no pending remote attached to it.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

cbid
required
string([0-9a-fA-F]|-|_)*

The remote callback ID.

Responses

Set a remote callback new status.

Set the remote callback status.Paused means that the callback will not post any event.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

cbid
required
string([0-9a-fA-F]|-|_)*

The remote callback ID.

Request Body schema: application/json
status
required
string
Enum: "Running" "Paused"

Responses

Response Schema: application/hal+json
object
callbackId
string (RemoteCallbackId)

Uniq remote callback ID returned when the callback was subscribed (created) succefuly.

status
string (CallbackStatus)
Enum: "Running" "Paused" "Failed"

Request samples

Content type
application/json
{
  • "status": "Running"
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "callbackId": "string",
  • "status": "Running"
}

Send a remote action to a vehicle.

Create a new asynchrone vehicle remote action and request it.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

vid
required
string

Resource is related to this Vehicle ID only.

cbid
required
string([0-9a-fA-F]|-|_)*

The remote callback ID.

Request Body schema: application/json
label
string
object (RemotePreconditioning)

Remote preconditioning the vehicle.

object (RemoteSetImmobilization)

Requesting the vehicle for immobilization.

object (RemoteDoorsState)

Remote vehicle door (lock/unlock) state. Disclaimer : "Forced" parameter is only applicable to lock the doors and is now deprecated because not applicable to all vehicles. It will be ignored to unlock the doors if set. Some additionnal details will be added in the callback when this parameter is considered.

object (RemoteHorn)

Remote vehicle horn activation.

object (RemoteCharging)

Remote electric battery charging action.

  • preferences cannot be used in the same remote than schedule and/or immediate
object (RemoteStolen)

Remote operation to update stolen state, immobilization and configuration information. Only one attribute can be used at a time.

object (RemoteLights)

Remote to swith on / off lights.

object (RemoteWakeUp)

Remote to wake up a vehicle (so it can update its data).

object (RemoteNavigation)

A remote to share GPS positions with the vehicle so it can navigate through those positions by driving from start (1st) to end (last) position. It can include only 9 points + the destination.

Responses

Response Schema: application/hal+json
object
remoteActionId
string (RemoteActionId)

The uniq remote action ID returned when the remote action was posted and accepted.

type
string (RemoteType)
Enum: "ThermalPreconditioning" "ElectricBatteryChargingRequest" "Horn" "Doors" "Lights" "Immobilization" "Stolen" "WakeUp" "Navigation"

Request samples

Content type
application/json
{
  • "label": "string",
  • "preconditioning": {
    },
  • "immobilization": {
    },
  • "door": {
    },
  • "horn": {
    },
  • "charging": {
    },
  • "stolen": {
    },
  • "lights": {
    },
  • "wakeUp": {
    },
  • "navigation": {
    }
}

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "remoteActionId": "string",
  • "type": "Doors"
}

Get all remote action of vehicle and callback.

Returns the list of action remote requested for vehicle.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

vid
required
string

Resource is related to this Vehicle ID only.

cbid
required
string([0-9a-fA-F]|-|_)*

The remote callback ID.

query Parameters
indexRange
string (indexRange) \d+-\d*
Default: "0-"

Results indexes will be included in this range (see indexRange model).

default: 0-

example: 0-, 0-5

pageSize
integer [ 1 .. 60 ]
Default: 60

The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. The range for this parameter is [1...60]

pageToken
string

Start-Page marker, this token is used (by the backend) for continuing serving from the previous results page to the next one. (Disclaimer: It is built and used only by the server).

Responses

Response Schema: application/hal+json
required
object (Tab_Links)

HAL (Hypertext Application Language) link collection

total
required
integer
totalPage
required
integer
currentPage
required
integer
required
object

Response samples

Content type
application/hal+json
{
  • "_links": {
    },
  • "total": 0,
  • "totalPage": 0,
  • "currentPage": 0,
  • "_embedded": {
    }
}

Get remote action by id.

Returns the remote action requested for vehicle by ID.

Authorizations:
(BasicAuthClientId)
path Parameters
fid
required
string

Resource is related to this fleet ID only.

vid
required
string

Resource is related to this Vehicle ID only.

cbid
required
string([0-9a-fA-F]|-|_)*

The remote callback ID.

rid
required
string([0-9a-fA-F]|-|_)*

The remote action ID.

Responses

Response Schema: application/hal+json
remoteActionId
string

The uniq remote action ID returned when the remote action was posted and accepted.

status
string
Enum: "Accepted" "Failed" "Success" "AlreadyDone" "WakingUpVehicle" "CheckingVehicle" "SentToVehicle" "VehicleBatteryChargeTooLow" "TooManyWakeUpsOverMonth"
type
string (RemoteType)
Enum: "ThermalPreconditioning" "ElectricBatteryChargingRequest" "Horn" "Doors" "Lights" "Immobilization" "Stolen" "WakeUp" "Navigation"
required
object
object (Remote)

Remote vehicle activation. Only one action (horn, precond, door...) is supported at a time.

failureCause
string (RemoteFailedEventStatus)
Enum: "GeneralError" "VehicleError" "WrongCommand" "VehicleConnectionTimeout" "MissingRights" "NotPossibleDueToVehicleBatteryLevel" "NotPossibleDueToVehiclePrivacyLevel" "TooManyWakeUpsOverMonth" "TooManyRequestInShortTime" "SameActionInProgress" "NotPossibleDueToVehicleStolenState" "VehicleInUse" "TooManyRequestSent" "DoorsOpen" "VehicleErrorOrCidInside" "CidInside" "ExternalChargingSystemError" "VehicleChargingSystemError" "VehicleIsNotLocked" "CanceledByDriver"

The failure cause for event with failed status. This field is filled only is failure state.

feedbackDetail
string (RemoteEventFeedbackDetail)
Enum: "NoCIDBlacklisted" "CIDBlacklisted"

Additionnal detail in case of success on some specific behavior :

Feature Description Behavior
Lock Doors Send a lock doors by force NoCIDBlacklisted if lock is OK but IML not blacklisted, CIDBlacklisted is when the doors are locked and the IML is well blacklisted

Response samples

Content type
application/hal+json
{
  • "remoteActionId": "string",
  • "status": "Accepted",
  • "type": "Doors",
  • "_links": {
    },
  • "remote": {
    },
  • "failureCause": "GeneralError",
  • "feedbackDetail": "NoCIDBlacklisted"
}