Skip to main content
Omnitracs Knowledge Base

Driver->ExportDriverLog

ExportDriverLog (Driver Function)

This function returns driver logs for the time period provided.

XML Request

The ExportDriverLog function takes the following input parameters:

Parameter Type Description
DriverId String The Driver's ID
StartTime dateTime The first time for which log data is requested, expressed as the local time at the driver's depot
EndTime dateTime The last time for which log data is requested, expressed as the local time at the driver's depot
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. The ELD duty status values Personal Conveyance and Yard Move are also returned if this parameter is true; otherwise, they are returned as Off Duty and On Duty, respectively. 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.

 

XML Response

If more than one driver log is available, the XML file will have a <DriverLogExportData> section for each record. The ExportDriverLog function returns the following values:

Parameter Type Description
DriverId String The driver's ID
CoDriverId String The co-driver's ID
StartTime dateTime Time activity started, (expressed as the local time at the driver's depot) (if TimeResolutionInSeconds is false or omitted in the request, then StartTime will be truncated to the minute)
Activity Integer Driver's duty status for this log entry: 1=Off Duty, 2=Sleeper Berth, 3=Driving, 4=On Duty, Not Driving, 5=Off Duty Driving (optional status), 6=Personal Conveyance, 7=Yard Move
WaitingInOilWell Boolean Indicates whether driver was waiting in oil well during this duty status.
HazmatOnDutyRest Boolean Indicates whether driver marked the duty status with Hazmat load carrying flag.
Duration Integer Length of the specified activity (if TimeResolutionInSeconds is true in the request, then returned in seconds; otherwise minutes)
Location String Distance, bearing, and point of interest information for the current activity
Document String Listing of any documents, such as bills of lading or other shipper documents, that were added in the load description; multiple documents are comma-separated
TractorId String The tractor currently assigned to the driver
TrailerId String The trailer currently assigned to the driver
Confirmed Boolean Indicates whether driver has confirmed that the log entry is accurate
Edit Character Indicates whether the activity records has been modified, either by the driver or a host operator; 85=U=unedited, 67=C=original corrected, 69=E=edited
SensorFailure Boolean Indicates whether any sensor failures were recorded during the activity (some sensor failures may make the activity record inaccurate)
TimeZone String The time zone of the driver's current depot
Remark 1 string Driver remark 1 for the activity
Remark 2 string Driver remark 2 for the activity
EditReason string Reason given when the activity was edited

 

XML Response

The return result indicates success or failure via SOAP exceptions.

  
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">  
  <soap:Body>  
    <ExportDriverLogResponse xmlns="http://www.qualcomm.com">  
        <ExportDriverLogResult>  
            <DriverExport>  
                <DriverLogExportData>  
                    <DriverId>string</DriverId>  
                    <CoDriverId>string</CoDriverId>  
                    <StartTime>dateTime</StartTime>  
                    <Activity>int</Activity>  
                    <WaitingInOilWell>boolean</WaitingInOilWell>  
                    <HazmatOnDutyRest>boolean</HazmatOnDutyRest>  
                    <Duration>int</Duration>  
                    <Location>string</Location>  
                    <Document>string</Document>  
                    <TractorId>string</TractorId>  
                    <TrailerId>string</TrailerId>  
                    <Confirmed>boolean</Confirmed>  
                    <Edit>char</Edit>  
                    <SensorFailure>boolean</SensorFailure>  
                    <TimeZone>string</TimeZone>  
                    <Remark1>string</Remark1>  
                    <Remark2>string</Remark2>  
                    <EditReason>string</EditReason>  
                </DriverLogExportData>  
                <DriverLogExportData>  
                    <DriverId>string</DriverId>  
                    <CoDriverId>string</CoDriverId>  
                    <StartTime>dateTime</StartTime>  
                    <Activity>int</Activity>  
                    <WaitingInOilWell>boolean</WaitingInOilWell>  
                    <HazmatOnDutyRest>boolean</HazmatOnDutyRest>  
                    <Duration>int</Duration>  
                    <Location>string</Location>  
                    <Document>string</Document>  
                    <TractorId>string</TractorId>  
                    <TrailerId>string</TrailerId>  
                    <Confirmed>boolean</Confirmed>  
                    <Edit>char</Edit>  
                    <SensorFailure>boolean</SensorFailure>  
                    <TimeZone>string</TimeZone>  
                </DriverLogExportData>  
                . . .  
                . . .  
                . . .  
            </DriverExport>  
        </ExportDriverLogResult>  
    </ExportDriverLogResponse>  
  </soap:Body>  
</soap:Envelope>  
  • Was this article helpful?