Driver
Hours of Service (HOS) web service for Driver data.
The following operations are supported. For a formal definition, please review the Service Description.
-
Add
Adds the Driver data provided to the HOS database. -
AddEx
Adds the Driver data provided to the HOS database. In addition to all the parameters accepted by the Add function this takes the extra paramter InOffDutyDrvPolicy which is a enum with values Allowed or NotAllowed and adds it to the HOS database. -
AddWithCarrierName
Adds the Driver data provided to the HOS database. In addition to all the parameters accepted by the AddEx function this takes the extra paramter CarrierName which is a string and has name of the carrier to which the driver being added should belong to. The Carrier should already exist in the QHOS database for this call to complete successfully. -
CanadaDriverLogReport
Returns the Drivers Log data for Canada drivers given the following as the input Driver ID, Start Date, End Date and the Ruleset(CANMain, CANNorth) to apply. -
CanadaDriverLogReport2
Returns the Drivers Log data for Canada drivers given the following as the input Driver ID, Start Date, End Date and the Ruleset(CANMain, CANNorth) to apply. -
ClockInOut
This web service allows customers to clock a driver in or out. -
CreateDriverGroup
Creates a driver group and assigns it to a depot if a depot name has been specified. The specified depot should have already been created or else this call will fail. For documentation refer Wiki -
DriverLogQueue
Returns driver log records for specified driver depot. A maximum of 1,000 records will be returned each call. Provide Start date and time (yyyy-mm-ddThh:mm:ss) only for the first call or omit on first call for the start of the current day (depot's Start of Day) and set LogId=0 to retrieve from the first record of the day. Afterwards, use only the NextLogId returned in the previous call as Start will be ignored. When no more records are available, NextLogId will point to the next future duty log entry. If no records are returned at all, NextLogId will contain the value of the LogId input parameter used in the call which can therefore be re-used in the next call. Providing an End date and time is optional. All times are in GMT. Odometers and DistanceDriven are in tenths of miles. -
DriverLogQueueByGroup
Returns driver log records for specified driver group. A maximum of 1,000 records will be returned each call. Provide Start date and time (yyyy-mm-ddThh:mm:ss) only for the first call or omit on first call for the start of the current day (midnight Eastern time zone) and set LogId=0 to retrieve from the first record of the day. Afterwards, use only the NextLogId returned in the previous call as Start will be ignored. When no more records are available, NextLogId will point to the next future duty log entry. If no records are returned at all, NextLogId will contain the value of the LogId input parameter used in the call which can therefore be re-used in the next call. Providing an End date and time is optional. To retrieve records for all drivers, use the group, '- All -' (dash, space, All, space, dash with no quotes). All times are in GMT. Odometers and DistanceDriven are in tenths of miles. -
DriverLogQueueByGroupEx
Returns driver log records for specified driver group. A maximum of 1,000 records will be returned each call. Provide Start date and time (yyyy-mm-ddThh:mm:ss) only for the first call or omit on first call for the start of the current day (midnight Eastern time zone) and set LogId=0 to retrieve from the first record of the day. Afterwards, use only the NextLogId returned in the previous call as Start will be ignored. When no more records are available, NextLogId will point to the next future duty log entry. If no records are returned at all, NextLogId will contain the value of the LogId input parameter used in the call which can therefore be re-used in the next call. Providing an End date and time is optional. To retrieve records for all drivers, use the group, '- All -' (dash, space, All, space, dash with no quotes). All times are in GMT if LocalTime parameter is set to false. Otherwise the Start and End times are assumed to be in Eastern time zone. The StartTime of each record is in its depot local time for the assigned driver if the LocalTime parameter is set to true. Since records may be in many different time zones, the specific time zone is returned for each record. Odometers and DistanceDriven are in tenths of miles. When a record indicates it is marked as a Correction to a previous record, the OriginalLogId field contains the LogId of the original record to facilitate the matching of Corrections to Originals. If the record is marked as Original, then the OriginalLogId field will point to the LogId of the new, corrected record. If an edit is undone, a new LogId will be assigned to the original record while the correction will be deleted. -
DriverLogQueueEx
Returns driver log records for specified driver depot. A maximum of 1,000 records will be returned each call. Provide Start date and time (yyyy-mm-ddThh:mm:ss) only for the first call or omit on first call for the start of the current day (depot's Start of Day) and set LogId=0 to retrieve from the first record of the day. Afterwards, use only the NextLogId returned in the previous call as Start will be ignored. When no more records are available, NextLogId will point to the next future duty log entry. If no records are returned at all, NextLogId will contain the value of the LogId input parameter used in the call which can therefore be re-used in the next call. Providing an End date and time is optional. All times are in GMT if LocalTime parameter is set to false. Otherwise all times are assumed to be depot local time. Odometers and DistanceDriven are in tenths of miles. When a record indicates it is marked as a Correction to a previous record, the OriginalLogId field contains the LogId of the original record to facilitate the matching of Corrections to Originals. If the record is marked as Original, then the OriginalLogId field will point to the LogId of the new, corrected record. If an edit is undone, a new LogId will be assigned to the original record while the correction will be deleted. -
DriverOdometers
Returns beginning and ending odometers in tenths of miles for all drivers associated with the depot for the day specified (only logged-in time), excluding off-duty driving. Times returned are in depot-local time. Includes only tractors with MCP units. -
DriverViolations
Returns violations for driver for the time period indicated. Time period must be no longer than one month. -
DriverViolationsByGroup
Returns violations for specified driver group for the time period indicated. Time period must be no longer than one month. To check for all groups, use '- All -' (dash, space, All, space, dash - no quotes). -
ExportDriver
Return one or more driver data based a HOS rule set. -
ExportDriverByDepotId
Returns one or more Export Driver data objects based on the DepotID provided and greater than the value provided in driverId. -
ExportDriverClock
Return one or more driver clock data based a HOS rule set. This method returns reduced amount of data as compared to the 'ExportDriver' method and does not require RuleSet parameter. This method uses Driver's current rule set. -
ExportDriverClockByDepotId
Returns one or more Export Driver Clock data objects based on the DepotID provided and greater than the value provided in driverId. This method returns reduced amount of data as compared to the 'ExportDriverByDepotId' method and does not require RuleSet parameter. This method uses Driver's current rule set. -
ExportDriverLog
Returns Driver logs for the time period provided. -
Get
Returns a driver object with driver properties for the specified driver ID. -
GetDataRanges
Returns a list of driver IDs and the first and last status change for each driver. At most 1000 drivers at a time will be returned. On the first call, omit or pass an empty string as the driver ID. On subsequent calls, pass the last driver ID returned from the previous call so that the next 1000 drivers are returned. Continue this until no drivers are returned. Drivers are always returned in alphabetical order based on the driver ID. The FirstStatusChange for a driver is the earliest status change as of the time of the call. The LastStatusChange for a driver is the last status change as of the time of the call. This will be the start time of his current duty status. -
GetDrivers
Returns the driver IDs of the drivers in the company. -
GetDriversInDepot
Returns the driver IDs of the drivers in the specified depot. -
GetDriversInGroup
Returns the driver IDs of the drivers in the specified group. -
GetLogExceptions
The GetLogExceptions method returns the 16-hour exception requests and grants that fall within the requested date range. The requests and grants are tied to a specific duty status change, and hence the time of the request/grant is the start time of the corresponding duty status. Therefore, if the start time of the duty status falls outside the requested date range (e.g. the request was before midnight but the grant was after midnight), the corresponding request/grant will not be returned. The dates are expected to be in driver's depot timezone. -
GetLogExceptionsByDepot
The GetLogExceptionsByDepot method returns the 16-hour exception requests and grants for all drivers in the given Depot that fall within the requested date range. Like above, the requests and grants are tied to a specific duty status change, and hence the time of the request/grant is the start time of the corresponding duty status. Therefore, if the start time of the duty status falls outside the requested date range (e.g. the request was before midnight but the grant was after midnight), the corresponding request/grant will not be returned. The dates are expected to be in driver's depot timezone. -
GetRestBreakExemptionUsage
Get rest break exemption usage for driver by Driver ID in Hours of Service. -
GetRestBreakExemptionUsageByDepot
Get rest break exemption usage for driver by Depot ID in Hours of Service. -
GetRollOffTime
Gets the rolloff time for all the driver's in a company upto a maximum of 1000 drivers. -
GetRollOffTimeByDepotId
Gets the rolloff time for today and tomorrow of all the driver's belonging to the depot Id provided. -
GetViolationEvents
Returns the Warning and Violation events for all the drivers of the company upto a maximum of 1000.For the first invocation set Event Id to 0 and specify a start time. For subsequent invocations pass in the Event Id that was provided asin the result of previous invocation of this web service. -
LogEvents
Return driver duty log approval/unapproval events. -
RemoveFromVehicle
Remove a driver from any vehicle in Hours of Service. -
USDriverLogReport
Returns the Drivers Log data for US drivers given the following as the input Driver ID, Start Date, End Date and the Ruleset(USA,CA,FL,TX,AK) to apply. -
USDriverLogReport2
Returns the Drivers Log data for US drivers given the following as the input Driver ID, Start Date, End Date and the Ruleset(USA,CA,FL,TX,AK) to apply. -
Update
Updates one Driver data provided in the HOS database. Client is not allowed to change card ID or NMC Account #. -
UpdateCarrier
Updates the Carrier Name of a driver to the newly specified Carrier Name. The new Carrier Name should exist in the database or else this call fails and throws an exception -
UpdateDriver
Update Driver data. Client is not allowed to change card ID or NMC Account #. If driver data was already stored, use stored values for omitted fields.
Valid values forDefaultRuleSet
,USDefaultDutyCycle
, andCANDefaultDutyCycle
enumerator fields are listed inUpdate
method.
Return valuetrue
indicates that the data was persisted successfully. SOAP Fault indicates failure to update. -
UpdateDriverEx
Updates the Driver data provided to the HOS database. Any field that is not specified in the Request will not be changed. -
UpdateDriverGroup
Updates a existing driver group. Both group name and the depot that it has been assigned to can be changed. If the depot assigned is being changed then the new depot must be created first. For documentation refer Wiki -
UpdateEx
Updates the Driver data provided to the HOS database. In addition to all the parameters acceptedby the Update function this takes the extra paramter InOffDutyDrvPolicy which is a enum with values Allowed or NotAllowed and Updates for that driver in HOS database. Client is not allowed to change card ID or NMC Account #. -
VerifyAccess
Provided as a convenience to determine if the call has access to the web service.