GET v2/J1939/FaultLibraries/{id}
Retrieves the J1939 fault library, which contains information about SPNs and FMIs.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The ID of the J1939 fault library to retrieve. If 0, the default library is returned. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
J1939 Fault Library
Lhp.EquipmentIntelligence.WebApi.Models.V2.J1939Library| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
LHPT J1939 library ID. This is a unique identifier for the J1939 library. |
integer |
None. |
| name |
The name of the J1939 library. This is a human-readable string that identifies the specific J1939 library. |
string |
None. |
| spns |
List of the SPN definitions found in the J1939 library. This is an array of J1939Spn objects. |
Collection of Lhp.EquipmentIntelligence.WebApi.Models.V2.J1939Spn |
None. |
| globalFmis |
List of the FMI definitions found in the J1939 library. This is an array of J1939Fmi objects. |
Collection of Lhp.EquipmentIntelligence.WebApi.Models.V2.J1939Fmi |
None. |
| oemEquipmentMakes |
Describes the specific scenario(s) in which this J1939 library is used. |
Collection of Lhp.EquipmentIntelligence.WebApi.Models.V2.OemEquipmentMake |
None. |
| lastModified |
The date and time when the J1939 library was last modified. This indicates the last time an SPN or FMI definition was added, removed, or changed in the library. |
date |
None. |
Response Formats
application/json, text/json
Sample:
{
"id": 1,
"name": "sample string 2",
"spns": [
{
"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
},
{
"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
}
],
"globalFmis": [
{
"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
}
],
"oemEquipmentMakes": [
{
"id": 1,
"name": "sample string 2",
"description": "sample string 3",
"models": [
{
"id": 1,
"name": "sample string 2",
"description": "sample string 3",
"canBuses": [
{
"id": 1,
"name": "sample string 2",
"number": 3,
"controllers": [
{
"id": 1,
"name": "sample string 2",
"sourceAddress": 3
},
{
"id": 1,
"name": "sample string 2",
"sourceAddress": 3
}
]
},
{
"id": 1,
"name": "sample string 2",
"number": 3,
"controllers": [
{
"id": 1,
"name": "sample string 2",
"sourceAddress": 3
},
{
"id": 1,
"name": "sample string 2",
"sourceAddress": 3
}
]
}
]
},
{
"id": 1,
"name": "sample string 2",
"description": "sample string 3",
"canBuses": [
{
"id": 1,
"name": "sample string 2",
"number": 3,
"controllers": [
{
"id": 1,
"name": "sample string 2",
"sourceAddress": 3
},
{
"id": 1,
"name": "sample string 2",
"sourceAddress": 3
}
]
},
{
"id": 1,
"name": "sample string 2",
"number": 3,
"controllers": [
{
"id": 1,
"name": "sample string 2",
"sourceAddress": 3
},
{
"id": 1,
"name": "sample string 2",
"sourceAddress": 3
}
]
}
]
}
]
},
{
"id": 1,
"name": "sample string 2",
"description": "sample string 3",
"models": [
{
"id": 1,
"name": "sample string 2",
"description": "sample string 3",
"canBuses": [
{
"id": 1,
"name": "sample string 2",
"number": 3,
"controllers": [
{
"id": 1,
"name": "sample string 2",
"sourceAddress": 3
},
{
"id": 1,
"name": "sample string 2",
"sourceAddress": 3
}
]
},
{
"id": 1,
"name": "sample string 2",
"number": 3,
"controllers": [
{
"id": 1,
"name": "sample string 2",
"sourceAddress": 3
},
{
"id": 1,
"name": "sample string 2",
"sourceAddress": 3
}
]
}
]
},
{
"id": 1,
"name": "sample string 2",
"description": "sample string 3",
"canBuses": [
{
"id": 1,
"name": "sample string 2",
"number": 3,
"controllers": [
{
"id": 1,
"name": "sample string 2",
"sourceAddress": 3
},
{
"id": 1,
"name": "sample string 2",
"sourceAddress": 3
}
]
},
{
"id": 1,
"name": "sample string 2",
"number": 3,
"controllers": [
{
"id": 1,
"name": "sample string 2",
"sourceAddress": 3
},
{
"id": 1,
"name": "sample string 2",
"sourceAddress": 3
}
]
}
]
}
]
}
],
"lastModified": "2026-10-30T01:26:48.1015064+00:00"
}
application/xml, text/xml
Sample:
<J1939Library xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Id>1</Id>
<Name>sample string 2</Name>
<Spns>
<J1939Spn>
<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>
<J1939Spn>
<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>
</Spns>
<GlobalFmis>
<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>
</GlobalFmis>
<OemEquipmentMakes>
<OemEquipmentMake>
<Id>1</Id>
<Name>sample string 2</Name>
<Description>sample string 3</Description>
<Models>
<OemEquipmentModel>
<Id>1</Id>
<Name>sample string 2</Name>
<Description>sample string 3</Description>
<CanBuses>
<OemCanBus>
<Id>1</Id>
<Name>sample string 2</Name>
<Number>3</Number>
<Controllers>
<OemCanBusController>
<Id>1</Id>
<Name>sample string 2</Name>
<SourceAddress>3</SourceAddress>
</OemCanBusController>
<OemCanBusController>
<Id>1</Id>
<Name>sample string 2</Name>
<SourceAddress>3</SourceAddress>
</OemCanBusController>
</Controllers>
</OemCanBus>
<OemCanBus>
<Id>1</Id>
<Name>sample string 2</Name>
<Number>3</Number>
<Controllers>
<OemCanBusController>
<Id>1</Id>
<Name>sample string 2</Name>
<SourceAddress>3</SourceAddress>
</OemCanBusController>
<OemCanBusController>
<Id>1</Id>
<Name>sample string 2</Name>
<SourceAddress>3</SourceAddress>
</OemCanBusController>
</Controllers>
</OemCanBus>
</CanBuses>
</OemEquipmentModel>
<OemEquipmentModel>
<Id>1</Id>
<Name>sample string 2</Name>
<Description>sample string 3</Description>
<CanBuses>
<OemCanBus>
<Id>1</Id>
<Name>sample string 2</Name>
<Number>3</Number>
<Controllers>
<OemCanBusController>
<Id>1</Id>
<Name>sample string 2</Name>
<SourceAddress>3</SourceAddress>
</OemCanBusController>
<OemCanBusController>
<Id>1</Id>
<Name>sample string 2</Name>
<SourceAddress>3</SourceAddress>
</OemCanBusController>
</Controllers>
</OemCanBus>
<OemCanBus>
<Id>1</Id>
<Name>sample string 2</Name>
<Number>3</Number>
<Controllers>
<OemCanBusController>
<Id>1</Id>
<Name>sample string 2</Name>
<SourceAddress>3</SourceAddress>
</OemCanBusController>
<OemCanBusController>
<Id>1</Id>
<Name>sample string 2</Name>
<SourceAddress>3</SourceAddress>
</OemCanBusController>
</Controllers>
</OemCanBus>
</CanBuses>
</OemEquipmentModel>
</Models>
</OemEquipmentMake>
<OemEquipmentMake>
<Id>1</Id>
<Name>sample string 2</Name>
<Description>sample string 3</Description>
<Models>
<OemEquipmentModel>
<Id>1</Id>
<Name>sample string 2</Name>
<Description>sample string 3</Description>
<CanBuses>
<OemCanBus>
<Id>1</Id>
<Name>sample string 2</Name>
<Number>3</Number>
<Controllers>
<OemCanBusController>
<Id>1</Id>
<Name>sample string 2</Name>
<SourceAddress>3</SourceAddress>
</OemCanBusController>
<OemCanBusController>
<Id>1</Id>
<Name>sample string 2</Name>
<SourceAddress>3</SourceAddress>
</OemCanBusController>
</Controllers>
</OemCanBus>
<OemCanBus>
<Id>1</Id>
<Name>sample string 2</Name>
<Number>3</Number>
<Controllers>
<OemCanBusController>
<Id>1</Id>
<Name>sample string 2</Name>
<SourceAddress>3</SourceAddress>
</OemCanBusController>
<OemCanBusController>
<Id>1</Id>
<Name>sample string 2</Name>
<SourceAddress>3</SourceAddress>
</OemCanBusController>
</Controllers>
</OemCanBus>
</CanBuses>
</OemEquipmentModel>
<OemEquipmentModel>
<Id>1</Id>
<Name>sample string 2</Name>
<Description>sample string 3</Description>
<CanBuses>
<OemCanBus>
<Id>1</Id>
<Name>sample string 2</Name>
<Number>3</Number>
<Controllers>
<OemCanBusController>
<Id>1</Id>
<Name>sample string 2</Name>
<SourceAddress>3</SourceAddress>
</OemCanBusController>
<OemCanBusController>
<Id>1</Id>
<Name>sample string 2</Name>
<SourceAddress>3</SourceAddress>
</OemCanBusController>
</Controllers>
</OemCanBus>
<OemCanBus>
<Id>1</Id>
<Name>sample string 2</Name>
<Number>3</Number>
<Controllers>
<OemCanBusController>
<Id>1</Id>
<Name>sample string 2</Name>
<SourceAddress>3</SourceAddress>
</OemCanBusController>
<OemCanBusController>
<Id>1</Id>
<Name>sample string 2</Name>
<SourceAddress>3</SourceAddress>
</OemCanBusController>
</Controllers>
</OemCanBus>
</CanBuses>
</OemEquipmentModel>
</Models>
</OemEquipmentMake>
</OemEquipmentMakes>
<LastModified>2026-10-30T01:26:48.1015064+00:00</LastModified>
</J1939Library>