<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <title> Bugzilla::WebService::Server::XMLRPC</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" title="style" type="text/css" href="../../.././../../../../style.css" media="all" > </head> <body id="pod"> <p class="backlinktop"><b><a name="___top" href="../../../index.html" accesskey="1" title="All Documents"><<</a></b></p> <h1>Bugzilla::WebService::Server::XMLRPC</h1> <div class='indexgroup'> <ul class='indexList indexList1'> <li class='indexItem indexItem1'><a href='#NAME'>NAME</a> <li class='indexItem indexItem1'><a href='#DESCRIPTION'>DESCRIPTION</a> <li class='indexItem indexItem1'><a href='#XML-RPC'>XML-RPC</a> <li class='indexItem indexItem1'><a href='#CONNECTING'>CONNECTING</a> <li class='indexItem indexItem1'><a href='#PARAMETERS'>PARAMETERS</a> <ul class='indexList indexList2'> <li class='indexItem indexItem2'><a href='#How_XML-RPC_WebService_Methods_Take_Parameters'>How XML-RPC WebService Methods Take Parameters</a> </ul> <li class='indexItem indexItem1'><a href='#EXTENSIONS_TO_THE_XML-RPC_STANDARD'>EXTENSIONS TO THE XML-RPC STANDARD</a> <ul class='indexList indexList2'> <li class='indexItem indexItem2'><a href='#Undefined_Values'>Undefined Values</a> </ul> <li class='indexItem indexItem1'><a href='#SEE_ALSO'>SEE ALSO</a> <li class='indexItem indexItem1'><a href='#Methods_in_need_of_POD'>Methods in need of POD</a> </ul> </div> <h1><a class='u' href='#___top' title='click to go to top of document' name="NAME" >NAME</a></h1> <p>Bugzilla::WebService::Server::XMLRPC - The XML-RPC Interface to Bugzilla</p> <h1><a class='u' href='#___top' title='click to go to top of document' name="DESCRIPTION" >DESCRIPTION</a></h1> <p>This documentation describes things about the Bugzilla WebService that are specific to XML-RPC. For a general overview of the Bugzilla WebServices, see <a href="../../../Bugzilla/WebService.html" class="podlinkpod" >Bugzilla::WebService</a>.</p> <h1><a class='u' href='#___top' title='click to go to top of document' name="XML-RPC" >XML-RPC</a></h1> <p>The XML-RPC standard is described here: <a href="http://www.xmlrpc.com/spec" class="podlinkurl" >http://www.xmlrpc.com/spec</a></p> <h1><a class='u' href='#___top' title='click to go to top of document' name="CONNECTING" >CONNECTING</a></h1> <p>The endpoint for the XML-RPC interface is the <code class="code">xmlrpc.cgi</code> script in your Bugzilla installation. For example, if your Bugzilla is at <code class="code">bugzilla.yourdomain.com</code>, then your XML-RPC client would access the API via: <code class="code">http://bugzilla.yourdomain.com/xmlrpc.cgi</code></p> <h1><a class='u' href='#___top' title='click to go to top of document' name="PARAMETERS" >PARAMETERS</a></h1> <p><code class="code">dateTime</code> fields are the standard <code class="code">dateTime.iso8601</code> XML-RPC field. They should be in <code class="code">YYYY-MM-DDTHH:MM:SS</code> format (where <code class="code">T</code> is a literal T). As of Bugzilla <b>3.6</b>, Bugzilla always expects <code class="code">dateTime</code> fields to be in the UTC timezone, and all returned <code class="code">dateTime</code> values are in the UTC timezone.</p> <p>All other fields are standard XML-RPC types.</p> <h2><a class='u' href='#___top' title='click to go to top of document' name="How_XML-RPC_WebService_Methods_Take_Parameters" >How XML-RPC WebService Methods Take Parameters</a></h2> <p>All functions take a single argument, a <code class="code"><struct></code> that contains all parameters. The names of the parameters listed in the API docs for each function are the <code class="code"><name></code> element for the struct <code class="code"><member></code>s.</p> <h1><a class='u' href='#___top' title='click to go to top of document' name="EXTENSIONS_TO_THE_XML-RPC_STANDARD" >EXTENSIONS TO THE XML-RPC STANDARD</a></h1> <h2><a class='u' href='#___top' title='click to go to top of document' name="Undefined_Values" >Undefined Values</a></h2> <p>Normally, XML-RPC does not allow empty values for <code class="code">int</code>, <code class="code">double</code>, or <code class="code">dateTime.iso8601</code> fields. Bugzilla does--it treats empty values as <code class="code">undef</code> (called <code class="code">NULL</code> or <code class="code">None</code> in some programming languages).</p> <p>Bugzilla accepts a timezone specifier at the end of <code class="code">dateTime.iso8601</code> fields that are specified as method arguments. The format of the timezone specifier is specified in the ISO-8601 standard. If no timezone specifier is included, the passed-in time is assumed to be in the UTC timezone. Bugzilla will never output a timezone specifier on returned data, because doing so would violate the XML-RPC specification. All returned times are in the UTC timezone.</p> <p>Bugzilla also accepts an element called <code class="code"><nil></code>, as specified by the XML-RPC extension here: <a href="http://ontosys.com/xml-rpc/extensions.php" class="podlinkurl" >http://ontosys.com/xml-rpc/extensions.php</a>, which is always considered to be <code class="code">undef</code>, no matter what it contains.</p> <p>Bugzilla does not use <code class="code"><nil></code> values in returned data, because currently most clients do not support <code class="code"><nil></code>. Instead, any fields with <code class="code">undef</code> values will be stripped from the response completely. Therefore <b>the client must handle the fact that some expected fields may not be returned</b>.</p> <h1><a class='u' href='#___top' title='click to go to top of document' name="SEE_ALSO" >SEE ALSO</a></h1> <p><a href="../../../Bugzilla/WebService.html" class="podlinkpod" >Bugzilla::WebService</a></p> <h1><a class='u' href='#___top' title='click to go to top of document' name="Methods_in_need_of_POD" ><b>Methods in need of POD</b></a></h1> <dl> <dt><a name="make_response" >make_response</a></dt> <dd> <dt><a name="initialize" >initialize</a></dt> <dd> <dt><a name="handle_login" >handle_login</a></dt> </dl> <p class="backlinkbottom"><b><a name="___bottom" href="../../../index.html" title="All Documents"><<</a></b></p> <!-- end doc --> </body></html>