<
?xml version='1.0' ?>
<
introspection version='1.0'>
<
typeList>
<
typeDescription name='system.value' basetype='struct' desc='description of a value'>
<
value type='string' name='name' optional='yes'>
value identifier<
/value>
<
value type='string' name='type'>
value&
apos
s xmlrpc or user-defined type<
/value>
<
value type='string' name='description'>
value&
apos
s textual description<
/value>
<
value type='boolean' name='optional'>
true if value is optional, else it is required<
/value>
<
value type='any' name='member' optional='yes'>
a child of this element. n/a for scalar types<
/value>
<
/typeDescription>
<
typeDescription name='system.valueList' basetype='array' desc='list of value descriptions'>
<
value type='system.value'/>
<
/typeDescription>
<
typeDescription name='system.stringList' basetype='array' desc='list of strings'>
<
value type='string'/>
<
/typeDescription>
<
/typeList>
<
methodList>
<
!-- system.describeMethods -->
<
methodDescription name='system.describeMethods'>
<
author>
Dan Libby<
/author>
<
purpose>
fully describes the methods and types implemented by this XML-RPC server.<
/purpose>
<
version>
1.1<
/version>
<
signatures>
<
signature>
<
params>
<
value type='array' name='methodList' optional='yes' desc='a list of methods to be described. if omitted, all are described.'>
<
value type='string'>
a valid method name<
/value>
<
/value>
<
/params>
<
returns>
<
value type='struct' desc='contains methods list and types list'>
<
value type='array' name='methodList' desc='a list of methods'>
<
value type='struct' desc='representation of a single method'>
<
value type='string' name='name'>
method name<
/value>
<
value type='string' name='version' optional='yes'>
method version<
/value>
<
value type='string' name='author' optional='yes'>
method author<
/value>
<
value type='string' name='purpose' optional='yes'>
method purpose<
/value>
<
value type='array' name='signatures' desc='list of method signatures'>
<
value type='struct' desc='representation of a single signature'>
<
value type='system.valueList' name='params' optional='yes'>
parameter list<
/value>
<
value type='system.valueList' name='returns' optional='yes'>
return value list<
/value>
<
/value>
<
/value>
<
value type='system.stringList' name='bugs' optional='yes'>
list of known bugs<
/value>
<
value type='system.stringList' name='errors' optional='yes'>
list of possible errors and error codes<
/value>
<
value type='system.stringList' name='examples' optional='yes'>
list of examples<
/value>
<
value type='system.stringList' name='history' optional='yes'>
list of modifications<
/value>
<
value type='system.stringList' name='notes' optional='yes'>
list of notes<
/value>
<
value type='system.stringList' name='see' optional='yes'>
see also. list of related methods<
/value>
<
value type='system.stringList' name='todo' optional='yes'>
list of unimplemented features<
/value>
<
/value>
<
/value>
<
value type='array' name='typeList' desc='a list of type descriptions. Typically used for referencing complex types'>
<
value type='system.value'>
a type description<
/value>
<
/value>
<
/value>
<
/returns>
<
/signature>
<
/signatures>
<
see>
<
item name='system.listMethods' />
<
item name='system.methodSignature' />
<
item name='system.methodHelp' />
<
/see>
<
example/>
<
error/>
<
note/>
<
bug/>
<
todo/>
<
/methodDescription>
<
!-- system.listMethods -->
<
methodDescription name='system.listMethods'>
<
author>
Dan Libby<
/author>
<
purpose>
enumerates the methods implemented by this XML-RPC server.<
/purpose>
<
version>
1.0<
/version>
<
signatures>
<
signature>
<
returns>
<
value type='array' desc='an array of strings'>
<
value type='string'>
name of a method implemented by the server.<
/value>
<
/value>
<
/returns>
<
/signature>
<
/signatures>
<
see>
<
item name='system.describeMethods' />
<
item name='system.methodSignature' />
<
item name='system.methodHelp' />
<
/see>
<
example/>
<
error/>
<
note/>
<
bug/>
<
todo/>
<
/methodDescription>
<
!-- system.methodHelp -->
<
methodDescription name='system.methodHelp'>
<
author>
Dan Libby<
/author>
<
purpose>
provides documentation string for a single method<
/purpose>
<
version>
1.0<
/version>
<
signatures>
<
signature>
<
params>
<
value type='string' name='methodName'>
name of the method for which documentation is desired<
/value>
<
/params>
<
returns>
<
value type='string'>
help text if defined for the method passed, otherwise an empty string<
/value>
<
/returns>
<
/signature>
<
/signatures>
<
see>
<
item name='system.listMethods' />
<
item name='system.methodSignature' />
<
item name='system.methodHelp' />
<
/see>
<
example/>
<
error/>
<
note/>
<
bug/>
<
todo/>
<
/methodDescription>
<
!-- system.methodSignature -->
<
methodDescription name='system.methodSignature'>
<
author>
Dan Libby<
/author>
<
purpose>
provides 1 or more signatures for a single method<
/purpose>
<
version>
1.0<
/version>
<
signatures>
<
signature>
<
params>
<
value type='string' name='methodName'>
name of the method for which documentation is desired<
/value>
<
/params>
<
returns>
<
value type='array' desc='a list of arrays, each representing a signature'>
<
value type='array' desc='a list of strings. the first element represents the method return value. subsequent elements represent parameters.'>
<
value type='string'>
a string indicating the xmlrpc type of a value. one of: string, int, double, base64, datetime, array, struct<
/value>
<
/value>
<
/value>
<
/returns>
<
/signature>
<
/signatures>
<
see>
<
item name='system.listMethods' />
<
item name='system.methodHelp' />
<
item name='system.describeMethods' />
<
/see>
<
example/>
<
error/>
<
note/>
<
bug/>
<
todo/>
<
/methodDescription>
<
!-- system.multiCall -->
<
methodDescription name='system.multiCall'>
<
author>
Dan Libby<
/author>
<
purpose>
executes multiple methods in sequence and returns the results<
/purpose>
<
version>
1.0<
/version>
<
signatures>
<
signature>
<
params>
<
value type='array' name='methodList' desc='an array of method call structs'>
<
value type='struct' desc='a struct representing a single method call'>
<
value type='string' name='methodName' desc='name of the method to be executed'/>
<
value type='array' name='params' desc='an array representing the params to a method. sub-elements should match method signature'/>
<
/value>
<
/value>
<
/params>
<
returns>
<
value type='array' desc='an array of method responses'>
<
value type='array' desc='an array containing a single value, which is the method&
apos
s response'/>
<
/value>
<
/returns>
<
/signature>
<
/signatures>
<
see>
<
item name='system.listMethods' />
<
item name='system.methodHelp' />
<
item name='system.describeMethods' />
<
/see>
<
example/>
<
error/>
<
note/>
<
bug/>
<
todo/>
<
/methodDescription>
<
!-- system.getCapabilities -->
<
methodDescription name='system.getCapabilities'>
<
author>
Dan Libby<
/author>
<
purpose>
returns a list of capabilities supported by this server<
/purpose>
<
version>
1.0<
/version>
<
notes>
<
item>
spec url: http://groups.yahoo.com/group/xml-rpc/message/2897<
/item>
<
/notes>
<
signatures>
<
signature>
<
returns>
<
value type='struct' desc='list of capabilities, each with a unique key defined by the capability&
apos
s spec'>
<
value type='struct' desc='definition of a single capability'>
<
value type='string' name='specURL'>
www address of the specification defining this capability<
/value>
<
value type='int' name='specVersion'>
version of the spec that this server's implementation conforms to<
/value>
<
/value>
<
/value>
<
/returns>
<
/signature>
<
/signatures>
<
see>
<
item name='system.listMethods' />
<
item name='system.methodHelp' />
<
item name='system.describeMethods' />
<
/see>
<
example/>
<
error/>
<
note/>
<
bug/>
<
todo/>
<
/methodDescription>
<
/methodList>
<
/introspection>
Error calling user introspection callback: %s()
Error occurred at line %ld, column %ld, byte index %ld
Invalid xml structure. Unable to create introspection data
Unable to add introspection data returned from %s()
Unable to add introspection data returned from %s(), improper element structure
Xml parse error: [line %ld, column %ld, message: %s] Unable to add introspection data returned from %s()
Xml parse error: [line %ld, column %ld, message: %s] Unable to create introspection data