Back to index

GetRCOMCANFaultCodes_v1

This function can be used to retrieve the Suspect Parameter Number (SPN) and Failure Mode Information (FMI) for RCOM CAN Fault Codes. The oldest date for startTimeStamp is 180 days before today. startTimeStamp will give you the information of a maximum up to 30 days.

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] passedColumns String array of the requested columns. 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] DateTime startTimeStamp Date of starting for the query. This can be any date in the previous 180 days, and will return all rows from that date until 30 days later.
[in] options String parameter. This is currently unused and reserved for future versions of the API. Pass in an empty string.
[out] DateTime lastTimeStamp The timestamp of the newest record in the returned chunk
[out] errorMsg If an error happens 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] ajustedRowNumber Under some circumstances it might happen that the web-service cannot use the requestedRowNumber to execute the query therefore it needs to adjust it. This value reveals the real row number that was used to perform the query. For more information see "Retrieving large amount of data" in the remarks.

Remarks

Minimum R-COM Database version

0.2803

Retrieving large amount of data

You cannot use this function to retrieve infinitely large amount of data in one call. If you would like to get a large set of rows you will need to call this function several times. You can specify your preference about the number of rows returned in one function-call in requestedRowNumber. If it is possible, the webservice will use this number, but there are circumstances in which the webservice needs to adjust this number for performing the query. The real number of rows that was used for performing the query is returned in ajustedRowNumber.

To find out whether there are more data rows that were not returned with the previous call you should compare ajustedRowNumber with the number of rows in the returned xml. If these two numbers match then it is likely that there are more rows to return. If the number of rows in the returned xml is smaller than ajustedRowNumber then most probably you have retrieved all the data for now. No new rows will be returned until new sets of data are recorded.

If you want to fetch the next set of data, you need to remember the value of lastTimeStamp from the last call and pass that value in as startTimeStamp to query the following set of rows.

There is a chance that you get the same rows more than once, your application needs to be prepared to handle this case.

Error messages

Please see this page.