ELD Return Events

ELD Return Events List

There are 2 ELD Return Events intended to cover updates to drivers' HOS violation status. These are triggered by a violation being created and a violation being invalidated (e.g. through an admin edit to a log). Fleets utilizing Maven ELD can subscribe to these events to receive updates from Maven on violation status.

violationCreated
violationInvalidated

Standard Data Objects

The format for the data section of various eventType values for return events is standardized based on the underlying data object that is being reported on. For instance, return events that report on manifest data will all share the same basic manifest attributes. In this manner, return events that share a similar base level data type can be parsed in identical fashion, for ease of integration. The various standard data object classifications, and the data they contain, are described below.

Violation Data

Attribute Name	Type	Description
eventTime	string UTC time ISO 8601	Datetime that violation event occured
id	string	Unique identifier for the specific violation event
terminalCode	string	Identifier for terminal associated with driver
logDate	string	Log date associated to event
driverName	string	Display name of driver associated to event
driverId	string	Identifier of driver associated to event
ruleset	string	Ruleset assigned to driver
powerUnitNumber	string	Vehicle number associated with driver
type	string	HOS regulation associated to event
shortDescription	string	HOS regulation associated to event
longDescription	string	HOS regulation associated to event
startTime	string UTC time ISO 8601	Datetime of beginning of violation event
endTime	string UTC time ISO 8601	Datetime of end of violation event
duration	string HH:MM	Duration of violation event
startData	array	Vehicle data associated with the startTime of event
endData	array	Vehicle data associated with the endTime of event
odometer	number	Odometer value associated to event
latitude	number	Recorded latitude associated with event
longitude	number	Recorded longitude associated with event
streetNumber	string	Recorded street number associated with event
street	string	Recorded street name associated with event
city	string	Recorded city associated with event
state	string	Recorded state abbreviation associated with event
country	string	Recorded country associated with event
postalCode	string	Recorded postal code associated with event
formattedAddress	string	Formatted full address associated with event
eldLocation	array	ELD formatted location data
city	string	Recorded nearest city associated with event
country	string	Recorded country associated with event
direction	string	Recorded approximate direction from nearest city
distance	number	Recorded approximate distance from nearest city
formattedLocation	string	Formatted ELD approximate location
jurisdiction	string	Recorded state abbreviation of nearest city associated with event
postalCode	string	Recorded postal code of nearest city associated with event
units	string	Units associated to distance

Return Event Types

violationCreated

Description

A violationCreated is produced when a HOS violation is logged in the Maven ELD system.

Triggers

For a driver operating on Maven ELD, a driver in a Drive duty status with any expired timers will log a violation. Upon changing of duty status from Drive to any other duty status, a violationCreated event will be produced.

Documentation

The id field will be unique to each violation created and should be used to reference invalidated violations.
The primary purpose of the violationCreated event is to communicate violations incurred by drivers using Maven.

Example

{
  eventTime: "2024-01-01T00:00:00Z",
  eventType: "violationCreated",
  id: "4095c1ff-915d-4744-a9d6-95a1cddcac43",
  terminalCode: "PGH",
  logDate: "2024-01-01",
  driverName: "Doe, John",
  driverId: "JDOE123"
  ruleset: "USA_PROPERTY_70_8",
  powerUnitNumber: "Truck 12345",
  type: "shift_drive",
  shortDescription: "Drive",
  longDescription: "11 Hr Drive",
  startTime: "2024-01-01T00:00:00Z",
  endTime: "2024-01-01T00:00:00Z",
  duration: "3:30",
  startData: {
    odometer: 12345.6,
    latitude: 40.46338,
    longitude: -79.95474,
    streetNumber: "4117",
    street: "Liberty Ave",
    city: "Pittsburgh",
    state: "PA",
    country: "US",
    postalCode: "15224",
    formattedAddress: "4117 Liberty Ave, Pittsburgh, PA 15224",
    eldLocation: {
      city: "Pittsburgh",
      country: "USA",
      direction: "SSE",
      distance: 3.21,
      formattedLocation: "3.21 mi SSE PA Pittsburgh, USA",
      jurisdiction: "PA",
      postalCode: "15224",
      units: "mi"
    }
  },
  endData: {
    odometer: 12345.6,
    latitude: 40.46338,
    longitude: -79.95474,
    streetNumber: "4117",
    street: "Liberty Ave",
    city: "Pittsburgh",
    state: "PA",
    country: "US",
    postalCode: "15224",
    formattedAddress: "4117 Liberty Ave, Pittsburgh, PA 15224",
    eldLocation: {
      city: "Pittsburgh",
      country: "USA",
      direction: "SSE",
      distance: 3.21,
      formattedLocation: "3.21 mi SSE PA Pittsburgh, USA",
      jurisdiction: "PA",
      postalCode: "15224",
      units: "mi"
    }
  }
}

violationInvalidated

Description

A violationInvalidated is produced when a HOS violation is removed due to a change to the driver's logs such as an admin edit, exception, etc.

Triggers

For an existing violation, any changes to the driver's log that results in the removal of the violation with produce a violationInvalidated event.

Documentation

The id field will match the id from the violationCreated event.
The body of the event will contain the same details from violationCreated event.
The primary purpose of the violationInvalidated event is to communicate violations that have been removed by changes to driver logs.

Example

{
  eventTime: "2024-01-01T00:00:00Z",
  eventType: "violationInvalidated",
  id: "4095c1ff-915d-4744-a9d6-95a1cddcac43",
  terminalCode: "PGH",
  logDate: "2024-01-01",
  driverName: "Doe, John",
  driverId: "JDOE123"
  ruleset: "USA_PROPERTY_70_8",
  powerUnitNumber: "Truck 12345",
  type: "shift_drive",
  shortDescription: "Drive",
  longDescription: "11 Hr Drive",
  startTime: "2024-01-01T00:00:00Z",
  endTime: "2024-01-01T00:00:00Z",
  duration: "3:30",
  startData: {
    odometer: 12345.6,
    latitude: 40.46338,
    longitude: -79.95474,
    streetNumber: "4117",
    street: "Liberty Ave",
    city: "Pittsburgh",
    state: "PA",
    country: "US",
    postalCode: "15224",
    formattedAddress: "4117 Liberty Ave, Pittsburgh, PA 15224",
    eldLocation: {
      city: "Pittsburgh",
      country: "USA",
      direction: "SSE",
      distance: 3.21,
      formattedLocation: "3.21 mi SSE PA Pittsburgh, USA",
      jurisdiction: "PA",
      postalCode: "15224",
      units: "mi"
    }
  },
  endData: {
    odometer: 12345.6,
    latitude: 40.46338,
    longitude: -79.95474,
    streetNumber: "4117",
    street: "Liberty Ave",
    city: "Pittsburgh",
    state: "PA",
    country: "US",
    postalCode: "15224",
    formattedAddress: "4117 Liberty Ave, Pittsburgh, PA 15224",
    eldLocation: {
      city: "Pittsburgh",
      country: "USA",
      direction: "SSE",
      distance: 3.21,
      formattedLocation: "3.21 mi SSE PA Pittsburgh, USA",
      jurisdiction: "PA",
      postalCode: "15224",
      units: "mi"
    }
  }
}