Telematics/Fleet/Equipment/{identifier}/CumulativeOperatingHours/{startDateUTC}/{endDateUTC}/{pageNumber}

Time Series - Cumulative Operating Hours

Endpoint Description

Cumulative operating hours endpoint provides a view into the current total lifetime operating hours of the machine is expressed as the cumulative quantity of time during which the machine’s engine has been running. This is generally the value of the hourmeter on 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/Fleet/Equipment/{identifier}/CumulativeOperatingHours/{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 current lifetime total cumulative operating hours of the machine is expressed by two separate fields as shown below.

CumulativeOperatingHoursMessages

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 CumulativeOperatingHoursMessagesLinks
CumulativeOperatingHours	Time Series cumulative operating hours. The current lifetime total cumulative operating hours of the machine.	Collection of CumulativeOperatingHoursMessagesCumulativeOperatingHours

Response Formats

{
  "Links": [
    {
      "rel": "sample string 1",
      "href": "sample string 2"
    },
    {
      "rel": "sample string 1",
      "href": "sample string 2"
    }
  ],
  "CumulativeOperatingHours": [
    {
      "Hour": 1.0,
      "datetime": "0001-01-01T00:00:00Z"
    },
    {
      "Hour": 1.0,
      "datetime": "0001-01-01T00:00:00Z"
    }
  ]
}

<CumulativeOperatingHoursMessages 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>
  <CumulativeOperatingHours>
    <Hour>1</Hour>
    <datetime>0001-01-01T00:00:00Z</datetime>
  </CumulativeOperatingHours>
  <CumulativeOperatingHours>
    <Hour>1</Hour>
    <datetime>0001-01-01T00:00:00Z</datetime>
  </CumulativeOperatingHours>
</CumulativeOperatingHoursMessages>

Return