GET v2/api/fleet/{key}?From={From}&To={To}&Statuses={Statuses}&Unit={Unit}
Fleet data 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.FleetRequestName | Description | Type | Additional information |
---|---|---|---|
requestedOn |
The date/time of the request |
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. |
equipments |
A collection of fleet assets |
Collection of Lhp.EquipmentIntelligence.WebApi.Models.V2.CustomerApiFeed.EquipmentModel |
None. |
Response Formats
application/json, text/json
{ "requestedOn": "2024-09-07T17:52:43Z", "requestedBy": "sample string 3", "from": "2024-09-07T17:52:43Z", "to": "2024-09-07T17:52:43Z", "equipments": [ { "id": "sample string 1", "data": [ { "key": "sample string 1", "description": "sample string 2", "value": "sample string 3", "unit": "sample string 4" }, { "key": "sample string 1", "description": "sample string 2", "value": "sample string 3", "unit": "sample string 4" } ] }, { "id": "sample string 1", "data": [ { "key": "sample string 1", "description": "sample string 2", "value": "sample string 3", "unit": "sample string 4" }, { "key": "sample string 1", "description": "sample string 2", "value": "sample string 3", "unit": "sample string 4" } ] } ] }
application/xml, text/xml
<FleetRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <RequestedOn>2024-09-07T17:52:43Z</RequestedOn> <RequestedBy>sample string 3</RequestedBy> <From>2024-09-07T17:52:43Z</From> <To>2024-09-07T17:52:43Z</To> <Equipments> <Equipment> <Id>sample string 1</Id> <Data> <Data key="sample string 1" description="sample string 2" value="sample string 3" unit="sample string 4" /> <Data key="sample string 1" description="sample string 2" value="sample string 3" unit="sample string 4" /> </Data> </Equipment> <Equipment> <Id>sample string 1</Id> <Data> <Data key="sample string 1" description="sample string 2" value="sample string 3" unit="sample string 4" /> <Data key="sample string 1" description="sample string 2" value="sample string 3" unit="sample string 4" /> </Data> </Equipment> </Equipments> </FleetRequest>