v1

latestOpenAPI 3.0.0Groupe PSA Licence2026-08-0647172197.4 KB
Fleet

Fleet Vehicles status.

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

get/fleets/{fid}/status

Path parameters

fidstring required

Resource is related to this fleet ID only.

Query parameters

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

pageSizeinteger

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]

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

A list of Status