[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] options | String parameter. This is currently unused and reserved for future versions of the API. Pass in an empty string. |
[in] vehicleId | int parameter. The ID of the Vehicle you are receiving this message from. |
[in] guid | The unique identifier (GUID) you want to assign to this message. |
[in] formId | int parameter. Used to describe form layout. For a standard text message this is 1000000 (one million) |
[in] formVersion | int parameter. Used to describe form layout. For a standard text message this is 1. |
[in] formSchema | int parameter. Used to describe form layout. For a standard text message this is 1. |
[in] message | String parameter. The message to send in XML format. |
[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] messageId | int referring to the ID of the message after it is successfully stored in the database. Note this is different to the guid you supplied (not as important as the guid) |
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> <messages messageId="46" /> </root> |
Please see this page.