Time Series - Cumulative Fuel Used

Endpoint Description

Cumulative fuel used endpoint provides a view into the current total amount of fuel consumed by the machine. 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}/CumulativeFuelUsed/{startDateUTC}/{endDateUTC}/{pageNumber}

URI Parameters

Name Description Type Additional Information
identifier The PIN or VIN that uniquely identifies an asset. string 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 total amount of fuel consumed by the machine is expressed by three separate fields. This data element represents the cumulative amount of fuel used by the machine since its manufacture.

FuelUsedMessages

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 FuelUsedMessagesLinks
FuelUsed Time Series cumulative fuel used. The total amount of fuel consumed by the machine since its manufacture. Collection of FuelUsedMessagesFuelUsed

Response Formats

<FuelUsedMessages 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>
  <FuelUsed datetime="0001-01-01T00:00:00Z">
    <FuelUnits>sample string 1</FuelUnits>
    <FuelConsumed>2</FuelConsumed>
  </FuelUsed>
  <FuelUsed datetime="0001-01-01T00:00:00Z">
    <FuelUnits>sample string 1</FuelUnits>
    <FuelConsumed>2</FuelConsumed>
  </FuelUsed>
</FuelUsedMessages>
Return