API name
The name of the call as it appears between the <func></func> tags.
Description
A general description of the API.
Input fields
The input fields, if any.
Return fields
The return fields. Sometimes a simply series of XML tags is returned, usually representing fields from a SiriusSQL table. Other times a more elaborate result is required: the XML schema used to represent the result is returned along with the data.
Example
Example invocation:
Example invocation of the function.
Example return string:
Example return string from the function. May be a simple indication of status (OK or ERR), a single or series of XML tags (usually representing fields from a SiriusSQL table) or an XML schema specification along with the data organized as described by the schema. In the latter case, a tool such as XML Spy can be used to display the schema and the data in tabular format for easy reference. To conserve space, the return strings in this manual only show the data, not the schema or XML namespace definitions.
See also:
Related functions in the API.