GRgroupe-psa
Vehicles

An alert related to a vehicle.

Returns information about a specific alert messages for a Vehicle.

get/fleets/{fid}/vehicles/{vid}/alerts/{aid}

Request

Path parameters

fidstring required

Resource is related to this fleet ID only.

vidstring required

Resource is related to this Vehicle ID only.

aidstring required

id of the alert.

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.

Response

Alert response

createdAtstring date-time required

Date when the resource has been created.

updatedAtstring date-time

Date when the resource has been updated.

idstring required
vinstring required

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

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

SeverityDescription
InformationBetter to fix but it is operating accurately.
WarningShould fix it asap.
CriticalStarting prohibited without repair.
startedAtstring date-time required
endAtstring date-time

Example response

{
  "_links": {
    "self": {
      "href": "http://example.com",
      "deprecation": "http://example.com"
    },
    "vehicle": {
      "href": "http://example.com",
      "deprecation": "http://example.com"
    },
    "position": {
      "href": "http://example.com",
      "deprecation": "http://example.com"
    },
    "trips": [
      {
        "href": "http://example.com",
        "deprecation": "http://example.com"
      }
    ]
  },
  "id": "0a9de72cc3803b12a74418acd20dcd66634fa82e44b2ec7060bca91462dc5772199559905caefe168812918d47f67253f33d477b645bb59afdd1268b81e382999",
  "vin": "VF3ABCDE0FG123456",
  "startPosition": {
    "geometry": {
      "type": "Point",
      "coordinates": [
        5.970338,
        -62.536239
      ]
    },
    "properties": {
      "vin": "VF3ABCDE0FG123456"
    }
  },
  "endPosition": {
    "geometry": {
      "type": "Point",
      "coordinates": [
        5.970338,
        -62.536239
      ]
    },
    "properties": {
      "vin": "VF3ABCDE0FG123456"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.