Driver->DriverViolationsByGroup

Last updated
Save as PDF

DriverViolationsByGroup (Driver Function)

Returns the number of violations, by type, for each driver in the specified driver group for the specified time period. The time period must be no longer than one month. To check for all groups, use "- All -" (dash, space, All, space, dash---no quotes). See also DriverViolationsByGroup Request - Response Example.

XML Request

The DriverViolationsByGroup function takes four parameters.

Parameter	Type	Description
Group	String	The driver group for which you want to view violations; to check for all groups, use "- All -" (dash, space, All, space, dash---no quotes)
RuleSet	Enum	The rule set for which you want to find violations; possible values are USA, CANMain (Canada south of the 60th parallel), or CANNorth (Canada north of the 60th parallel),USACalifornia, USAFlorida, USATexas, USAAlaska
Start	dateTime	The first time for which violation data is requested, expressed as the local time at the driver's depot
End	dateTime	The last time for which violation data is requested, expressed as the local time at the driver's depot; cannot be more than one month after the Start time
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 effected fields.

  
<soap:Body>  
    <DriverViolationsByGroup xmlns="http://www.qualcomm.com">  
        <request>  
            <Group>string</Group>  
            <RuleSet>USA or CANMain or CANNorth or USACalifornia or USAFlorida or USATexas or USAAlaska</RuleSet>  
            <Start>dateTime</Start>  
            <End>dateTime</End>  
            <TimeResolutionInSeconds>boolean</TimeResolutionInSeconds>  
        </request>  
    </DriverViolationsByGroup>  
</soap:Body>

XML Response

The XML response will have a <DriverViolationsByGroupData> section for each driver in the specified group. The DriverViolationsByGroup function returns the following values:

