Driver->LogEvents

Last updated
Save as PDF

LogEvents (Driver Function)

This function returns a list of events that affect driver logs, such as log approval/unapproval, load changes, codriver changes, note changes, US cycle reset rejected, US cycle reset removed, US cycle reset added, and driver becomes active.

A maximum of 1000 records will be returned each call starting from the provided EventId. Provide the Start date and time (yyyy-mm-ddThh:mm:ss) only for the first call or omit it for the start of the current day. Set EventId = 0 to retrieve from the first record of the day. Afterwards, use only the NextEventId returned in the previous call as Start will be ignored.

When no more records are available, NextEventId will point to the next future event log entry. If no records are returned at all, NextEventId will contain the value of the EventId input parameter used in the call, which can be reused in the next call. All times are in GMT.

XML Request

The LogEvents function takes two parameters.

Parameter	Type	Description
EventId	Long	The event id from where you want to see the subsequent logs. For the first call, set EventId to 0 telling the function to use the Start point for retrieving records
Start	DateTime	The time from where you want to see the events from. Only required for the first call. Afterwards, this parameter is not needed. On the initial call, if the parameter is not provided, the function will default to the current day.
TimeResolutionInSeconds	Boolean	This parameter specifies whether certain values in the response are returned in seconds or minutes. If true, values are returned in seconds; otherwise in minutes. This parameter is optional. If the parameter is omitted, then values in the response are returned in minutes. See the response description for the affected fields.

Note:

LogEvents returns the USA Rules 34 Hr Resets Added/Removed regardless of the ruleset the Driver is currently operating under, so Driver's under Intrastate or Canadian rules will still show USA Rules 34 Hr Resets Added/Removed in LogEvents WebService calls. 34-hour resets under intra-state and/or Canadian rules will not be returned by this method.

XML Response

If more than one event is found for the provided event id, the XML response will have <DriverLogEvent> for each event. The Log Events response will contain the below elements.

Parameter	Type	Description
DriverId	String	The driver's ID
EventType	Enum	UNINIT or UNAPPROVED or APPROVED or LOAD_CHANGED or CODRIVER_CHANGED or NOTES_CHANGED or US_CYCLE_RESET_REJECTED or US_CYCLE_RESET_REMOVED or US_CYCLE_RESET_ADDED - See the table below
EventTimestamp	DateTime	The time that the event that changed the log was processed (if TimeResolutionInSeconds is false or omitted in the request, then EventTimestamp will be truncated to the minute).
LogTimestamp	DateTime	See the table below. If TimeResolutionInSeconds is false or omitted in the request, then LogTimestamp will be truncated to the minute.
NextEventId	Long	This value is useful for the next iterative call to this function. It is used by the web service function to know where the last call left off and where the next record can be found. The value itself is not meaningful beyond the web service call. If no records are left to be returned, an EventId representing the next future log entry is returned here. Or, if no data is returned at all, the same input LogId will be returned in NextLogId for use with the next call. That same value can be used in the next call. A zero or negative

EventType	Description	Meaning of LogTimeStamp
UNINIT	Unused
APPROVED	Indicates that a driver has approved his logs.	The start time of the last duty status that was approved. This duty status and all previous ones for this driver are approved.
UNAPPROVED	Indicates that a driver's logs have been unapproved as a result of an operation such as an edit.	The start time of the first duty status that is not approved. This duty status and all subsequent duty statuses for this driver are not approved.
LOAD_CHANGED	Indicates that a load has been edited on a particular day.	The date of the log timestamp indicates the date that loads were changed. The hours and minutes portion of the log timestamp is not significant.
CODRIVER_CHANGED	Indicates that there was a change in codriver for a duty status.	The start time of the duty status that had the codriver change.
NOTES_CHANGED	Indicates that a host user changed only the notes for a particular duty status and did not change any other fields. No such events will appear with a date that is after HOS release 3.9, since these are now considered regular edits.	The start time of the duty status that had the notes changed.
US_CYCLE_RESET_*	The following 3 types are specific to the new FMCSA 34 hour reset rules. They may appear even if the driver's rule set does not follow these rules
US_CYCLE_RESET_REJECTED	Indicates that a US Cycle reset was rejected by the driver	The end time of the reset that was rejected.
US_CYCLE_RESET_REMOVED	Indicates that a US Cycle reset was removed	The end time of the reset that was removed.
US_CYCLE_RESET_ADDED	Indicates that a US Cycle reset was earned by the driver or added by some type of editing operation (either directly or indirectly)	The end time of the reset that was added.
DRIVER_ACTIVE	An authenticated driver Logs in as active or manually changes to active. There is no notification when a driver becomes inactive	Event time

  
<soap:Body>  
    <LogEventsResponse xmlns="http://www.qualcomm.com">  
      <LogEventsResult>  
        <Events>  
          <DriverLogEvent>  
            <DriverId>string</DriverId>  
            <EventType>UNINIT or UNAPPROVED or APPROVED or LOAD_CHANGED or CODRIVER_CHANGED or NOTES_CHANGED  
                       or US_CYCLE_RESET_REJECTED or US_CYCLE_RESET_REMOVED or US_CYCLE_RESET_ADDED or DRIVER_ACTIVE</EventType>  
            <EventTimestamp>dateTime</EventTimestamp>  
            <LogTimestamp>dateTime</LogTimestamp>  
          </DriverLogEvent>  
          <DriverLogEvent>  
            <DriverId>string</DriverId>  
            <EventType>UNINIT or UNAPPROVED or APPROVED or LOAD_CHANGED or CODRIVER_CHANGED or NOTES_CHANGED  
                       or US_CYCLE_RESET_REJECTED or US_CYCLE_RESET_REMOVED or US_CYCLE_RESET_ADDED or DRIVER_ACTIVE</EventType>  
            <EventTimestamp>dateTime</EventTimestamp>  
            <LogTimestamp>dateTime</LogTimestamp>  
          </DriverLogEvent>  
        </Events>  
        <NextEventId>long</NextEventId>  
      </LogEventsResult>  
    </LogEventsResponse>  
  </soap:Body>