GET v2/J1939/FaultLibraries/{id}/Spns/{spn}/Fmis/{fmi}
Retrieve the information for a supplied SPN from the J1939 fault library.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The ID of the J1939 fault library. |
integer |
Required |
| spn |
The SPN to retrieve information for. |
integer |
Required |
| fmi | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The information for the specified SPN.
Lhp.EquipmentIntelligence.WebApi.Models.V2.J1939Fmi| Name | Description | Type | Additional information |
|---|---|---|---|
| fmi |
The failure mode identifier (FMI). Sent as part of the J1939 CAN Frame. |
integer |
None. |
| name |
The name of the FMI. |
string |
None. |
| description |
A description of the FMI. |
string |
None. |
| recommendations |
Recommendations for addressing a fault that references this FMI. |
string |
None. |
| faultSeverityId |
The fault severity associated with this FMI. 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
Sample:
{
"fmi": 1,
"name": "sample string 2",
"description": "sample string 3",
"recommendations": "sample string 4",
"faultSeverityId": 1
}
application/xml, text/xml
Sample:
<J1939Fmi xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Fmi>1</Fmi> <Name>sample string 2</Name> <Description>sample string 3</Description> <Recommendations>sample string 4</Recommendations> <FaultSeverityId>1</FaultSeverityId> </J1939Fmi>