Back to index

GetLocationWatchlistBreaks_v1

This method wraps the R:Com Database procedure EX_WatchlistLocationBreaks. See R:COM Database API document.

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] 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] latestBreakID Int parameter. To be used as a pointer to identify any breaks that occurred after this ID.
[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"?>
<root>
<EX_WatchlistLocationBreaks>
  <row BreakID="1" WatchID="1" WatchLocationIdentifier="MCS-12345" DriverID="2" VehicleID="3" BreakLatitude="1" BreakLongitude="1.5" WatchLatitude="" WatchLongitude="" WatchRadiusInKm="" WatchType="Entered" WatchLocationID="100" BreakTime="2024-03-14 12:07:49Z" />
  <row BreakID="2" WatchID="2" WatchLocationIdentifier="MCS-54321" DriverID="2" VehicleID="3" BreakLatitude="1" BreakLongitude="1.5" WatchLatitude="3" WatchLongitude="3.5" WatchRadiusInKm="1" WatchType="Entered" WatchLocationID="" BreakTime="2024-03-14 12:08:12Z" />
</EX_WatchlistLocationBreaks>
</root>
Please note this.

Remarks

Minimum R-COM Database version

0.2982

Error messages

Please see this page.