GET v2/api/faults/{key}?From={From}&To={To}&Statuses={Statuses}&Unit={Unit}

Fault API provider

Request Information

URI Parameters

Name	Description	Type	Additional information
key	The assigned API application key	string	Required
From	The range start timestamp in UTC. If not provided, will default to last 30 days. Ranges cannot exceed 30 days.	date	None.
To	The range end timestamp in UTC. If not provided, will default to current date/time. Ranges cannot exceed 30 days.	date	None.
Statuses	Asset statuses to retrieve (will override the API's configured asset status filter)	Lhp.EquipmentIntelligence.CustomerAssetStatuses	None.
Unit	By default measurement units are in the requesting user's unit system preference. It can be overridden using this parameter.	Lhp.EquipmentIntelligence.UnitSystems	None.

Body Parameters

None.

Response Information

Resource Description

Lhp.EquipmentIntelligence.WebApi.Models.V2.CustomerApiFeed.FaultRequest

Name	Description	Type	Additional information
requestedOn	The date/time of the request in UTC	string	None.
requestedBy	The username of the requesting login	string	None.
from	The starting date/time of the resulting data in UTC	string	None.
to	The ending date/time of the resulting data in UTC	string	None.
faults	The faults occurring within the requested date range	Collection of Lhp.EquipmentIntelligence.WebApi.Models.V2.CustomerApiFeed.FaultModel	None.

Response Formats

application/json, text/json

Sample:

{
  "requestedOn": "2024-09-07T17:52:57Z",
  "requestedBy": "sample string 3",
  "from": "2024-09-07T17:52:57Z",
  "to": "2024-09-07T17:52:57Z",
  "faults": [
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "vin": "sample string 3",
      "serialNumber": "sample string 4",
      "year": "sample string 5",
      "tcuType": "sample string 6",
      "tcuImei": "sample string 7",
      "tcuSerialNumber": "sample string 8",
      "simIccid": "sample string 9",
      "Status": "sample string 10",
      "timestamp": "2024-09-07T17:52:57Z",
      "type": "sample string 13",
      "canBus": 1,
      "sourceAddress": 1,
      "spn": 1,
      "spnDescription": "sample string 14",
      "fmi": 1,
      "fmiDescription": "sample string 15",
      "code": "sample string 16",
      "codeDescription": "sample string 17",
      "oemCode": "sample string 18",
      "severity": "sample string 19",
      "distanceTraveled": 1.0,
      "distanceTraveledUnit": "sample string 20",
      "distanceTraveledTimestamp": "2024-09-07T17:52:57Z",
      "engineHours": 1.0,
      "engineHoursTimestamp": "2024-09-07T17:52:57Z",
      "location": {
        "timestamp": "2024-09-07T17:52:57Z",
        "latitude": 3.1,
        "longitude": 4.1,
        "altitude": 1,
        "altitudeUnit": "sample string 5"
      }
    },
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "vin": "sample string 3",
      "serialNumber": "sample string 4",
      "year": "sample string 5",
      "tcuType": "sample string 6",
      "tcuImei": "sample string 7",
      "tcuSerialNumber": "sample string 8",
      "simIccid": "sample string 9",
      "Status": "sample string 10",
      "timestamp": "2024-09-07T17:52:57Z",
      "type": "sample string 13",
      "canBus": 1,
      "sourceAddress": 1,
      "spn": 1,
      "spnDescription": "sample string 14",
      "fmi": 1,
      "fmiDescription": "sample string 15",
      "code": "sample string 16",
      "codeDescription": "sample string 17",
      "oemCode": "sample string 18",
      "severity": "sample string 19",
      "distanceTraveled": 1.0,
      "distanceTraveledUnit": "sample string 20",
      "distanceTraveledTimestamp": "2024-09-07T17:52:57Z",
      "engineHours": 1.0,
      "engineHoursTimestamp": "2024-09-07T17:52:57Z",
      "location": {
        "timestamp": "2024-09-07T17:52:57Z",
        "latitude": 3.1,
        "longitude": 4.1,
        "altitude": 1,
        "altitudeUnit": "sample string 5"
      }
    }
  ]
}

