GET v2/J1939/FaultLibraries/ResolveFault?AssetId={AssetId}&Imei={Imei}&SerialNumber={SerialNumber}&Vin={Vin}&Spn={Spn}&Fmi={Fmi}&CanBus={CanBus}&SourceAddress={SourceAddress}
Resolve a SPN and FMI to the most specific SPN in the J1939 fault library, based on the provided parameters.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| AssetId |
The ID of the asset that reported the fault. |
integer |
None. |
| Imei |
The IMEI of the TCU that reported the fault. |
string |
None. |
| SerialNumber |
The serial number of the asset that reported the fault. |
string |
None. |
| Vin |
The VIN of the asset that reported the fault. |
string |
None. |
| Spn |
The SPN (Suspect Parameter Number) of the fault to be resolved. |
integer |
None. |
| Fmi |
The FMI (Failure Mode Identifier) of the fault to be resolved. |
integer |
None. |
| CanBus |
The CAN bus number associated with the fault to be resolved. |
integer |
None. |
| SourceAddress |
The source address associated with the fault to be resolved. |
integer |
None. |
Body Parameters
None.
Response Information
Resource Description
The most specific that matches the provided parameters.
Lhp.EquipmentIntelligence.WebApi.Models.V2.J1939Spn| Name | Description | Type | Additional information |
|---|---|---|---|
| spn |
The suspect parameter number (SPN). Sent as part fo the J1939 CAN Frame. |
integer |
None. |
| name |
The name of the SPN. |
string |
None. |
| description |
A description of the SPN. |
string |
None. |
| recommendations |
Recommendations for addressing a fault that references this SPN. |
string |
None. |
| fmis |
The FMIs specific to this SPN. |
Collection of Lhp.EquipmentIntelligence.WebApi.Models.V2.J1939Fmi |
None. |
| faultSeverityId |
The fault severity associated with this SPN. This is an optional value assigned in a custom J1939 library. If not assigned, the fault severity will be null. |
integer |
None. |
Response Formats
application/json, text/json
{
"spn": 1,
"name": "sample string 2",
"description": "sample string 3",
"recommendations": "sample string 4",
"fmis": [
{
"fmi": 1,
"name": "sample string 2",
"description": "sample string 3",
"recommendations": "sample string 4",
"faultSeverityId": 1
},
{
"fmi": 1,
"name": "sample string 2",
"description": "sample string 3",
"recommendations": "sample string 4",
"faultSeverityId": 1
}
],
"faultSeverityId": 1
}
application/xml, text/xml
<J1939Spn xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Spn>1</Spn>
<Name>sample string 2</Name>
<Description>sample string 3</Description>
<Recommendations>sample string 4</Recommendations>
<SpnSpecificFmis>
<J1939Fmi>
<Fmi>1</Fmi>
<Name>sample string 2</Name>
<Description>sample string 3</Description>
<Recommendations>sample string 4</Recommendations>
<FaultSeverityId>1</FaultSeverityId>
</J1939Fmi>
<J1939Fmi>
<Fmi>1</Fmi>
<Name>sample string 2</Name>
<Description>sample string 3</Description>
<Recommendations>sample string 4</Recommendations>
<FaultSeverityId>1</FaultSeverityId>
</J1939Fmi>
</SpnSpecificFmis>
<FaultSeverityId>1</FaultSeverityId>
</J1939Spn>