GET api/v1/devices/{deviceId}/location?sortOrder={sortOrder}&startDate={startDate}&endDate={endDate}

Get the devices location history.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional information
History

Collection of LocationHistoryDto

None.
Summary

LocationHistorySummary

None.

Response Formats

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

Sample: 
{
  "History": [
    {
      "Id": "45b5cf0e-3d59-40f6-90ef-38de9894a409",
      "Name": "sample string 2",
      "Latitude": 3.1,
      "Longitude": 4.1,
      "Elevation": 5.1,
      "WellKnownLocationId": "88d9676f-91c9-48aa-a076-75c813d34550",
      "Date": "2024-11-24T15:16:42.0512247+00:00",
      "TimeAtLocationSeconds": 1,
      "DistanceTraveledMeters": 6.1
    },
    {
      "Id": "45b5cf0e-3d59-40f6-90ef-38de9894a409",
      "Name": "sample string 2",
      "Latitude": 3.1,
      "Longitude": 4.1,
      "Elevation": 5.1,
      "WellKnownLocationId": "88d9676f-91c9-48aa-a076-75c813d34550",
      "Date": "2024-11-24T15:16:42.0512247+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-24T15:16:42.0512247+00:00</Date>
      <DistanceTraveledMeters>6.1</DistanceTraveledMeters>
      <Elevation>5.1</Elevation>
      <Id>45b5cf0e-3d59-40f6-90ef-38de9894a409</Id>
      <Latitude>3.1</Latitude>
      <Longitude>4.1</Longitude>
      <Name>sample string 2</Name>
      <TimeAtLocationSeconds>1</TimeAtLocationSeconds>
      <WellKnownLocationId>88d9676f-91c9-48aa-a076-75c813d34550</WellKnownLocationId>
    </LocationHistoryDto>
    <LocationHistoryDto>
      <Date>2024-11-24T15:16:42.0512247+00:00</Date>
      <DistanceTraveledMeters>6.1</DistanceTraveledMeters>
      <Elevation>5.1</Elevation>
      <Id>45b5cf0e-3d59-40f6-90ef-38de9894a409</Id>
      <Latitude>3.1</Latitude>
      <Longitude>4.1</Longitude>
      <Name>sample string 2</Name>
      <TimeAtLocationSeconds>1</TimeAtLocationSeconds>
      <WellKnownLocationId>88d9676f-91c9-48aa-a076-75c813d34550</WellKnownLocationId>
    </LocationHistoryDto>
  </History>
  <Summary>
    <TotalDistanceMeters>2.1</TotalDistanceMeters>
    <TotalTimeSeconds>1</TotalTimeSeconds>
  </Summary>
</DeviceLocationHistoryDto>