Driver->GetRestBreakExemptionUsageByDepot

Last updated
Save as PDF

GetRestBreakExemptionUsageByDepot (Driver Function)

The GetRestBreakExemptionByDepot 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 information will not be returned. The dates are expected to be in 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 it not present in the response.

XML Request

The GetRestBreakExemptionUsageByDepot function takes the following input parameters:

Parameter	Type	Optional	Description
LastDriverID	String	Yes	The driver ID for the last driver received. The response list will start with the first driver after this driver. If absent, the list starts with the first driver.
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
DepotID	short	No	The ID of the depot for which driver RBE information is being requested

  
<soap:Body>  
   <GetRestBreakExemptionUsageByDepotRequest xmlns="http://www.omnitracs.com">  
      <LastDriverID>string</LastDriverID>  
      <Start>dateTime</Start>  
      <End>dateTime</End>  
      <DepotID>short</DepotID>  
   </GetRestBreakExemptionUsageByDepotRequest>  
</soap:Body>

XML Response

The GetRestBreakExemptionUsageByDepot function response includes the following parameters:

Parameter	Type	Description
DepotID	short	The ID of the depot for which driver RBE information was requested and is being returned
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>  
   <GetRestBreakExemptionUsageByDepotResponse xmlns="http://www.omnitracs.com">  
      <DepotID>short</DepotID>  
      <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>  
   </GetRestBreakExemptionUsageByDepotResponse>  
</soap:Body>