Driver->GetRestBreakExemptionUsage

Last updated
Save as PDF

GetRestBreakExemptionUsage (Driver Function)

The GetRestBreakExemptionUsage method returns rest break exemption usage that falls within the requested date range for the specified drivers. If the start time of the rest break exemption falls outside the requested date range, the corresponding RBE start and end times will not be returned. The dates are expected to be in the driver's depot timezone.

Note: If a driverID is invalid or if a Driver has no rest break exemption usage for the time range specified, that Driver's <DriverRbeRecord> tag is not present in the response.

XML Request

The GetRestBreakExemptionUsage function takes the following input parameters:

Parameter	Type	Optional	Description
Drivers	String	No	An array of driverIDs to be exported. Max 1000 drivers in the list are supported
Start	dateTime	No	Start time of any exception usage data to be returned, specified in WS user local time zone
End	dateTime	No	Last (end) time of any exception usage data to be returned, specified in WS user local time zone

  
<soap:Body>  
   <GetRestBreakExemptionUsageRequest xmlns="http://www.omnitracs.com">  
      <Drivers>  
         <DriverId>string</DriverId>  
         <DriverId>string</DriverId>  
      </Drivers>  
      <Start>dateTime</Start>  
      <End>dateTime</End>  
   </GetRestBreakExemptionUsageRequest>  
</soap:Body>

XML Response

The GetRestBreakExemptionUsage function response includes the following parameters:

Parameter	Type	Description
DriverRbeList	Array	A list of DriverRbeRecords, one per driver.
DriverRbeRecord	Object	Contains <DriverId> and <RbeUsagePeriodList> listing RBE usage periods
DriverId	String	Driver ID of the corresponding driver
RbeUsagePeriodList	Array	An array of <RbeUsagePeriod> elements
RbeUsagePeriod	Element	Contains a <RbeUsageStartTime> and a <RbeUsageEndTime>
RbeUsageStartTime	dateTime	The time when the rest break exemption usage started. If the RBE start time occurred before the period of query, then the xsi:nil="true" attribute appears in the tag instead of actual dateTime. The time is truncated to the minute.
RbeUsageEndTime	dateTime	The time when the rest break exemption usage ended. If the RBE end time occurred after the period of query, then the xsi:nil="true" attribute appears in the tag instead of actual dateTime. The time is truncated to the minute.

  
<soap:Body>  
   <GetRestBreakExemptionUsageResponse xmlns="http://www.omnitracs.com">  
      <DriverRbeList>  
         <DriverRbeRecord>  
            <DriverId>string</DriverId>  
            <RbeUsagePeriodList>  
               <RbeUsagePeriod>  
                  <RbeUsageStartTime>dateTime</RbeUsageStartTime>  
                  <RbeUsageEndTime>dateTime</RbeUsageEndTime>  
               </RbeUsagePeriod>  
               <RbeUsagePeriod>  
                  <RbeUsageStartTime>dateTime</RbeUsageStartTime>  
                  <RbeUsageEndTime xsi:nil="true"/>  
               </RbeUsagePeriod>  
            </RbeUsagePeriodList>  
          </DriverRbeRecord>  
      </DriverRbeList>  
   </GetRestBreakExemptionUsageResponse>  
</soap:Body>