application/xml, text/xml

Sample:

<FaultRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <RequestedOn>2024-09-07T17:52:57Z</RequestedOn>
  <RequestedBy>sample string 3</RequestedBy>
  <From>2024-09-07T17:52:57Z</From>
  <To>2024-09-07T17:52:57Z</To>
  <Faults>
    <Fault>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
      <Vin>sample string 3</Vin>
      <SerialNumber>sample string 4</SerialNumber>
      <Year>sample string 5</Year>
      <TcuType>sample string 6</TcuType>
      <TcuImei>sample string 7</TcuImei>
      <TcuSerialNumber>sample string 8</TcuSerialNumber>
      <SimIccid>sample string 9</SimIccid>
      <Status>sample string 10</Status>
      <TimeStamp>2024-09-07T17:52:57Z</TimeStamp>
      <Type>sample string 13</Type>
      <CanBus>1</CanBus>
      <SourceAddress>1</SourceAddress>
      <Spn>1</Spn>
      <SpnDescription>sample string 14</SpnDescription>
      <Fmi>1</Fmi>
      <FmiDescription>sample string 15</FmiDescription>
      <Code>sample string 16</Code>
      <CodeDescription>sample string 17</CodeDescription>
      <OemCode>sample string 18</OemCode>
      <Severity>sample string 19</Severity>
      <DistanceTraveled>1</DistanceTraveled>
      <DistanceTraveledUnit>sample string 20</DistanceTraveledUnit>
      <DistanceTraveledTimestamp>2024-09-07T17:52:57Z</DistanceTraveledTimestamp>
      <EngineHours>1</EngineHours>
      <EngineHoursTimestamp>2024-09-07T17:52:57Z</EngineHoursTimestamp>
      <Location>
        <TimeStamp>2024-09-07T17:52:57Z</TimeStamp>
        <Latitude>3.1</Latitude>
        <Longitude>4.1</Longitude>
        <Altitude>1</Altitude>
        <AltitudeUnit>sample string 5</AltitudeUnit>
      </Location>
    </Fault>
    <Fault>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
      <Vin>sample string 3</Vin>
      <SerialNumber>sample string 4</SerialNumber>
      <Year>sample string 5</Year>
      <TcuType>sample string 6</TcuType>
      <TcuImei>sample string 7</TcuImei>
      <TcuSerialNumber>sample string 8</TcuSerialNumber>
      <SimIccid>sample string 9</SimIccid>
      <Status>sample string 10</Status>
      <TimeStamp>2024-09-07T17:52:57Z</TimeStamp>
      <Type>sample string 13</Type>
      <CanBus>1</CanBus>
      <SourceAddress>1</SourceAddress>
      <Spn>1</Spn>
      <SpnDescription>sample string 14</SpnDescription>
      <Fmi>1</Fmi>
      <FmiDescription>sample string 15</FmiDescription>
      <Code>sample string 16</Code>
      <CodeDescription>sample string 17</CodeDescription>
      <OemCode>sample string 18</OemCode>
      <Severity>sample string 19</Severity>
      <DistanceTraveled>1</DistanceTraveled>
      <DistanceTraveledUnit>sample string 20</DistanceTraveledUnit>
      <DistanceTraveledTimestamp>2024-09-07T17:52:57Z</DistanceTraveledTimestamp>
      <EngineHours>1</EngineHours>
      <EngineHoursTimestamp>2024-09-07T17:52:57Z</EngineHoursTimestamp>
      <Location>
        <TimeStamp>2024-09-07T17:52:57Z</TimeStamp>
        <Latitude>3.1</Latitude>
        <Longitude>4.1</Longitude>
        <Altitude>1</Altitude>
        <AltitudeUnit>sample string 5</AltitudeUnit>
      </Location>
    </Fault>
  </Faults>
</FaultRequest>