API index

This server defines the following API specification:

MethodDescription
examples.getStateNameWhen passed an integer between 1 and 51 returns the name of a US state, where the integer is the index of that state name in an alphabetic order.
examples.sortByAgeSend this method an array of [string, int] structs, eg:
 Dave   35
 Edd    45
 Fred   23
 Barney 37
And the array will be returned with the entries sorted by their numbers.
examples.addtwoAdd two integers together and return the result
examples.addtwodoubleAdd two doubles together and return the result
examples.stringechoAccepts a string parameter, returns the string.
examples.echoAccepts a string parameter, returns the entire incoming payload
examples.decode64Accepts a base64 parameter and returns it decoded as a string
examples.invertBooleansAccepts an array of booleans, and returns them inverted
examples.generatePHPWarning
examples.getallheadersReturns a struct containing all the HTTP headers received with the request. Provides limited functionality with IIS
examples.setcookiesSends to client a response containing a single '1' digit, and sets to it http cookies as received in the request (array of structs describing a cookie)
mail.sendmail.send(recipient, subject, text, sender, cc, bcc, mimetype)
recipient, cc, and bcc are strings, comma-separated lists of email addresses, as described above.
subject is a string, the subject of the message.
sender is a string, it's the email address of the person sending the message. This string can not be a comma-separated list, it must contain a single email address only. text is a string, it contains the body of the message.
mimetype, a string, is a standard MIME type, for example, text/plain.
validator1.arrayOfStructsTestThis handler takes a single parameter, an array of structs, each of which contains at least three elements named moe, larry and curly, all s. Your handler must add all the struct elements named curly and return the result.
validator1.easyStructTestThis handler takes a single parameter, a struct, containing at least three elements named moe, larry and curly, all <i4>s. Your handler must add the three numbers and return the result.
validator1.echoStructTestThis handler takes a single parameter, a struct. Your handler must return the struct.
validator1.manyTypesTestThis handler takes six parameters, and returns an array containing all the parameters.
validator1.moderateSizeArrayCheckThis handler takes a single parameter, which is an array containing between 100 and 200 elements. Each of the items is a string, your handler must return a string containing the concatenated text of the first and last elements.
validator1.simpleStructReturnTestThis handler takes one parameter, and returns a struct containing three elements, times10, times100 and times1000, the result of multiplying the number by 10, 100 and 1000.
validator1.nestedStructTestThis handler takes a single parameter, a struct, that models a daily calendar. At the top level, there is one struct for each year. Each year is broken down into months, and months into days. Most of the days are empty in the struct you receive, but the entry for April 1, 2000 contains a least three elements named moe, larry and curly, all <i4>s. Your handler must add the three numbers and return the result.
validator1.countTheEntitiesThis handler takes a single parameter, a string, that contains any number of predefined entities, namely <, >, & ' and ".
Your handler must return a struct that contains five fields, all numbers: ctLeftAngleBrackets, ctRightAngleBrackets, ctAmpersands, ctApostrophes, ctQuotes.
interopEchoTests.echoStringEchoes string.
interopEchoTests.echoStringArrayEchoes string array.
interopEchoTests.echoIntegerEchoes integer.
interopEchoTests.echoIntegerArrayEchoes integer array.
interopEchoTests.echoFloatEchoes float.
interopEchoTests.echoFloatArrayEchoes float array.
interopEchoTests.echoStructEchoes struct.
interopEchoTests.echoStructArrayEchoes struct array.
interopEchoTests.echoValueEchoes any value back.
interopEchoTests.echoBase64Echoes base64.
interopEchoTests.echoDateEchoes dateTime.
interopEchoTests.whichToolkitReturns a struct containing the following strings: toolkitDocsUrl, toolkitName, toolkitVersion, toolkitOperatingSystem.
examples.php.getStateNameInner code of the state-number server. Used to test auto-registration of PHP funcions as xmlrpc methods.
system.listMethodsThis method lists all the methods that the XML-RPC server knows how to dispatch
system.methodHelpReturns help text if defined for the method passed, otherwise returns an empty string
system.methodSignatureReturns an array of known signatures (an array of arrays) for the method name passed. If no signatures are known, returns a none-array (test for type != array to detect missing signature)
system.multicallBoxcar multiple RPC calls in one request. See http://www.xmlrpc.com/discuss/msgReader$1208 for details
system.getCapabilitiesThis method lists all the capabilites that the XML-RPC server has: the (more or less standard) extensions to the xmlrpc spec that it adheres to