--- title: "Vehicle status." method: GET path: "/fleets/{fid}/vehicles/{vid}/status" tags: ["Vehicles"] --- # Vehicle status. `GET /fleets/{fid}/vehicles/{vid}/status` ## Request - Base URL: `https://api-cert.groupe-psa.com/connectedcar/v3` - URL: `https://api-cert.groupe-psa.com/connectedcar/v3/fleets/{fid}/vehicles/{vid}/status` - Auth: HTTP basic and API key in query parameter `client_id` - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns the latest vehicle status. ## Path parameters - `fid` string, required - `vid` string, required ## Query parameters - `profile` 'fleet' | 'endUser' ## Response `200` Status response - Status: Describe the latest status of the vehicle - `createdAt` string, date-time, required: Date when the resource has been created. - `updatedAt` string, date-time: Date when the resource has been updated. - `_links` object, required - `self` Link, required: A Link Object as defined by [JSONHAL#Link Object](https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5). - `href` string, required: URL format follows [RFC 3986](https://tools.ietf.org/html/rfc3986) and usually looks like this ` scheme://host[:port][/Path] ` - `templated` boolean: SHOULD be true when the Link Object's "href" property is an [URI Template](https://tools.ietf.org/html/rfc6570) - `type` string: a hint to indicate the media type expected when dereferencing the target resource. - `deprecation` string: indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation. - `name` string - `title` string: Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)). - `profile` string: Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]). - `hreflang` string: Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-kelly-json-hal-08#ref-I-D.wilde-profile-link)) of the target resource. - `vehicle` Link: A Link Object as defined by [JSONHAL#Link Object](https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5). - `href` string, required: URL format follows [RFC 3986](https://tools.ietf.org/html/rfc3986) and usually looks like this ` scheme://host[:port][/Path] ` - `templated` boolean: SHOULD be true when the Link Object's "href" property is an [URI Template](https://tools.ietf.org/html/rfc6570) - `type` string: a hint to indicate the media type expected when dereferencing the target resource. - `deprecation` string: indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation. - `name` string - `title` string: Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)). - `profile` string: Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]). - `hreflang` string: Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-kelly-json-hal-08#ref-I-D.wilde-profile-link)) of the target resource. - `fleet` Link: A Link Object as defined by [JSONHAL#Link Object](https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5). - `href` string, required: URL format follows [RFC 3986](https://tools.ietf.org/html/rfc3986) and usually looks like this ` scheme://host[:port][/Path] ` - `templated` boolean: SHOULD be true when the Link Object's "href" property is an [URI Template](https://tools.ietf.org/html/rfc6570) - `type` string: a hint to indicate the media type expected when dereferencing the target resource. - `deprecation` string: indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation. - `name` string - `title` string: Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)). - `profile` string: Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]). - `hreflang` string: Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-kelly-json-hal-08#ref-I-D.wilde-profile-link)) of the target resource. - `vin` string, required: Identifier of a vehicle. **Set when retrieving resource in batch mode**. - `ignition` Ignition - `createdAt` string, date-time, required: Date when the resource has been created. - `type` 'Stop' | 'StartUp' | 'Start', required - `lastPosition` Position - `type` 'Feature', required - `geometry` Point, required: This object expresses a GeoJSON Point as specified by [rfc7946](https://tools.ietf.org/html/rfc7946#section-3.1.2). - `coordinates` number[], required: This is a simple 2 (or more) numbers vector used to define Geometry Point objects. - `type` 'Point', required - `properties` object, required - `createdAt` string, date-time, required: Date when the resource has been created. - `vin` string: Identifier of a vehicle. **Set when retrieving resource in batch mode**. - `heading` integer: Course angle expressed in degree. - `signalQuality` integer - `type` 'Estimated' | 'Acquire' - `fixStatus` '2D' | '3D': Fix status information is only returned when position type is set to Acquire. Horizontal & altitude position can be determined in 3D fix status mode where it is only horizontal position in 2D mode. - `preconditioning` Preconditioning: Preconditioning the vehicle for driver and passenger. - `airConditioning` object - `createdAt` string, date-time, required: Date when the resource has been created. - `status` 'Enabled' | 'Disabled' | 'Finished' | 'Failure': The status of the preconditioning feature. - `startingCause` 'Immediate' | 'Scheduled': starting cause - `failureCause` 'Defect' | 'DoorOpened' | 'LowBattery' | 'LowFuelLevel' | 'TooManyUnusedProg' | 'WindowsRoofOpened' | 'HoodOpened' | 'NotParked' | 'OtherFailures': failure cause - `programs` PreconditioningProgram[] - `recurrence` 'None' | 'Daily', required: Determines the recurrence of the program. * None: means no recurrence. * Daily: repeated over the week. - `start` string, required: The program start time formatted using the duration format based on [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals) with the schema: P[n]Y[n]M[n]DT[n]H[n]M[n]S _example_: * PT14H30M means 14H and 30Min - `occurence` object, required: The occurrence on the program will spread on days depending on recurrence value. - `day` string[], required - `slot` integer: This program number. Can only be used ONE time in the same preconditioning list. - `enabled` boolean, required: Determines whether this program is enabled or not. - `energies` Energy[] - `createdAt` string, date-time: Date when the resource has been created. - `engines` Engine[] - `createdAt` string, date-time, required: Date when the resource has been created. - `type` 'Thermic' | 'Electric' - `speed` number, float: Engine's speed in RPM - `gmpStatus` 'NotRunning' | 'Starting' | 'Running' | 'Stopping' | 'Stopped' - `extension` object - `thermic` object - `coolant` object: Engine coolant liquid properties. - `level` integer: Engine liquid level expressed in persent. - `temp` number, float: Engine liquid temperature expressed in Celsius degrees. - `oil` object: Engine oil properties. - `level` integer: Engine liquid level expressed in persent. - `temp` number, float: Engine liquid temperature expressed in Celsius degrees. - `air` EngineAir - `temp` number, float: Engine air temperature expressed in Celsius degrees. - `transmission` Transmission - `gearbox` object - `mode` object - `automatic` boolean - `sport` boolean - `snow` boolean - `sequential` boolean - `semiManual` boolean - `ratio` 'Ratio1' | 'Ratio2' | 'Ratio3' | 'Ratio4' | 'Ratio5' | 'Ratio6' | 'Ratio7' | 'Ratio8' | 'Neutral' | 'Reverse': Current gear-box ratio. - `powertrain` Powertrain - `createdAt` string, date-time, required: Date when the resource has been created. - `status` 'NotRunning' | 'Starting' | 'Running' | 'Stopping' | 'Stopped': Status of the powertrain - `adas` Adas - `parkAssist` object - `front` string[] - `rear` string[] - `accr` 'Activated' | 'Fault' | 'Hold' | 'HoldWithOverSpeeding' | 'Off' | 'OverSpeedingByPedalPress' | 'StandBy': Adaptive Cruise Control Regulation - `lvv` boolean - `rvv` 'Off' | 'NoBestFit' | 'BestFitInProgress' | 'BestFitMax' | 'BestFitMin' | 'BestFitDeactivated' | 'AutoDeactivated' | 'OverflowSpeedConsign' | 'LackOfVisibilityRadar' | 'LearningRadar' | 'Deactivated' | 'LimitSetting': Advanced Speed Regulator - `aebs` 'Off' | 'Fixed' | 'OnFlashing': Advanced Emergency Braking System - `afil` 'FlashingFault' | 'FlashingWarning' | 'Off' | 'OnFixed': Lane Departure Warning System - `artiv` 'NotSelected' | 'Selected' | 'Unavailable': Respect of inter vehicle time assist (ARTIV) - `bsm` 'Active' | 'Inactive' | 'Disabled' | 'Fault': Blind Spot Monitoring - `esp` boolean: Electronic Stability Program - `abs` boolean: Anti-lock braking system - `fse` boolean: Electric brake service - `sli` integer: Speed Limit Information (expressed in km/h) - `rlka` 'Authorized' | 'CorrectionInProgress' | 'NotAuthorized' | 'NotSelected': Right Lane Keeping Assist - `llka` 'Authorized' | 'CorrectionInProgress' | 'NotAuthorized' | 'NotSelected': Left Lane Keeping Assist - `rgi` 'None' | 'Up' | 'Down' | 'UpDown': Recommended gear indicator - `doorsState` DoorsState - `createdAt` string, date-time, required: Date when the resource has been created. - `lockedStates` string[]: List of all known doors' states - `opening` object[] - `identifier` 'Driver' | 'Passenger' | 'RearLeft' | 'RearRight' | 'Trunk' | 'RearWindow' | 'RoofWindow' - `state` 'Open' | 'Closed' - `privacy` Privacy - `createdAt` string, date-time, required: Date when the resource has been created. - `state` 'None' | 'Geolocation' | 'Full' - `battery` Battery: Describe the car (with combustion engine) battery status. - `createdAt` string, date-time, required: Date when the resource has been created. - `voltage` number, float: Auxiliary battery (12V) state of health in % - `service` ServiceType - `createdAt` string, date-time, required: Date when the resource has been created. - `type` 'Electric' | 'Hybrid' | 'Unknown' - `safety` Safety - `createdAt` string, date-time, required: Date when the resource has been created. - `beltStatus` BeltStatus[] - `belt` 'Normal' | 'Omission': Belt status. - `id` 'Driver' | 'Passenger': Seat identifier. - `autoECallTriggering` 'NotDetected' | 'Detected' | 'ShockDetectionUnabled' - `odometer` VehicleOdometer - `createdAt` string, date-time, required: Date when the resource has been created. - `mileage` number, float: Vehicle mileage expressed in KM. - `kinetic` Kinetic: Everything related to the movement of the vehicle. Speed, acceleration.. - `createdAt` string, date-time, required: Date when the resource has been created. - `acceleration` number, float: Vehicle acceleration (expressed in m/s²) - `speed` number, float: Vehicle speed (expressed in km/h) - `moving` boolean - `environment` Environment - `luminosity` Luminosity - `createdAt` string, date-time, required: Date when the resource has been created. - `day` boolean - `air` Air - `createdAt` string, date-time, required: Date when the resource has been created. - `temp` number, float: Outside air temperature in Celsius degrees - `drivingBehavior` DrivingBehavior - `createdAt` string, date-time, required: Date when the resource has been created. - `updatedAt` string, date-time: Date when the resource has been updated. - `mode` 'Normal' | 'Sport' | 'Comfort' | 'Eco' | 'Sand' | 'Mud' | 'Snow' | 'ZEV' | 'Hybrid' | 'ZEVEco' | 'HybridEco' | 'EcoPlus' | 'eAWD' | '4AWD' | 'ReinforcedLoad': Driving mode by driver selection - `wipingBlades` WipingBladesState - `createdAt` string, date-time, required: Date when the resource has been created. - `active` boolean: Either active (true) or not (false). - `speed` 'High' | 'Low': Wiping speed. This field is present only if active field is set to true. - `lightingSystem` LightingSystem: Expresses the Directional, Fog and Position vehicle lights. - `createdAt` string, date-time, required: Date when the resource has been created. - `turn` object[]: Expresses all light, direction (```Left```, ```Right``` ), position (```Front```, ```Rear``` ) and status (```Off```, ```On```) for a category. - `direction` 'Left' | 'Right' - `position` 'Front' | 'Rear' - `status` 'Off' | 'On' - `fog` object[]: Expresses all light, direction (```Left```, ```Right``` ), position (```Front```, ```Rear``` ) and status (```Off```, ```On```) for a category. - `direction` 'Left' | 'Right' - `position` 'Front' | 'Rear' - `status` 'Off' | 'On' - `alarm` VehicleStatusAlarm: Describes the current vehicle alarm status and the latest (if available) trigger. - `trigger` AlarmTrigger: Describe a vehicle alarm trigger. - `createdAt` string, date-time, required: Date when the resource has been created. - `type` 'NoBreakIn' | 'FrontRightDoorBreakIn' | 'FrontLeftDoorBreakIn' | 'RearRightFrontDoorBreakIn' | 'RearLeftFrontDoorBreakIn' | 'HoodDoorBreakIn' | 'TrunkDoorBreakIn' | 'BackliteDoorBreakIn' | 'RoofBreakIn' | 'VolumetricBreakIn' | 'VehicleLifting' | 'ElectricalsystemBreakIn' | 'KeyLearning' | 'UnauthenticatedStartup', required: Define the vehicle break-in type. - `position` object: The position (last vehicle known one) where the alarm triggered. - `type` 'Feature', required - `geometry` Point, required: This object expresses a GeoJSON Point as specified by [rfc7946](https://tools.ietf.org/html/rfc7946#section-3.1.2). - `coordinates` number[], required: This is a simple 2 (or more) numbers vector used to define Geometry Point objects. - `type` 'Point', required - `properties` object, required - `createdAt` string, date-time, required: Date when the resource has been created. - `vin` string: Identifier of a vehicle. **Set when retrieving resource in batch mode**. - `heading` integer: Course angle expressed in degree. - `signalQuality` integer - `type` 'Estimated' | 'Acquire' - `fixStatus` '2D' | '3D': Fix status information is only returned when position type is set to Acquire. Horizontal & altitude position can be determined in 3D fix status mode where it is only horizontal position in 2D mode. - `startAt` string, date-time, required: Time when the alarm triggering started. - `status` AlarmStatus: Describe a vehicle alarm status. - `createdAt` string, date-time, required: Date when the resource has been created. - `activation` 'Inactive' | 'Active', required: Define whether the vehicle alarm is active or not. - `stolen` StolenObj: Vehicle Stolen active status (only returns when vehicle is reported stolen). - `createdAt` string, date-time, required: Date when the resource has been created. - `_links` object, required - `self` Link, required: A Link Object as defined by [JSONHAL#Link Object](https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5). - `href` string, required: URL format follows [RFC 3986](https://tools.ietf.org/html/rfc3986) and usually looks like this ` scheme://host[:port][/Path] ` - `templated` boolean: SHOULD be true when the Link Object's "href" property is an [URI Template](https://tools.ietf.org/html/rfc6570) - `type` string: a hint to indicate the media type expected when dereferencing the target resource. - `deprecation` string: indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation. - `name` string - `title` string: Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)). - `profile` string: Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]). - `hreflang` string: Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-kelly-json-hal-08#ref-I-D.wilde-profile-link)) of the target resource. - `vehicle` Link: A Link Object as defined by [JSONHAL#Link Object](https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5). - `href` string, required: URL format follows [RFC 3986](https://tools.ietf.org/html/rfc3986) and usually looks like this ` scheme://host[:port][/Path] ` - `templated` boolean: SHOULD be true when the Link Object's "href" property is an [URI Template](https://tools.ietf.org/html/rfc6570) - `type` string: a hint to indicate the media type expected when dereferencing the target resource. - `deprecation` string: indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation. - `name` string - `title` string: Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)). - `profile` string: Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]). - `hreflang` string: Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-kelly-json-hal-08#ref-I-D.wilde-profile-link)) of the target resource. - `id` string, required - `state` boolean, required: Stolen state of the vehicle (True means the vhicle is reported stolen). - `startedAt` string, date-time, required: Stolen vehicle start time. - `endAt` string, date-time: Stolen vehicle stop time. - `startPosition` object: The position (last vehicle known one) where the vehicle is reported stolen. - `type` 'Feature', required - `geometry` Point, required: This object expresses a GeoJSON Point as specified by [rfc7946](https://tools.ietf.org/html/rfc7946#section-3.1.2). - `coordinates` number[], required: This is a simple 2 (or more) numbers vector used to define Geometry Point objects. - `type` 'Point', required - `properties` object, required - `createdAt` string, date-time, required: Date when the resource has been created. - `vin` string: Identifier of a vehicle. **Set when retrieving resource in batch mode**. - `heading` integer: Course angle expressed in degree. - `signalQuality` integer - `type` 'Estimated' | 'Acquire' - `fixStatus` '2D' | '3D': Fix status information is only returned when position type is set to Acquire. Horizontal & altitude position can be determined in 3D fix status mode where it is only horizontal position in 2D mode. - `endPosition` object: The position (last vehicle known one) where the stolen state is not active anymore. - `type` 'Feature', required - `geometry` Point, required: This object expresses a GeoJSON Point as specified by [rfc7946](https://tools.ietf.org/html/rfc7946#section-3.1.2). - `coordinates` number[], required: This is a simple 2 (or more) numbers vector used to define Geometry Point objects. - `type` 'Point', required - `properties` object, required - `createdAt` string, date-time, required: Date when the resource has been created. - `vin` string: Identifier of a vehicle. **Set when retrieving resource in batch mode**. - `heading` integer: Course angle expressed in degree. - `signalQuality` integer - `type` 'Estimated' | 'Acquire' - `fixStatus` '2D' | '3D': Fix status information is only returned when position type is set to Acquire. Horizontal & altitude position can be determined in 3D fix status mode where it is only horizontal position in 2D mode. - `_embedded` object - `extension` Extension: Additional data set. - `odometer` VehicleOdometer - `createdAt` string, date-time, required: Date when the resource has been created. - `mileage` number, float: Vehicle mileage expressed in KM. - `kinetic` Kinetic: Everything related to the movement of the vehicle. Speed, acceleration.. - `createdAt` string, date-time, required: Date when the resource has been created. - `acceleration` number, float: Vehicle acceleration (expressed in m/s²) - `speed` number, float: Vehicle speed (expressed in km/h) - `moving` boolean ## Other responses - `default` (unresolved $ref) --- [API](https://skmtc.dev/groupe-psa/apis/groupe-psa-connected-car-b2b-api.md) - [All operations](https://skmtc.dev/groupe-psa/apis/groupe-psa-connected-car-b2b-api/llms.txt) - [OpenAPI document](https://skmtc.dev/groupe-psa/apis/groupe-psa-connected-car-b2b-api/revisions/023ff3e3fe51?raw)