GET v2/api/events/{key}
Report event 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. |
ReportEventTypeIds |
Report events to retrieve (will override the API's configured report event filter). Report events not also appearing in the configured report event filter will be ignored. |
Collection of integer |
None. |
Body Parameters
None.
Response Information
Resource Description
Lhp.EquipmentIntelligence.WebApi.Models.V2.CustomerApiFeed.ReportEventRequestName | 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. |
reportEvents |
The faults occurring within the requested date range |
Collection of Lhp.EquipmentIntelligence.WebApi.Models.V2.CustomerApiFeed.ReportEventModel |
None. |
Response Formats
application/json, text/json
{ "requestedOn": "2024-09-07T17:52:13Z", "requestedBy": "sample string 3", "from": "2024-09-07T17:52:13Z", "to": "2024-09-07T17:52:13Z", "reportEvents": [ { "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", "reportEventTypeId": 11, "reportEventTypeName": "sample string 12", "timestamp": "2024-09-07T17:52:13Z", "location": { "latitude": 1.1, "longitude": 2.1 } }, { "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", "reportEventTypeId": 11, "reportEventTypeName": "sample string 12", "timestamp": "2024-09-07T17:52:13Z", "location": { "latitude": 1.1, "longitude": 2.1 } } ] }
application/xml, text/xml
<ReportEventRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <RequestedOn>2024-09-07T17:52:13Z</RequestedOn> <RequestedBy>sample string 3</RequestedBy> <From>2024-09-07T17:52:13Z</From> <To>2024-09-07T17:52:13Z</To> <ReportEvents> <ReportEvent> <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> <ReportEventTypeId>11</ReportEventTypeId> <ReportEventTypeName>sample string 12</ReportEventTypeName> <TimeStamp>2024-09-07T17:52:13Z</TimeStamp> <Location> <Latitude>1.1</Latitude> <Longitude>2.1</Longitude> </Location> </ReportEvent> <ReportEvent> <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> <ReportEventTypeId>11</ReportEventTypeId> <ReportEventTypeName>sample string 12</ReportEventTypeName> <TimeStamp>2024-09-07T17:52:13Z</TimeStamp> <Location> <Latitude>1.1</Latitude> <Longitude>2.1</Longitude> </Location> </ReportEvent> </ReportEvents> </ReportEventRequest>