GET apioauth/installations/{installationId}/telemetry/{startDate}/{endDate}

Get telemetry from a unit being installed

Request Information

URI Parameters

NameDescriptionTypeAdditional information
installationId

The installation id queried

integer

Required

startDate

The start date being queried yyyyMMddHHmmss

string

Required

endDate

The end date being queried yyyyMMddHHmmss

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of MobileServiceTelemetryResponse
NameDescriptionTypeAdditional information
ServiceID

The service id which created the telemetry

unsigned integer

None.

GPSOrientation

The GPS orientation in degrees

decimal number

None.

GPSLatitude

The GPS latitude in degrees

decimal number

None.

GPSLongitude

The GPS longitude in degrees

decimal number

None.

GPSSpeed

The GPS speed in miles per hour

decimal number

None.

GPSTime

The GPS time in UTC

date

None.

RoadSpeed

The road speed in mph

integer

None.

Street

The street where the service is located

string

None.

Town

The town where the service is located

string

None.

Postcode

The postcode where the service is located

string

None.

Country

The country where the service is located

string

None.

JourneyStatus

Indicates if the service is in a journey

boolean

None.

IdleStatus

Indicates if the service is idling

boolean

None.

MessageType

The message type

event_t

None.

BatteryVoltage

The Battery Voltage

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ServiceID": 1,
    "GPSOrientation": 2.1,
    "GPSLatitude": 3.1,
    "GPSLongitude": 4.1,
    "GPSSpeed": 5.1,
    "GPSTime": "2025-04-27T16:39:57.3815485+00:00",
    "RoadSpeed": 7,
    "Street": "sample string 8",
    "Town": "sample string 9",
    "Postcode": "sample string 10",
    "Country": "sample string 11",
    "JourneyStatus": true,
    "IdleStatus": true,
    "MessageType": 0,
    "BatteryVoltage": 14.1
  },
  {
    "ServiceID": 1,
    "GPSOrientation": 2.1,
    "GPSLatitude": 3.1,
    "GPSLongitude": 4.1,
    "GPSSpeed": 5.1,
    "GPSTime": "2025-04-27T16:39:57.3815485+00:00",
    "RoadSpeed": 7,
    "Street": "sample string 8",
    "Town": "sample string 9",
    "Postcode": "sample string 10",
    "Country": "sample string 11",
    "JourneyStatus": true,
    "IdleStatus": true,
    "MessageType": 0,
    "BatteryVoltage": 14.1
  }
]

application/xml, text/xml

Sample:
<ArrayOfMobileServiceTelemetryResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <MobileServiceTelemetryResponse>
    <ServiceID>1</ServiceID>
    <GPSOrientation>2.1</GPSOrientation>
    <GPSLatitude>3.1</GPSLatitude>
    <GPSLongitude>4.1</GPSLongitude>
    <GPSSpeed>5.1</GPSSpeed>
    <GPSTime>2025-04-27T16:39:57.3815485+00:00</GPSTime>
    <RoadSpeed>7</RoadSpeed>
    <Street>sample string 8</Street>
    <Town>sample string 9</Town>
    <Postcode>sample string 10</Postcode>
    <Country>sample string 11</Country>
    <JourneyStatus>true</JourneyStatus>
    <IdleStatus>true</IdleStatus>
    <MessageType>NO_EVENT</MessageType>
    <BatteryVoltage>14.1</BatteryVoltage>
  </MobileServiceTelemetryResponse>
  <MobileServiceTelemetryResponse>
    <ServiceID>1</ServiceID>
    <GPSOrientation>2.1</GPSOrientation>
    <GPSLatitude>3.1</GPSLatitude>
    <GPSLongitude>4.1</GPSLongitude>
    <GPSSpeed>5.1</GPSSpeed>
    <GPSTime>2025-04-27T16:39:57.3815485+00:00</GPSTime>
    <RoadSpeed>7</RoadSpeed>
    <Street>sample string 8</Street>
    <Town>sample string 9</Town>
    <Postcode>sample string 10</Postcode>
    <Country>sample string 11</Country>
    <JourneyStatus>true</JourneyStatus>
    <IdleStatus>true</IdleStatus>
    <MessageType>NO_EVENT</MessageType>
    <BatteryVoltage>14.1</BatteryVoltage>
  </MobileServiceTelemetryResponse>
</ArrayOfMobileServiceTelemetryResponse>