--- title: "Fleet Vehicles alerts." method: GET path: "/fleets/{fid}/alerts" tags: ["Fleet"] deprecated: true --- # Fleet Vehicles alerts. `GET /fleets/{fid}/alerts` ## Request - Base URL: `https://api-cert.groupe-psa.com/connectedcar/v3` - URL: `https://api-cert.groupe-psa.com/connectedcar/v3/fleets/{fid}/alerts` - Auth: HTTP basic and API key in query parameter `client_id` - TypeScript: (a function with typed inputs; its response is checked against the schema) > **Deprecated.** Returns the vehicles alerts list for a given fleet. HyperLink (HAL) resolutions of resources within the returned collection are associate to vehicle. ## Path parameters - `fid` string, required ## Query parameters - `profile` 'fleet' | 'endUser' - `timestamps` string[] - `indexRange` string: 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. - `pageSize` integer - `pageToken` string ## Response `200` A list of alert - Alerts - `_links` TabLinks, required: [HAL](https://en.wikipedia.org/wiki/Hypertext_Application_Language#Convention) (Hypertext Application Language) link collection - `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. - `first` 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. - `next` 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. - `prev` 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. - `last` 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. - `total` integer, required - `totalPage` integer, required - `currentPage` integer, required - `_embedded` object, required - `alerts` Alert[] - `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. - `position` 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. - `trips` Link[] - `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 - `vin` string, required: Identifier of a vehicle. **Set when retrieving resource in batch mode**. - `active` boolean, required - `type` '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', required: MPH alert list - `severity` '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` string, date-time, required - `endAt` string, date-time - `startPosition` object: The position (last vehicle known one) where the alert appears. - `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 alert disappears. - `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. ## 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)