GET api/v1/devices/{deviceId}/location?sortOrder={sortOrder}&startDate={startDate}&endDate={endDate}
Get the devices location history.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
deviceId | globally unique identifier |
Required |
|
sortOrder | SortOrder |
Default value is Asc |
|
startDate | string |
None. |
|
endDate |
Leave empty for all locations upto the current time. |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
DeviceLocationHistoryDtoName | Description | Type | Additional information |
---|---|---|---|
History | Collection of LocationHistoryDto |
None. |
|
Summary | LocationHistorySummary |
None. |
Response Formats
application/json, text/json, application/senml+json
Sample:
{ "History": [ { "Id": "4b307927-8582-4907-bd33-74c71d5b678a", "Name": "sample string 2", "Latitude": 3.1, "Longitude": 4.1, "Elevation": 5.1, "WellKnownLocationId": "fa52e408-fcf0-49b3-8343-50bd8b33ac9f", "Date": "2024-10-08T01:13:41.7279573+00:00", "TimeAtLocationSeconds": 1, "DistanceTraveledMeters": 6.1 }, { "Id": "4b307927-8582-4907-bd33-74c71d5b678a", "Name": "sample string 2", "Latitude": 3.1, "Longitude": 4.1, "Elevation": 5.1, "WellKnownLocationId": "fa52e408-fcf0-49b3-8343-50bd8b33ac9f", "Date": "2024-10-08T01:13:41.7279573+00:00", "TimeAtLocationSeconds": 1, "DistanceTraveledMeters": 6.1 } ], "Summary": { "TotalTimeSeconds": 1, "TotalDistanceMeters": 2.1 } }
application/xml, text/xml
Sample:
<DeviceLocationHistoryDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.DeviceLocation"> <History> <LocationHistoryDto> <Date>2024-10-08T01:13:41.7279573+00:00</Date> <DistanceTraveledMeters>6.1</DistanceTraveledMeters> <Elevation>5.1</Elevation> <Id>4b307927-8582-4907-bd33-74c71d5b678a</Id> <Latitude>3.1</Latitude> <Longitude>4.1</Longitude> <Name>sample string 2</Name> <TimeAtLocationSeconds>1</TimeAtLocationSeconds> <WellKnownLocationId>fa52e408-fcf0-49b3-8343-50bd8b33ac9f</WellKnownLocationId> </LocationHistoryDto> <LocationHistoryDto> <Date>2024-10-08T01:13:41.7279573+00:00</Date> <DistanceTraveledMeters>6.1</DistanceTraveledMeters> <Elevation>5.1</Elevation> <Id>4b307927-8582-4907-bd33-74c71d5b678a</Id> <Latitude>3.1</Latitude> <Longitude>4.1</Longitude> <Name>sample string 2</Name> <TimeAtLocationSeconds>1</TimeAtLocationSeconds> <WellKnownLocationId>fa52e408-fcf0-49b3-8343-50bd8b33ac9f</WellKnownLocationId> </LocationHistoryDto> </History> <Summary> <TotalDistanceMeters>2.1</TotalDistanceMeters> <TotalTimeSeconds>1</TotalTimeSeconds> </Summary> </DeviceLocationHistoryDto>