Back to index

GetFormDefinitions_v1

This method wraps the R:Com Database view EX_RCOMInCabFormDefinitions. See R:COM Form Message 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.
[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.
[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.
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_RCOMInCabFormDefinitions>
  <row FormID="1000000" FormVersion="1" FormSchema="1" Name="Text Message" Status="0" StatusDescription="Active" FormData="&amp;amp;amp;lt;m s=&amp;amp;amp;quot;1&amp;amp;amp;quot;&amp;amp;amp;gt;&amp;amp;amp;lt;form_def type=&amp;amp;amp;quot;textmessage&amp;amp;amp;quot; name=&amp;amp;amp;quot;Text Message&amp;amp;amp;quot; id=&amp;amp;amp;quot;1000000&amp;amp;amp;quot; v=&amp;amp;amp;quot;1&amp;amp;amp;quot;&amp;amp;amp;gt;&amp;amp;amp;lt;unsolicited&amp;amp;amp;gt;true&amp;amp;amp;lt;/unsolicited&amp;amp;amp;gt;&amp;amp;amp;lt;width&amp;amp;amp;gt;30&amp;amp;amp;lt;/width&amp;amp;amp;gt;&amp;amp;amp;lt;height&amp;amp;amp;gt;5&amp;amp;amp;lt;/height&amp;amp;amp;gt;&amp;amp;amp;lt;field name=&amp;amp;amp;quot;text&amp;amp;amp;quot; id=&amp;amp;amp;quot;0&amp;amp;amp;quot;&amp;amp;amp;gt;&amp;amp;amp;lt;x&amp;amp;amp;gt;30&amp;amp;amp;lt;/x&amp;amp;amp;gt;&amp;amp;amp;lt;y&amp;amp;amp;gt;11&amp;amp;amp;lt;/y&amp;amp;amp;gt;&amp;amp;amp;lt;size&amp;amp;amp;gt;8&amp;amp;amp;lt;/size&amp;amp;amp;gt;&amp;amp;amp;lt;type&amp;amp;amp;gt;String&amp;amp;amp;lt;/type&amp;amp;amp;gt;&amp;amp;amp;lt;/field&amp;amp;amp;gt;&amp;amp;amp;lt;/form_def&amp;amp;amp;gt;&amp;amp;amp;lt;/m&amp;amp;amp;gt;" Inbound="True" NonExistingColumn="" />
</EX_RCOMInCabFormDefinitions>
</root>
Please note this.

Remarks

Minimum R-COM Database version

0.708

Error messages

Please see this page.