Operating Hours v1

The operating hours’ endpoint retrieves all the operating hour measurements send from equipment in a given location with the location_id parameter and in certain time frames using the from and to query parameters.

Definition

An operating hour measurement is a recording of the current operational hours of a given piece of equipment, measured in hours, including a timestamp when then measurement was recorded.

Latest operating hours

Introduction

/locations/{location_id}/operating-hours/v1

The latest operating hours endpoint retreives the most recent measurement from a given point in time, using the at query parameter.

Example entity

{
  "equipment_number": "FA324589",
  "equipment_id": "9f0314ce61a169af6eb8e972babee65c3a0f8f27a2904527ea7265bd9bb06de7",
  "operating_hours": {
    "value": 6710,
    "timestamp": "2020-11-09T05:08:10.000Z",
    "data_source": "telematics"
  }
}

Frequency

Operating Hours are updated just in time when the trucks send the data. Manual entered operating hours are imported every 4 hours.

Reference Docs

Historical operating hours

Introduction

/locations/{location_id}/operating-hours/history/v1

The historical operating hours’ endpoint retrieves the measurements for all the equipment that is or was assigned to the given location and was recorded between the given from and to query parameters. Per default only 100 meter readings will be returned per request. To receive the next chunk of data a cursor query parameter has to be specified. This cursor can be found in the metadata.pagination.cursor field of the response. Alternatively under metadata.pagination.next_pagea url can be found to gain the next data points for the given time period. This metadata field is present until no data for the time period is available.

Example entity

Following an example given the assumption we would limit the number of records to 4.

{
  "data": [
    {
      "equipment_number": "123456",
      "equipment_id": "e60986f205840f6f23763ac47a53711af4cd7441384c988d85f6ecac604f26ea",
      "operating_hours": [
        {
          "value": 12273,
          "timestamp": "2020-06-19T12:04:40.000Z",
          "data_source": "telematics"
        },
        {
          "value": 812,
          "timestamp": "2020-06-20T12:04:40.000Z",
          "data_source": "telematics"
        }
      ]
    },
    {
      "equipment_number": "7890101",
      "equipment_id": "31b34edb8d526341bbb21a9b78471ddedcd402521d0f17da3507c7cc02bc558e",
      "operating_hours": [
        {
          "value": 912,
          "timestamp": "2020-05-18T15:04:40.000Z",
          "data_source": "service_report"
        },
        {
          "value": 8111,
          "timestamp": "2020-06-20T12:04:40.000Z",
          "data_source": "service_report"
        }
      ]
    }
  ],
  "metadata": {
    "pagination": {
      "cursor": "eyJsaW1pdCI6MTAwLCAib2Zmc2V0IjoxMDB9",
      "next_page": "https://fms-api.prod.turbo.jdsaws.com/fleet/v1/locations/123456/operating-hours/history/v1?from=2020-05-01&to=2020-08-30&cursor=eyJsaW1pdCI6MTAwLCAib2Zmc2V0IjoxMDB9"  
    }
  }
}

Reference Docs