v1

latestOpenAPI 3.0.0Groupe PSA Licence2026-08-0647172197.4 KB
Trips

Vehicle's trip waypoints.

Gives the Vehicle's wayPoints for a specified Trip.

get/fleets/{fid}/vehicles/{vid}/trips/{tid}/wayPoints

Path parameters

fidstring required

Resource is related to this fleet ID only.

vidstring required

Resource is related to this Vehicle ID only.

tidstring required

The ID {tid} of Trip

Query parameters

indexRangestring

Range index used to express the first (offset) and the last results index to retrieve. With the respect to the regex pattern '\d+(-\d*)?', the start of range is mandatory (use 0 for default).

Example:

  • '0-9' : start=0, end=9 ==> offset=0 and number of items=10

  • '5-' : start =5, no end ==> start at 5th to the end results.

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

default: 0-

example: 0-, 0-5

timestampsstring[]

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.
tolerancenumber 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'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.
pageSizeinteger

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]

pageTokenstring

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).

Response

Path response