Time Series - Location

Endpoint Description

Locations endpoint provides a view into locations data for a single equipment over the specified time. The range is specified by its start date and time and end date and time. Date and time are expressed as YYYY-MM-DDThh:mm:ssZ. This endpoint is designed to be discoverable so that the integrating system can follow links to sets of time series telematics data as dictated by the business need. A single piece of equipment is identified by the inclusion of a PIN or VIN as the parameter {identifier} in the URL. A call to this endpoint shall return the available readings within the time frame for the equipment specified.

Request Information

URI

Authorize GEThttps://api20.takeuchi-us.com/Telematics/v3/Fleet/Equipment/{identifier}/Locations/{startDateUTC}/{endDateUTC}/{pageNumber}

URI Parameters

Name Description Type Additional Information
identifier The PIN or VIN that uniquely identifies an asset. integer Required
startDateUTC Starting date for time series. (YYYY-MM-DDThh:mm:ssZ) date Required
endDateUTC Ending date for time series. (YYYY-MM-DDThh:mm:ssZ) date Required
pageNumber Navigation is controlled by the page number. integer Required

Header Parameters

Key Value Description Requirements
Authorization Bearer *Token generated from Connect endpoints. Authorization is required to access this endpoint. Required
Accept */* | application/xml | application/json By default responses will be "application/xml". Optional

Body Parameters

None (Empty)

Response Information

Resource Description

Provides a JSON or XML formatted view of the telematic locations data for a single equipment over the specified time.

LocationMessages

Name Information Type
Links Links are used to describe the meta data about call. Each link contains a relationship (rel) and a hyperlink (href). Collection of LocationMessagesLinks
Location Time Series location. The last known equipment location. Collection of LocationMessagesLocation

Response Formats

<LocationMessages xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.jcmanet.or.jp/english2017/ISO/15143/-3/20190501">
  <Links>
    <rel>sample string 1</rel>
    <href>sample string 2</href>
  </Links>
  <Links>
    <rel>sample string 1</rel>
    <href>sample string 2</href>
  </Links>
  <Location datetime="0001-01-01T00:00:00Z">
    <Latitude>1</Latitude>
    <Longitude>2</Longitude>
    <Altitude>3</Altitude>
    <AltitudeUnits>sample string 4</AltitudeUnits>
  </Location>
  <Location datetime="0001-01-01T00:00:00Z">
    <Latitude>1</Latitude>
    <Longitude>2</Longitude>
    <Altitude>3</Altitude>
    <AltitudeUnits>sample string 4</AltitudeUnits>
  </Location>
</LocationMessages>
Return