GET Uds/GetDTCs?equipmentId={equipmentId}

Get all (cached) DTC's, OBD and enhanced

Request Information

URI Parameters

NameDescriptionTypeAdditional information
equipmentId

The EquipmentId

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of DtcInfoDto
NameDescriptionTypeAdditional information
Ecu

The ECU that reported the DTC.

byte

None.

Code

The Diagnostic Trouble Code.

string

None.

Title

Title of the DTC, if known, als "Unknown DTC".

string

None.

Description

Description of the DTC, if known, else a automatically derived description based on known data.

string

None.

Enhanced

If true this is an "enhanced" UDS DTC instead of a basic OBD DTC. In this case the DTC has a valid FailureType (and FailureTypeName). If true all status flags (StatusFlag...-properties) are valid. If false only StatusFlagPendingDtc and StatusFlagConfirmedDtc are valid. If true this DTC may also have valid severity information if HasSeverityInfo is also true.

boolean

None.

FailureType

Failure type code, which gives more information about the reason why DTC occured

byte

None.

FailureTypeName

Failure type name/description

string

None.

HasSeverityInfo

If true this is an "enhanced" UDS DTC whith severity information

boolean

None.

Severity

Severity information: NoSeveritySpecified, MaintenanceOnly, CheckAtNextHalt or CheckImmediately.

DtcSeverityDTO

None.

StatusFlagTestFailed

This flag provides the information about the fault (Error) is still active (injected) or not. If Fault is still injected or Active, then the value is true otherwise the value is false.

boolean

None.

StatusFlagTestFailedThisMonitoringCycle

This flag indicates whether the fault is occurred anytime during the current operation cycle. If Fault has occurred in the current operation cycle, then the value is true otherwise the value is false.

boolean

None.

StatusFlagPendingDtc

This flag indicates whether the fault is occurred anytime during the current operation cycle. The only difference between “testFailedThisOperationCycle” and “pendingDTC” is “testFailedThisOperationCycle” is cleared at the end of current operation cycle (least bothering whether the fault is still active or inactive) and “pendingDTC” is cleared only when in next operation cycle the monitor routine is run and the result shows pass(fault is not present). So if Fault is still injected or Active in the current operation cycle, then the value is true otherwise if the Fault was active in previous operation cycle and is inactive (i.e monitor routine is run and fault is inactive) in the current operation cycle, then the value is false.

boolean

None.

StatusFlagConfirmedDtc

This flag informs that fault is continuously active for specific monitor routines and is matured enough in the current operation cycle so that it can be said Confirmed. If fault is active and matured, then the value is true otherwise the value is false.

boolean

None.

StatusFlagTestNotCompletedSinceLastClear

This flag informs that monitor routine is not run in the current operation cycle(once after Clearing the DTC is done). The reason for not running in the current operation cycle can be because particular pin is inactive in the operation cycle(Ex: Parked or hibernate vehicle mode). If the monitor routine is not completed this operation cycle, then the value is true otherwise the value is false.

boolean

None.

StatusFlagTestFailedSinceLastClear

This flag informs monitor routine has reported that test has failed (at least once Bit0 is set) in any operation cycle at least once after clearing the DTC action is performed. If the fault has occurred after clear DTC is performed, then the value is true otherwise the value is false.

boolean

None.

StatusFlagTestNotCompletedThisMonitoringCycle

This flag informs that the monitor routine is still not run during this current operation cycle. This is because the pin is not active for this operation cycle or when the request is sent from the tester, the monitor routine is not run. If the monitor routine is not run this operation cycle, then the value is true otherwise the value is false.

boolean

None.

StatusFlagWarningIndicatorRequested

This flag is used to bring into the attention of the user or driver when the fault occurs. If fault occurs and any monitor is required for specific fault, then the value is true otherwise the value is false.

boolean

None.

VehicleSubsystem

Vehicle subsystem name

string

None.

DtcType

Type of the DTC: Generic, ManufacturerSpecific or CodeDependant

string

None.

SpecificSystem

Specific system where the DTC occured

string

None.

DtcStatusId

The DtcStatus ID.

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Ecu": 64,
    "Code": "sample string 2",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "Enhanced": true,
    "FailureType": 64,
    "FailureTypeName": "sample string 7",
    "HasSeverityInfo": true,
    "Severity": "NoSeveritySpecified",
    "StatusFlagTestFailed": true,
    "StatusFlagTestFailedThisMonitoringCycle": true,
    "StatusFlagPendingDtc": true,
    "StatusFlagConfirmedDtc": true,
    "StatusFlagTestNotCompletedSinceLastClear": true,
    "StatusFlagTestFailedSinceLastClear": true,
    "StatusFlagTestNotCompletedThisMonitoringCycle": true,
    "StatusFlagWarningIndicatorRequested": true,
    "VehicleSubsystem": "sample string 17",
    "DtcType": "sample string 18",
    "SpecificSystem": "sample string 19",
    "DtcStatusId": 20
  },
  {
    "Ecu": 64,
    "Code": "sample string 2",
    "Title": "sample string 3",
    "Description": "sample string 4",
    "Enhanced": true,
    "FailureType": 64,
    "FailureTypeName": "sample string 7",
    "HasSeverityInfo": true,
    "Severity": "NoSeveritySpecified",
    "StatusFlagTestFailed": true,
    "StatusFlagTestFailedThisMonitoringCycle": true,
    "StatusFlagPendingDtc": true,
    "StatusFlagConfirmedDtc": true,
    "StatusFlagTestNotCompletedSinceLastClear": true,
    "StatusFlagTestFailedSinceLastClear": true,
    "StatusFlagTestNotCompletedThisMonitoringCycle": true,
    "StatusFlagWarningIndicatorRequested": true,
    "VehicleSubsystem": "sample string 17",
    "DtcType": "sample string 18",
    "SpecificSystem": "sample string 19",
    "DtcStatusId": 20
  }
]