Parameter	Type	Description
Group	String	The driver group for which these violations are reported
RuleSet	Enum	The rule set for these violations, echoed from the request
DriverCount	Integer	The number of drivers for which violations are reported
DriverId	Integer	For each driver, the specific driver ID
TimeZone	String	For each driver, the time zone of the driver's depot
RestBreakViolations	Integer	The number of violations of the rest break clock, calcualted under the specified rule set
DrivingViolations	Integer	The number of violations of the daily driving clock restrictions, calcualted under the specified rule set
OnDutyViolations	Integer	The number of violations to the daily on-duty clock restrictions, calcualted under the specified rule set
CumulativeOnDutyViolations	Integer	The number of violations to the duty-cycle clock restrictions, calcualted under the specified rule set
ShiftViolations	Integer	For CANMain and CANNorth rule sets, the number of daily shift violations for each driver; 0 for any USA rule set
DayOffViolations	Integer	For CANMain and CANNorth rule sets, the number of day-off violations for each driver; 0 for any USA rule set
PassengerRuleViolations	Integer	The number of Passenger Rule violations.
DailyOffViolations	Integer	For CANMain and CANNorth rule sets, the number of DailyOff violations
DailyOffTwoHourViolations	Integer	For CANMain and CANNorth rule sets, the number of DailyOffTwoHours violations
DeferralDrivingViolations	Integer	For CANMain and CANNorth rule sets, the number of DeferralDriving violations
TotalOffDutyForDeferralViolations	Integer	For CANMain and CANNorth rule sets, the number of TotalOffDutyForDeferral violations
DeferralDay1OffDutyViolations	Integer	For CANMain and CANNorth rule sets, the number of DeferralDay1OffDuty violations
DeferralDay2OffDutyViolations	Integer	For CANMain and CANNorth rule sets, the number of DeferralDay2OffDuty violations
**RestBreakAfterExemptionViolations	Integer	Number of rest break violations incurred immediately after deactivating rest break exemptions violations
Type	Enum	For each violation, the type of violation: Driving, OnDuty, CumulativeOnDuty, Shift, DayOff, RestBreak, PassengerRule, DailyOff, DailyOffTwoHours, DeferralDriving, DeferralTotalOffDuty, DeferralDay1OffDuty, DeferralDay2OffDuty or **RestBreakAfterExemption
Time	dateTime	For each violation, the time the violation occurred (if TimeResolutionInSeconds is false or omitted in the request, then Time will be truncated to the minute)
Duration	Integer	For each violation, the amount of time spent in violation (if TimeResolutionInSeconds is true in the request, then returned in seconds; otherwise minutes)

  
<soap:Body>  
    <DriverViolationsByGroupResponse xmlns="http://www.qualcomm.com">  
        <DriverViolationsByGroupResult>  
            <Group>string</Group>  
            <RuleSet>USA or CANMain or CANNorth or USACalifornia or USAFlorida or USATexas or USAAlaska</RuleSet>  
            <DriverCount>int</DriverCount>  
            <Violations>  
                <DriverViolationsByGroupData>  
                <DriverId>string</DriverId>  
                <TimeZone>string</TimeZone>  
                <RestBreakViolations>int</RestBreakViolations>  
                <DrivingViolations>int</DrivingViolations>  
                <OnDutyViolations>int</OnDutyViolations>  
                <CumulativeOnDutyViolations>int</CumulativeOnDutyViolations>  
                <ShiftViolations>int</ShiftViolations>  
                <DayOffViolations>int</DayOffViolations>  
                <PassengerRuleViolations>int</PassengerRuleViolations>  
                <DailyOffViolations>0</DailyOffViolations>  
                <DailyOffTwoHourViolations>0</DailyOffTwoHourViolations>  
                <DeferralDrivingViolations>0</DeferralDrivingViolations>  
                <TotalOffDutyForDeferralViolations>0</TotalOffDutyForDeferralViolations>  
                <DeferralDay1OffDutyViolations>0</DeferralDay1OffDutyViolations>  
                <DeferralDay2OffDutyViolations>0</DeferralDay2OffDutyViolations>  
                <RestBreakAfterExemptionViolations>0</RestBreakAfterExemptionViolations>  
                <Violations>  
                    <DriverViolationsData>  
                        <Type>Driving or OnDuty or CumulativeOnDuty or Shift or DayOff or RestBreak or PassengerRule or DailyOff or DailyOffTwoHours or DeferralDriving or DeferralTotalOffDuty or DeferralDay1OffDuty or DeferralDay2OffDuty or RestBreakAfterExemption</Type>  
                        <Time>dateTime</Time>  
                        <Duration>int</Duration>  
                    </DriverViolationsData>  
                    <DriverViolationsData>  
                        <Type>Driving or OnDuty or CumulativeOnDuty or Shift or DayOff or RestBreak or PassengerRule or DailyOff or DailyOffTwoHours or DeferralDriving or DeferralTotalOffDuty or DeferralDay1OffDuty or DeferralDay2OffDuty or RestBreakAfterExemption</Type>  
                        <Time>dateTime</Time>  
                        <Duration>int</Duration>  
                    </DriverViolationsData>  
                    . . .  
                    . . .  
                    . . .  
                </Violations>  
            </DriverViolationsByGroupData>  
            <DriverViolationsByGroupData>  
                <DriverId>string</DriverId>  
                <TimeZone>string</TimeZone>  
                <RestBreakViolations>int</RestBreakViolations>  
                <DrivingViolations>int</DrivingViolations>  
                <OnDutyViolations>int</OnDutyViolations>  
                <CumulativeOnDutyViolations>int</CumulativeOnDutyViolations>  
                <ShiftViolations>int</ShiftViolations>  
                <DayOffViolations>int</DayOffViolations>  
                <PassengerRuleViolations>int</PassengerRuleViolations>  
                <DailyOffViolations>0</DailyOffViolations>  
                <DailyOffTwoHourViolations>0</DailyOffTwoHourViolations>  
                <DeferralDrivingViolations>0</DeferralDrivingViolations>  
                <TotalOffDutyForDeferralViolations>0</TotalOffDutyForDeferralViolations>  
                <DeferralDay1OffDutyViolations>0</DeferralDay1OffDutyViolations>  
                <DeferralDay2OffDutyViolations>0</DeferralDay2OffDutyViolations>  
                <RestBreakAfterExemptionViolations>0</RestBreakAfterExemptionViolations>  
                <Violations>  
                    <DriverViolationsData>  
                        <Type>Driving or OnDuty or CumulativeOnDuty or Shift or DayOff or RestBreak or PassengerRule or DailyOff or DailyOffTwoHours or DeferralDriving or DeferralTotalOffDuty or DeferralDay1OffDuty or DeferralDay2OffDuty or RestBreakAfterExemption</Type>  
                        <Time>dateTime</Time>  
                        <Duration>int</Duration>  
                    </DriverViolationsData>  
                    <DriverViolationsData>  
                        <Type>Driving or OnDuty or CumulativeOnDuty or Shift or DayOff or RestBreak or PassengerRule or DailyOff or DailyOffTwoHours or DeferralDriving or DeferralTotalOffDuty or DeferralDay1OffDuty or DeferralDay2OffDuty or RestBreakAfterExemption</Type>  
                        <Time>dateTime</Time>  
                        <Duration>int</Duration>  
                    </DriverViolationsData>  
                    . . .  
                    . . .  
                    . . .  
                </Violations>  
            </DriverViolationsByGroupData>  
        </Violations>  
        . . .  
        . . .  
        . . .  
    </DriverViolationsByGroupResult>  
  </DriverViolationsByGroupResponse>  
 </soap:Body>

DriverViolationsByGroup Request/Response Example