Programming Guide to the Hours of Service Platform

ELD Malfunctions

Returns details of the most recent ELD malfunctions.

Fields

Tag Data Type Required Description
accountId Long No The id of the Account that owns this record.
assetId Long Yes The id of the Vehicle used during this ELD Malfunction
beginTimestamp Text No Date and time when the ELD Malfunction began.
Note: Format is in timestamp and timezone (YYYY-MM-DDTHH:MM:SS.sssZ, e.g: 1970-01-01T00:00:00.000Z)
driverHistoryUUID Character (255) No The id of the Driver History record associated with the ELD Malfunction.
endTimestamp Text No Date and time when the ELD Malfunction ended.
Note: Format is in timestamp and timezone (YYYY-MM-DDTHH:MM:SS.sssZ, e.g: 1970-01-01T00:00:00.000Z)
eventType Character (255) No Indicates the type of ELD Malfunction that occurred. Examples of eventType values are:

  • MalPower
  • MalSync
  • MalTime
  • MalPos
  • MalRecord
  • MalTransfer
  • MalOther
  • DiagPower
  • DiagSync
  • DiagMissing
  • DiagTransfer
  • DiagUnidentified
  • DiagOther
id Auto-incremented Long Auto Unique identifier
lastChangedDate Text Auto Auto-generated timestamp of the last change made to this record
Note: Format is in timestamp and timezone (YYYY-MM-DDTHH:MM:SS.sssZ, e.g: 1970-01-01T00:00:00.000Z)
userId Long Yes The id of the Driver who owns this ELD Malfunction

Create

API PATH: /api/v2/eldMalfunctions
METHOD: POST
EXAMPLE REQUEST: 
[
  {
    "assetId": 1321545,
    "userId": 1250887,
    "eventType": "DiagMissing",
    "beginTimestamp": "2018-06-11T11:30:00.000Z",
    "driverHistoryUUID": "9cf93930-61f1-4f20-b24f-ce236ee7e319",
    "endTimestamp": null
  }
]
EXAMPLE RESPONSE: 
[
  {
    "assetId": 1321545,
    "userId": 1250887,
    "eventType": "DiagMissing",
    "beginTimestamp": "2018-06-11T11:30:00.000Z",
    "driverHistoryUUID": "9cf93930-61f1-4f20-b24f-ce236ee7e319",
    "endTimestamp": null,
    "accountId": 1248280,
    "id": 7,
    "lastChangedDate": "2018-06-11T12:00:00.000Z"
  }
]

Read

API PATH: /api/v2/eldMalfunctions
METHOD: GET
PARAMETERS:

user-id – Retrieves matching records for a specific User (e.g. user-id=496650, current User by default) 
asset-id – Retrieves matching records for a specific Asset. Also accepts comma-separated values for multiple Assets (e.g. asset-id=1321545, all Assets by default) 
event-type – Retrieves matching records that have the specified event type (e.g. event-type=DiagMissing, all event types by default)
system – Retrieves matching records based on Driver type of the owner of record, depending on the boolean value specified. (e.g. system=false, all types by default) 
cleared – Retrieves matching records if their status have been cleared or not, depending on the boolean value specified. (e.g. cleared=false, all statuses by default)
from-timestamp – Retrieves records with beginTimestamp field that is after the specified time (e.g. from-timestamp=2018-06-11T11:30:00.000Z, all timestamps by default)
to-timestamp – Retrieves records with beginTimestamp field that is before the specified time (e.g. to-timestamp=2018-06-11T11:30:00.000Z, all timestamps by default)
from-change-timestamp – Retrieves records modified since the timestamp supplied (e.g. from-change-timestamp=2018-06-11T12:00:00.000Z, all timestamps by default)
to-change-timestamp – Retrieves records modified before the timestamp supplied (e.g. to-change-timestamp=2018-06-11T12:00:00.000Z, REQUIRES from-change-timestamp)
offset – Retrieves matching records after an offset value (e.g. offset=2, zero offset by default)
limit – Retrieves a number of records per page specified by the value (e.g. limit=10, all records by default)
description– Retrieves all the data with the match description in this parameter.

 
SORTING: sort=id – Sort records by their id field in ascending order (DEFAULT)
sort=-id – Sort records by their id field in descending order
sort=asset-id – Sort records by their assetId field in ascending order
sort=-asset-id – Sort records by their assetId field in descending order
sort=asset-vin – Sort records by the vin field of the asset based on their assetId field in ascending order
sort=-asset-vin – Sort records by the vin field of the asset based on their assetId field in descending order
sort=asset-name – Sort records by the name field of the asset based on their assetId field in ascending order
sort=-asset-name – Sort records by the name field of the asset based on their assetId field in descending order
sort=user-id – Sort records by their userId field in ascending order
sort=-user-id – Sort records by their userId field in descending order
sort=user-name – Sort records by the lastName, firstName and suffix fields of the user based on their userId field in ascending order
sort=-user-name – Sort records by the lastName, firstName and suffix fields of the user based on their userId field in descending order
sort=event-type – Sort records by their eventType field in ascending order
sort=-event-type – Sort records by their eventType field in descending order
sort=begin-timestamp – Sort records by their beginTimestamp field in ascending order
sort=-begin-timestamp – Sort records by their beginTimestamp field in descending order
sort=end-timestamp – Sort records by their endTimestamp field in ascending order
sort=-end-timestamp – Sort records by their endTimestamp field in descending order
QUERY STRING EXAMPLES: Get all ELD Malfunctions for the multiple authenticated users : ?user-id=1251004,1250887
Get two ELD Malfunctions for the authenticated user with an offset of 1 : ?user-id=1250887&offset=1&limit=2
Get all ELD Malfunctions of the current Account sorted by event type alphabetically: ?sort=event-type
EXAMPLE RESPONSE: 
[
  {
    "assetId": 1321545,
    "userId": 1250887,
    "eventType": "DiagMissing",
    "beginTimestamp": "2018-06-11T11:30:00.000Z",
    "driverHistoryUUID": "9cf93930-61f1-4f20-b24f-ce236ee7e319",
    "endTimestamp": null,
    "accountId": 1248280,
    "id": 7,
    "lastChangedDate": "2018-06-11T12:00:00.000Z"
  }
]

Update

API PATH: /api/v2/eldMalfunctions
METHOD: PUT
EXAMPLE REQUEST: 
[
  {
    "assetId": 1321545,
    "userId": 1250887,
    "eventType": "DiagMissing",
    "beginTimestamp": "2018-06-11T11:30:00.000Z",
    "driverHistoryUUID": "9cf93930-61f1-4f20-b24f-ce236ee7e319",
    "endTimestamp": null,
    "id": 7
  }
]
EXAMPLE RESPONSE: 
[
  {
    "assetId": 1321545,
    "userId": 1250887,
    "eventType": "DiagMissing",
    "beginTimestamp": "2018-06-11T11:30:00.000Z",
    "driverHistoryUUID": "9cf93930-61f1-4f20-b24f-ce236ee7e319",
    "endTimestamp": null,
    "accountId": 1248280,
    "id": 7,
    "lastChangedDate": "2018-06-11T12:00:00.000Z"
  }
]

Delete

API PATH: /api/v2/eldMalfunctions/<id>
METHOD: DELETE