Time Series - Engine Condition

Endpoint Description

Engine condition is an indicator of the current status of the machine’s engine running state. 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/Fleet/Equipment/{identifier}/EngineCondition/{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 into the current status of the machine’s engine running state is expressed by three separate fields.

EngineStatusMessages

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 EngineStatusMessagesLinks
EngineStatus Time Series engine condition. Engine condition is an indicator of the current status of the machine’s engine running state. Collection of EngineStatusMessagesEngineStatus

Response Formats

<EngineStatusMessages 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>
  <EngineStatus datetime="0001-01-01T00:00:00Z">
    <EngineNumber>sample string 1</EngineNumber>
    <Running>true</Running>
  </EngineStatus>
  <EngineStatus datetime="0001-01-01T00:00:00Z">
    <EngineNumber>sample string 1</EngineNumber>
    <Running>true</Running>
  </EngineStatus>
</EngineStatusMessages>
Return