Driver->GetLogExceptionsByDepot

Last updated
Save as PDF

GetLogExceptionsByDepot (Driver Function)

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 GetLogExceptions, 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.

Note: If a driverID is invalid or if a Driver has no excpetions for the time range specified, that Driver's LogExceptions tag it not present in the response

XML Request

The GetLogExceptions function takes the following input parameters:

Parameter	Type	Optional	Description
DepotId	Int	No	The WS will return the exception usage data for all the drivers in this depot
Start	dateTime	No	Start time of any exception usage data to be returned, in GMT
End	dateTime	No	Last (end) time of any exception usage data to be returned, in GMT
LastDriverId	String	Yes	Used for successive requests, when the previous response was not able to return the entire data set. You can pass in the last driver ID returned. The response will start with the next driver (alphabetically)
TimeResolutionInSeconds	Boolean	Yes	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>  
    <GetLogExceptionsByDepot xmlns="http://www.qualcomm.com">  
      <request>  
        <LastDriverID>string</LastDriverID>  
        <Start>dateTime</Start>  
        <End>dateTime</End>  
        <DepotId>int</DepotId>  
        <TimeResolutionInSeconds>boolean</TimeResolutionInSeconds>  
      </request>  
    </GetLogExceptionsByDepot>  
  </soap:Body>

XML Response

The GetLogExceptions function response includes the following parameters:

Parameter	Type	Description
DepotId	Int	Echoed from te request
LogExceptionsList	Array	Contains list of <LogExceptions> elements, one per driver in the response. Up to 1000 drivers returned per call.

All other tags are identical to the ones in the GetLogExceptions web service.

  
  <soap:Body>  
    <GetLogExceptionsByDepotResponse xmlns="http://www.qualcomm.com">  
      <GetLogExceptionsByDepotResult>  
        <DepotId>int</DepotId>  
        <LogExceptionsList>  
          <LogExceptions>  
            <DriverId>string</DriverId>  
             <ExceptionDataList>  
              <ExceptionData>  
                <ExceptionType>REQUEST_16_HR or GRANT_16_HR or REQUEST_GRANT_16_HR or GRANT_16_HR or REQUEST_GRANT_16_HR or UNKNOWN</ExceptionType>  
                <ExceptionTime>dateTime</ExceptionTime>  
              </ExceptionData>  
          </LogExceptions>  
          <LogExceptions>  
            <DriverId>string</DriverId>  
            <ExceptionDataList>  
              <ExceptionData>  
                <ExceptionType>REQUEST_16_HR or GRANT_16_HR or REQUEST_GRANT_16_HR or GRANT_16_HR or REQUEST_GRANT_16_HR or UNKNOWN</ExceptionType>  
                <ExceptionTime>dateTime</ExceptionTime>  
              </ExceptionData>  
          </LogExceptions>  
        </LogExceptionsList>  
      </GetLogExceptionsByDepotResult>  
    </GetLogExceptionsByDepotResponse>  
  </soap:Body>