Xantech CRM-WIC, Reference Manual

Page: 46 / 99

46
Remote Procedure Calls
The CRM-WIC supports remote procedure calls (RPCs) for most web interfaces, including HTML, Flash
(.fla), and Active Server Pages (.asp). Methods are typically called using the HTTP Post syntax for
HTML and Flash, and Visual Basic scripting for Active Server Pages.
This RPC reference covers:
•
RPC Server Logs
•
Syntax for HTTP Post
•
Fault Codes
•
Flash Example
•
Visual Basic Scripting
•
Note on Error Checking
•
Detailed List of All Methods
RPC Server Logs
As noted in Diagnostics web pages section, key information regarding the RPC server can be retrieved
from the Log Files web page. This information includes the RPC server version and a list of available
methods. The Log Files web page also allows you to enable logging for the RPC commands.
Syntax for HTTP Post
Call Tokens
Methods may be called using HTTP Post using the following call tokens:
•
version - The RPC server version may be obtained through the Log pages in the Admin Web
Pages, but this token is entirely optional and may be safely omitted from the call.
•
method - Name of the method to call.
•
param [ i ] - Value for parameter # i , where i is an integer.
General format for a call using HTTP Post:
[version= [ RPC Server Version ] &]method= [ Method to Call
] [&param1= [ Value for Parameter 1 ] &param2= [ Value for
Parameter 2 ] &param3= [ Value for Parameter 3, etc...] ]
See the detailed list of methods at the end of this reference for the method name and the values for
param1 , param2 , etc. These parameter values are denoted by the text "
[in]
" in the Syntax and
Parameters sections.