Back to index

GetIdlingEvents_v1

This function can be used to retrieve information about FleetManagerApi.

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] requestedNumRows Specifies how many rows to return in this "chunk."
[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] earliestEndTime The end time of the event for and after which you would like to retrieve the data. Please make sure that you specify this in utc.
[in] startPointGeneration A start point expressed in terms of a generation number. For more on generation numbers and restart points, see the remarks section.
[out] lastGeneration The generation number of the last entry in the returned chunk.
[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.
[out] adjustedNumRows Each customer is configured with a minimum and maximum threshold. Maximum thresholds ensure no single response becomes too large. Minimum thresholds helps prevent the server being flooded with requests returning no data. If the client requests a number of rows outside these boundaries the number of rows returned will be adjusted.
Example: CustomerA has a minimum threshold of 100, and a maximum threshold of 1000. She sends a request for 2000 records. The adjustedNumRows will be 1000.
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" ?>
<root>
<EX_IdlingEvents>
  <row VehicleID="3" VehicleName="9305old"
     VehicleTypeID="3" DriverID="1" DriverName="Keven"
     LocationID="1" LocationDescription=""
     LocationCategoryID="1" LocationCategory="General"
     StartTime="2020-02-24 14:00:00Z" EndTime="2020-02-24 15:00:00Z"
     DurationMinutes="60" GenerationNumber="1" />
</EX_IdlingEvents>
</root>
Please note this.

Remarks

Minimum R-COM Database version

0.2924

Error messages

Please see this page.