GET Device/{id}/Stop/{start}/{end}/{firstLoad}/{includeLocation}

Get all stops by device.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Internal Id to the device.

integer

Required

start

Start of daterange to search in.

integer

Required

end

End of daterange to search in.

integer

Required

firstLoad

Indicates most recent stops should be loaded. Start/End date will be ignored.

boolean

Default value is True

includeLocation

Indicates stop locations will be returned. Will cause heavier processing.

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

A enumeration of StopsRestItem objects.

StopRestResult
NameDescriptionTypeAdditional information
BeginDateTime

date

None.

EndDateTime

date

None.

Stops

Collection of StopRestItem

None.

Response Formats

application/json, text/json

Sample:
{
  "BeginDateTime": "2024-04-29T20:44:51.6161725+02:00",
  "EndDateTime": "2024-04-29T20:44:51.6167834+02:00",
  "Stops": [
    {
      "StopId": 1,
      "DeviceId": 2,
      "BeginDateTime": "2024-04-29T20:44:51.6174172+02:00",
      "EndDateTime": "2024-04-29T20:44:51.6174172+02:00",
      "Latitude": 1.1,
      "Longitude": 1.1,
      "HasEpisodes": true
    },
    {
      "StopId": 1,
      "DeviceId": 2,
      "BeginDateTime": "2024-04-29T20:44:51.6174172+02:00",
      "EndDateTime": "2024-04-29T20:44:51.6174172+02:00",
      "Latitude": 1.1,
      "Longitude": 1.1,
      "HasEpisodes": true
    }
  ]
}

application/xml, text/xml

Sample:
<StopRestResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api360.Models">
  <BeginDateTime>2024-04-29T20:44:51.6161725+02:00</BeginDateTime>
  <EndDateTime>2024-04-29T20:44:51.6167834+02:00</EndDateTime>
  <Stops>
    <StopRestItem>
      <BeginDateTime>2024-04-29T20:44:51.6174172+02:00</BeginDateTime>
      <DeviceId>2</DeviceId>
      <EndDateTime>2024-04-29T20:44:51.6174172+02:00</EndDateTime>
      <HasEpisodes>true</HasEpisodes>
      <Latitude>1.1</Latitude>
      <Longitude>1.1</Longitude>
      <StopId>1</StopId>
    </StopRestItem>
    <StopRestItem>
      <BeginDateTime>2024-04-29T20:44:51.6174172+02:00</BeginDateTime>
      <DeviceId>2</DeviceId>
      <EndDateTime>2024-04-29T20:44:51.6174172+02:00</EndDateTime>
      <HasEpisodes>true</HasEpisodes>
      <Latitude>1.1</Latitude>
      <Longitude>1.1</Longitude>
      <StopId>1</StopId>
    </StopRestItem>
  </Stops>
</StopRestResult>