| [in] usn | The user-name that you need to use to authenticate on this interface. |
| [in] pwd | The password that you need to use to authenticate on this interface. |
| [in] columns | String array of the requested columns. For the full list of supported columns please refer to the Database API Documentation. If a non-existing column is requested then that column will appear in the returned XML and every entry in that column will be an empty string. |
| [in] options | String parameter. This is currently unused and reserved for future versions of the API. Pass in an empty string. |
| [in] startOfWeeklyCycleUTC | This is the UTC time for the start of the weekly cycle. |
| [in] generationNumber | The last maximum generation number received from previous call to this method. |
| [out] generationNumberForNextCall | This will return the generation number to be used in the next call. |
| [out] errorMsg | If an error happpens this string contains the error message. In case an error has happened (this variable contains a valid non-empty string) then the return value will not contain any usable data, do not try to parse it as an xml. |
| return value |
If the errorMsg variable is null or empty then the returned string contains the
requested data in xml format. The xml has the following structure:
<?xml version="1.0" encoding="utf-16"?>
Please note this.
<root> <EX_HoS_GetDriversWithUpdatedDutyLogsSummary> <row DriverID="25" DriverName="Ed Taylor" GenerationNumber="1429" EarliestDutyChangedStartTime="2013-05-02 05:00:00Z" LatestDutyChangedStartTime="2013-05-09 05:00:00Z" TotalChanges="8" /> <row DriverID="42" DriverName="Rick Mikkelson" GenerationNumber="1429" EarliestDutyChangedStartTime="2013-05-02 05:00:00Z" LatestDutyChangedStartTime="2013-05-09 05:00:00Z" TotalChanges="8" /> <row DriverID="48" DriverName="Jacob Bemis" GenerationNumber="1429" EarliestDutyChangedStartTime="2013-05-02 05:00:00Z" LatestDutyChangedStartTime="2013-05-09 05:00:00Z" TotalChanges="8" /> </EX_HoS_GetDriversWithUpdatedDutyLogsSummary> </root> |
This method will be used by the client to check for changes to the drivers duty logs for logs that are within the current cycle. It is expected that the client will call this method periodically, e.g. every 20 minutes.
The Hours of Service functionality uses generation numbers to track changes to drivers duty logs; this number is a system wide (wrt to HoS) auto-incrementing number used for integration where the client is mirroring the duty logs into another system. When we get a new duty record, or an existing record is modified, we get the latest number, increment the number and assign this to the new or updated record. For the purpose of finding changes to drivers duty logs, we will use the same field.
When the system goes live, the client will need to pass zero to generationNumber. The method will return a list of drivers that have had updated duty records within the cycle. The method will also return, as an output parameter, the generation number that should be used in the next call in generationNumberForNextCall. If there are no changes, no data will be returned, and the output generation number will be equal to the input parameter.
Please see this page.