Reports – Programming Guide to the Hours of Service Platform

This API returns the available Reports, the export type and details for the parameters needed to generate and export each Report.

Fields

Tag	Data Type	Description
description	Text	Description of the Report
exportType	Character (255)	Available export type of the Report
id	Auto-incremented Long	Unique Identifier
isParent	Boolean	Indicates if the Report is a parent report
name	Text	Name of the Report
parameters	Array	Contains the available parameters to be used for generating the Report.

Read

API PATH:

/api/v2/reports

METHOD:

GET

EXAMPLE RESPONSE:

[
  {
    "id": 1527,
    "name": "Hours Worked (Date Range)",
    "description": "Driver's summary of hours work.",
    "exportType": "pdf",
    "parameters": [
      {
        "name": "ACCOUNT",
        "type": "java.lang.String",
        "defaultValue": "",
        "useAsPrompt": false
      },
      {
        "name": "Start Date",
        "type": "java.util.Date",
        "defaultValue": "2018-06-11",
        "useAsPrompt": true
      },
      {
        "name": "End Date",
        "type": "java.util.Date",
        "defaultValue": "2018-06-11",
        "useAsPrompt": true
      },
      {
        "name": "Driver Id",
        "type": "java.lang.Integer",
        "defaultValue": "",
        "useAsPrompt": true
      },
      {
        "name": "Terminal",
        "type": "java.lang.Integer",
        "defaultValue": "",
        "useAsPrompt": true
      }
    ],
    "isParent": false
  }
]