XML-RPC

From Wikipedia, the free encyclopedia

Jump to: navigation, search

XML-RPC is a remote procedure call protocol which uses XML to encode its calls and HTTP as a transport mechanism. [1]

Contents

[edit] Overview

XML-RPC is a very simple protocol, defining only a handful of data types and commands[2], and the entire description can be printed on two pages of paper. This is in stark contrast to most RPC systems, where the standards documents often run into the hundreds of pages and require considerable software support in order to be used.

[edit] History

XML-RPC was first created by Dave Winer of UserLand Software in 1998 with Microsoft. As new functionality was introduced, the standard evolved into what is now SOAP.

[edit] Usage

Some people still prefer XML-RPC to SOAP because of its simplicity, minimalism, and ease of use.

JSON-RPC is similar to XML-RPC.

[edit] Data types

Name Tag Example Description
array

<source lang="xml"> <array> 

 <data>
   <value><i4>1404</i4></value>
   <value><string>Something here</string></value>
   <value><i4>1</i4></value>
 </data>

</array> </source>

Array of values, storing no keys
base64

<source lang="xml"> <base64>eW91IGNhbid0IHJlYWQgdGhpcyE=</base64> </source>

Base64-encoded binary data
boolean

<source lang="xml"> <boolean>1</boolean> </source>

Boolean logical value (0 or 1)
date/time

<source lang="xml"> <dateTime.iso8601>19980717T14:08:55</dateTime.iso8601> </source>

Date and time in ISO 8601 format
double

<source lang="xml"> <double>-12.53</double> </source>

Double precision floating point number
integer

<source lang="xml"> <i4>42</i4> </source> or <source lang="xml"> <int>42</int> </source>

Whole number, integer
string

<source lang="xml"> <string>Hello world!</string> </source>

String of characters. Must follow XML encoding.
struct

<source lang="xml"> <struct> 

 <member>
   <name>foo</name>
   <value><i4>1</i4></value>
 </member>
 <member>
   <name>bar</name>
   <value><i4>2</i4></value>
 </member>

</struct> </source>

Associative array
nil

<source lang="xml"> <nil/> </source>

Discriminated null value; an XML-RPC extension

[edit] Examples

An example of a typical XML-RPC request would be: <source lang="xml"> <?xml version="1.0"?> <methodCall> 

 <methodName>examples.getStateName</methodName>
 <params>
   <param>
       <value><i4>40</i4></value>
   </param>
 </params>

</methodCall> </source>

An example of a typical XML-RPC response would be: <source lang="xml"> <?xml version="1.0"?> <methodResponse> 

 <params>
   <param>
       <value><string>South Dakota</string></value>
   </param>
 </params>

</methodResponse> </source>

A typical XML-RPC fault would be: <source lang="xml"> <?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> </source>

[edit] References

  1. ^ Simon St. Laurent, Joe Johnston, Edd Dumbill. (June 2001) Programming Web Services with XML-RPC. O'Reilly. First Edition.
  2. ^ Dave Winer. (June 15, 1999) XML-RPC Specification UserLand Software, Inc.

[edit] See also

[edit] External links

ca:XML-RPC de:XML-RPC es:XML-RPC fr:XML-RPC it:XML-RPC ja:XML-RPC pl:XML-RPC pt:XML-RPC ru:XML-RPC uk:XML-RPC

Retrieved from "http://india.smashits.com/wikipedia/XML-RPC"
Views
Personal tools

Toolbox