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

DeviceLocationHistoryDto

Name	Description	Type	Additional information
History		Collection of LocationHistoryDto	None.
Summary		LocationHistorySummary	None.

Response Formats

application/json, text/json, application/senml+json

Sample:

{
  "History": [
    {
      "Id": "85bda2ae-8df5-4e87-8a02-3bf8e7174a7f",
      "Name": "sample string 2",
      "Latitude": 3.1,
      "Longitude": 4.1,
      "Elevation": 5.1,
      "WellKnownLocationId": "fba02281-89d3-439e-938f-4e56af458ec9",
      "Date": "2024-11-21T05:31:01.8953723+00:00",
      "TimeAtLocationSeconds": 1,
      "DistanceTraveledMeters": 6.1
    },
    {
      "Id": "85bda2ae-8df5-4e87-8a02-3bf8e7174a7f",
      "Name": "sample string 2",
      "Latitude": 3.1,
      "Longitude": 4.1,
      "Elevation": 5.1,
      "WellKnownLocationId": "fba02281-89d3-439e-938f-4e56af458ec9",
      "Date": "2024-11-21T05:31:01.8953723+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-11-21T05:31:01.8953723+00:00</Date>
      <DistanceTraveledMeters>6.1</DistanceTraveledMeters>
      <Elevation>5.1</Elevation>
      <Id>85bda2ae-8df5-4e87-8a02-3bf8e7174a7f</Id>
      <Latitude>3.1</Latitude>
      <Longitude>4.1</Longitude>
      <Name>sample string 2</Name>
      <TimeAtLocationSeconds>1</TimeAtLocationSeconds>
      <WellKnownLocationId>fba02281-89d3-439e-938f-4e56af458ec9</WellKnownLocationId>
    </LocationHistoryDto>
    <LocationHistoryDto>
      <Date>2024-11-21T05:31:01.8953723+00:00</Date>
      <DistanceTraveledMeters>6.1</DistanceTraveledMeters>
      <Elevation>5.1</Elevation>
      <Id>85bda2ae-8df5-4e87-8a02-3bf8e7174a7f</Id>
      <Latitude>3.1</Latitude>
      <Longitude>4.1</Longitude>
      <Name>sample string 2</Name>
      <TimeAtLocationSeconds>1</TimeAtLocationSeconds>
      <WellKnownLocationId>fba02281-89d3-439e-938f-4e56af458ec9</WellKnownLocationId>
    </LocationHistoryDto>
  </History>
  <Summary>
    <TotalDistanceMeters>2.1</TotalDistanceMeters>
    <TotalTimeSeconds>1</TotalTimeSeconds>
  </Summary>
</DeviceLocationHistoryDto>