Telematics Documentation

Introduction

This page is to provide information about the Takeuchi Fleet Management(TFM) telematics API(s). This page and its API endpoints may be updated. When changes occur, this page will reflect those changes.

Telematics v2 v2.08.1

The goal of this API is to provide direct access to end-users specific fleet data. Its design is to ensure that 14 days of data is available. This page contains data schema(s) for data transmitted directly from the equipment to the equipment owner in a standardized format. It is important to note that not all data points are available. This API reflects data points that will be available for consumption.
  • 2.08.1 Internal updates to API, database connections.
  • 2.08.0 Internal updates to API, authentication.
  • 2.07.1 Internal updates to API, database requests.
  • 2.07.0 Internal updates for logging, web interface updates.
  • 2.06.3 Web interface updates.
  • 2.06.2 Web interface updates, information added to endpoints and data fields. Printer friendly.
  • 2.06.1 Web interface updates, header information added.
  • 2.06.0 Internal updates to API, database updates, description information added to web interface.
  • 2.05.1 Web interface updates, deprecated information added to help page(s).
  • 2.05.0 Internal updates to API. Code refactoring and help page information.
  • 2.04.3 Web interface updates, description information added to web interface.
  • 2.04.2 Web interface updates, design updates of help page section.
  • 2.04.1 Re-design of web interface, help page(s), Takeuchi theme.
  • 2.04.0 Internal updates, data fields updated to match ISO.
  • 2.03.0 Internal authorization updates.
  • 2.02.0 Internal updates, code refactoring. Endpoint updates.
  • 2.01.0 Internal updates, allowing for quicker response times.
  • 2.00.0 Release of API updated to ISO standard. 15143-3:2020
Snapshot - Fleet
Telematics/Fleet/{pageNumber} Provides a snapshot view of the fleet and is paginated with a default of 100 records per page. GET
Snapshot - Single-Element
Telematics/Fleet/Equipment/{identifier} Provides a snapshot view of a single piece of equipment. GET
Time Series - Location
Telematics/Fleet/Equipment/{identifier}/Locations/{startDateUTC}/{endDateUTC}/{pageNumber} Provides a view into telematics locations data for a single equipment over the specified time. GET
Time Series - Cumulative Operating Hours
Telematics/Fleet/Equipment/{identifier}/CumulativeOperatingHours/{startDateUTC}/{endDateUTC}/{pageNumber} Provides a view into telematics operation hours for a single equipment over the specified time. GET
Time Series - Cumulative Fuel Used
Telematics/Fleet/Equipment/{identifier}/CumulativeFuelUsed/{startDateUTC}/{endDateUTC}/{pageNumber} Provides a view into total fuel used for a single equipment over the specified time. GET
Time Series - Fuel Remaining Ratio
Telematics/Fleet/Equipment/{identifier}/FuelRemainingRatio/{startDateUTC}/{endDateUTC}/{pageNumber} Provides a view of the percentage of fuel remaining in the fuel tank of the machine. GET
Time Series - Diesel Exhaust Fluid (DEF) Remaining
Telematics/Fleet/Equipment/{identifier}/DEFRemaining/{startDateUTC}/{endDateUTC}/{pageNumber} Provides a view into the percentage of diesel exhaust fluid remaining in the tank of the machine. GET
Time Series - Engine Condition
Telematics/Fleet/Equipment/{identifier}/EngineCondition/{startDateUTC}/{endDateUTC}/{pageNumber} Provides a view into the current status of the machine’s engine running state. GET
Time Series - Faults
Telematics/Fleet/Equipment/{identifier}/Faults/{startDateUTC}/{endDateUTC}/{pageNumber} Provides a view into the machine’s diagnostic trouble codes that occurred. GET