XML-RPC is a remote procedure call (RPC) protocol which uses XML to encode its calls and HTTP as a transport mechanism. "XML-RPC" also refers generically to the use of XML for remote procedure call, independently of the specific protocol. This article is about the protocol named "XML-RPC".
The XML-RPC protocol was created in 1998 by Dave Winer of UserLand Software and Microsoft, with Microsoft seeing the protocol as an essential part of scaling up its efforts in business-to-business e-commerce. As new functionality was introduced, the standard evolved into what is now SOAP.
XML-RPC's idea of a human-readable-and-writable, script-parsable standard for HTTP-based requests and responses has also been implemented in competing specifications such as Allaire's Web Distributed Data Exchange (WDDX) and webMethod's Web Interface Definition Language (WIDL). Prior art wrapping COM, CORBA, and Java RMI objects in XML syntax and transporting them via HTTP also existed in DataChannel's WebBroker technology.
The generic use of XML for remote procedure call (RPC) was patented by Phillip Merrick, Stewart Allen, and Joseph Lapp in April 2006, claiming benefit to a provisional application filed in March 1998. The patent is assigned to webMethods, located in Fairfax, VA.
XML-RPC works by sending an HTTP request to a server implementing the protocol. The client in that case is typically software wanting to call a single method of a remote system. Multiple input parameters can be passed to the remote method, one return value is returned. The parameter types allow nesting of parameters into maps and lists, thus larger structures can be transported. Therefore, XML-RPC can be used to transport objects or structures both as input and as output parameters.
Identification of clients for authorization purposes can be achieved using popular HTTP security methods. Basic access authentication is used for identification, HTTPS is used when identification (via certificates) and encrypted messages are needed. Both methods can be combined.
In comparison to REST, where resource representations (documents) are transferred, XML-RPC is designed to call methods.
XML-RPC can be argued as simpler than SOAP because it
- allows only one way to serialize methods, whereas SOAP defines multiple different encodings
- has a simpler security model
- does not require (nor support) the creation of WSDL service descriptions, although XRDL provides a simple subset of the functionality provided by WSDL
JSON-RPC is similar to XML-RPC.
Common datatypes are converted into their XML equivalents with example values shown below:
<array> <data> <value><i4>1404</i4></value> <value><string>Something here</string></value> <value><i4>1</i4></value> </data> </array>
|Array of values, storing no keys|
|Base64-encoded binary data|
|Boolean logical value (0 or 1)|
|Date and time in ISO 8601 format|
|Double precision floating point number|
|Whole number, integer|
|String of characters. Must follow XML encoding.|
<struct> <member> <name>foo</name> <value><i4>1</i4></value> </member> <member> <name>bar</name> <value><i4>2</i4></value> </member> </struct>
|Discriminated null value; an XML-RPC extension|
An example of a typical XML-RPC request would be:
<?xml version="1.0"?> <methodCall> <methodName>examples.getStateName</methodName> <params> <param> <value><i4>40</i4></value> </param> </params> </methodCall>
An example of a typical XML-RPC response would be:
<?xml version="1.0"?> <methodResponse> <params> <param> <value><string>South Dakota</string></value> </param> </params> </methodResponse>
A typical XML-RPC fault would be:
<?xml version="1.0"?> <methodResponse> <fault> <value> <struct> <member> <name>faultCode</name> <value><int>4</int></value> </member> <member> <name>faultString</name> <value><string>Too many parameters.</string></value> </member> </struct> </value> </fault> </methodResponse>
Recent critics (from 2010 and onwards) of XML-RPC argue that RPC calls can be made with plain XML, and that XML-RPC does not add any value over XML. Both XML-RPC and XML require an application-level data model, such as which field names are defined in the XML schema or the parameter names in XML-RPC. Furthermore, XML-RPC uses about 4 times the number of bytes compared to plain XML to encode the same objects, which is itself verbose compared to JSON.
- Ultra lightweight XML-RPC library for C++
- XML-RPC for C and C++
- XmlRpc C++ client for Windows
- gSOAP toolkit for C and C++ supporting XML-RPC and more
- libmaia: XML-RPC for Qt/C++
- XML-RPC Client S60: XML-RPC for Symbian/C++
- Cxxtools XML-RPC C++ Client and Server for POSIX. It's part of Tntnet project.
- AnyRPC[permanent dead link] Supports multiple RPC protocols including XML-RPC
Objective-C / GNUstep / Cocoa
- XML-RPC for Erlang: This is an HTTP 1.1 compliant XML-RPC library for Erlang. It is designed to make it easy to write XML-RPC Erlang clients and/or servers. The library is compliant with the XML-RPC specification published by http://web.archive.org/web/20051210031514/http://www.xmlrpc.org:80/
- Apache XML-RPC: Open source library for Java
- XML-RPC Delight: Convenient serialisation/deserialisation for Apache XML-RPC using Java Annotations and Beans
- : Secure Apache XML-RPC
- Redstone XML-RPC Library: Redstone's Open Source Library – XML-RPC implementation in Java
- XML-RPC Library for Java ME: Open source client-side library for Java ME
- aXMLRPC: Open source XML-RPC client library for Java and Android
- Nmote-xr: Open source BSD style client/server library with minimal dependencies
- XML-RPC for Google Polymer: A Google polymer component that deals with XML-RPC resources.
- pyJabberXMLRPC: Python classes for XMPP
- Jabber-RPC: Over the Extensible Messaging and Presence Protocol protocol
- XML-RPC in Zend_Framework 1.12: XML-RPC Server and Client in Zend_Framework 1.12
- XML-RPC in Zend_Framework 2.2: XML-RPC Server and Client in Zend_Framework 2
- XML-RPC for PHP: a library implementing the XML-RPC protocol, written in PHP
- RPC::XML[permanent dead link]: A set of Perl classes for core data, message and XML handling
- Frontier::RPC: Another set of Perl modules for XML-RPC client/server implementation
- XML::Compile::RPC: RPC extension to XML::Compile
- JSON/XML-RPC Client and Server: Abstract away the differences between JSON-RPC and XML-RPC
- RemObjects SDK Delphi and .NET package for XML-RPC, in addition to SOAP and others
- RealThinClient SDK: For Delphi/C++
- XML-RPC for ActionScript: For Flash ActionScript 2.0
- as3-rpclib: For Flex/Actionscript 3
- XML-RPC.NET: Open source library for .NET clients and servers
- XmlRpc-Light: Client and server library for OCaml
- S-XML-RPC: Client and server library for Common Lisp
- clj-xmlrpc[permanent dead link]: XML-RPC client for Clojure
- necessary-evil: XML-RPC Client and Ring-based Server for Clojure
- HaXR: Client and server library for Haskell
- Ruby XML-RPC library: For Ruby
- XML-RPC interface to Lua[permanent dead link]: For Lua
- android-xmlrpc: A light XML-RPC client for Google Android
- XML-RPC for Tcl: A Tcl implementation of XML-RPC providing client and server support
- RebXR: a full client/server XML-RPC implementation for REBOL
- Simon St. Laurent, Joe Johnston, Edd Dumbill. (June 2001) Programming Web Services with XML-RPC. O'Reilly. First Edition.
- Box, Don (1 April 2001). "A Brief History of SOAP". O'Reilly. Retrieved 27 October 2010.
- Rupley, Sebastian (1999-06-30). "XML's Next Step". PC Magazine. Archived from the original on 4 March 2000. Retrieved 2015-11-17.
- Walsh, Jeff (1999-07-10). "Microsoft spearheads protocol push". Infoworld. Archived from the original on 14 September 1999. Retrieved 2015-11-17.
- Walsh, Jeff (June 29, 1998). "UserLand releases Frontier 5.1, drops freeware model". InfoWorld. Archived from the original on 15 September 1999. Retrieved November 17, 2015.
- Udell, Jon (1999-06-07). "Exploring XML-RPC: DCOM? CORBA? RMI? Why Not Just XML-RPC?". Byte. Archived from the original on 4 March 2000. Retrieved 2015-11-17.
- Walsh, Jeff (1998-05-25). "W3C gives a nod to DataChannel's WebBroker". Infoworld. 20 (21). Archived from the original on 10 September 1999. Retrieved 2015-11-17.
- Vizard, Michael; Walsh, Jeff (1998-06-29). "DataChannel's Dave Pool talks about shaping the role of XML to suit different needs". Infoworld. Archived from the original on 16 September 1999. Retrieved 2015-12-08.
- Merrick; et al. (11 April 2006). "US Patent 7,028,312". Retrieved 18 September 2008.
- "What is the benefit of XML-RPC over plain XML?". Stack Overflow. 9 September 2009. Retrieved 7 April 2011.
- "An open poll on the merits of XmlRpc versus alternatives". intertwingly.net. 22 November 2006. Retrieved 7 April 2011. External link in
- Jon Canady (14 January 2010). "If you have REST, why XML-RPC?". joncanady.com. Archived from the original on 11 May 2013. Retrieved 7 April 2011. External link in