Back to index

GetDriverAuthenticationEvents_v1

This method allows you to get a drivers' authentication events

Parameters:

[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] recordTimeStamp The time for and after which you would like to retrieve the data.
[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.
[out] lastRecordTimeStamp Timestamp of last driver authentication record.
[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 where columns=[VehicleID, VehicleName, DriverID, DriverName, EventTimeStamp, EventType, DriverType, RecordTimeStamp]:
<?xml version="1.0" encoding="utf-16"?>
<root>
  <EX_GetDriverAuthenticationEvents>
    <row VehicleID= "1" VehicleName="Vehicle 1" DriverID="1" DriverName="Driver1" EventTimeStamp="2018-01-15 16:36:28Z" EventType="LogIn" DriverType="Main" RecordTimeStamp="2018-01-15 16:36:29Z" />
  </EX_GetDriverAuthenticationEvents>
</root>
Please note this.

Remarks

Minimum R-COM Database version

0.2322

Error messages

Please see this page.