| [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] startOfDayUTC | This is the UTC time for the start of the day. Can be set up to 180 days prior to today. |
| [in] endDateUTC | This is the UTC time for the end of the day. Returns up to 30 days worth of data from StartOfDayUTC if not set, can be set upto 30 days afer startOfDayUTC. |
| [out] errorMsg | If an error occurs this string contains the error message. In the event of an error (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_GetDriversDailyDutyLogSummary> <row DriverID="25" DriverName="Ed Taylor" StartOfDay="2013-05-07 05:00:00Z" EndOfDay="2013-05-08 05:00:00Z" StartTime="2013-05-07 05:00:00Z" DistanceTravelled="0" DrivingDurationMinutes="0" OnDutyDurationMinutes="1440" SleeperBerthDurationMinutes="0" OffDutyDurationMinutes="0" /> <row DriverID="42" DriverName="Rick Mikkelson" StartOfDay="2013-05-07 05:00:00Z" EndOfDay="2013-05-08 05:00:00Z" StartTime="2013-05-07 05:00:00Z" DistanceTravelled="0" DrivingDurationMinutes="0" OnDutyDurationMinutes="1440" SleeperBerthDurationMinutes="0" OffDutyDurationMinutes="0" /> <row DriverID="48" DriverName="Jacob Bemis" StartOfDay="2013-05-07 05:00:00Z" EndOfDay="2013-05-08 05:00:00Z" StartTime="2013-05-07 05:00:00Z" DistanceTravelled="0" DrivingDurationMinutes="0" OnDutyDurationMinutes="1440" SleeperBerthDurationMinutes="0" OffDutyDurationMinutes="0" /> <row DriverID="48" DriverName="Jacob Bemis" StartOfDay="2013-05-08 05:00:00Z" EndOfDay="2013-05-09 05:00:00Z" StartTime="2013-05-08 05:00:00Z" DistanceTravelled="0" DrivingDurationMinutes="0" OnDutyDurationMinutes="1440" SleeperBerthDurationMinutes="0" OffDutyDurationMinutes="0" /> <row DriverID="25" DriverName="Ed Taylor" StartOfDay="2013-05-09 05:00:00Z" EndOfDay="2013-05-10 05:00:00Z" StartTime="2013-05-09 05:00:00Z" DistanceTravelled="0" DrivingDurationMinutes="0" OnDutyDurationMinutes="485" SleeperBerthDurationMinutes="0" OffDutyDurationMinutes="0" /> <row DriverID="42" DriverName="Rick Mikkelson" StartOfDay="2013-05-09 05:00:00Z" EndOfDay="2013-05-10 05:00:00Z" StartTime="2013-05-09 05:00:00Z" DistanceTravelled="0" DrivingDurationMinutes="0" OnDutyDurationMinutes="485" SleeperBerthDurationMinutes="0" OffDutyDurationMinutes="0" /> </EX_HoS_GetDriversDailyDutyLogSummary> </root> |
This method can be used to fetch daily summaries of the drivers duty logs. It is expected that the client will periodically call this method once every 5-10 minutes to get the summary for the current day.
As the FleetManagerAPI web-service will typically be deployed in a time-zone that will differ from the client, the client is responsible for telling the web-service what the start of day is in UTC. For example, if this method is being called for “today”, where the current time is 2013-04-26 09:00 Central Time (UTC-6 hours), the start of day (as Local) is 2013-04-26 00:00; the client needs to pass this value as UTC – so client will send the date time 2013-04-26 06:00.
It is also possible to get more than one days of logs using this method by changing the startOfDay; this feature is expected to be used in the following scenarios:
Please see this page.