]> projects.mako.cc - selectricity-live/commitdiff
added quick documentation about XML-RPC interface
authorJohn Dong <jdong@mit.edu>
Wed, 29 Aug 2007 17:13:13 +0000 (13:13 -0400)
committerJohn Dong <jdong@mit.edu>
Wed, 29 Aug 2007 17:13:13 +0000 (13:13 -0400)
public/selectricity-xmlrpc.html [new file with mode: 0644]

diff --git a/public/selectricity-xmlrpc.html b/public/selectricity-xmlrpc.html
new file mode 100644 (file)
index 0000000..857ef91
--- /dev/null
@@ -0,0 +1,80 @@
+<html>
+   <link rel="stylesheet" type="text/css" href="stylesheets/main.css" />
+   <div id="top">
+  <h3>Selectricity XML-RPC<br />
+    <font size="-1">Voting Machinery <em>By the Machinery, for the Machinery</em></font></h3>
+</div>
+
+
+<p>Selectricity has a fully functional XML-RPC interface so that you can
+interface your own application with Selectricity. This API is documented in
+the doc/ subdirectry, under the class <b>SelectricityService</b>. </p>
+
+<h2>Usage</h2>
+
+<p>The XML-RPC service runs at <em>/selectricity_service/vote</em> of the server.
+All of the available methods are documented both below and in the RubyDoc
+generated documentation. <br> </p>
+
+<div class="warning">
+<h4>Important Note</h4> <p>Please note that the Rails framework automatically
+changes the case of a method name by capitalizing words separated by an
+underscore. For example, if you see <em>this_method_name</em>, the actual method
+name you need to call is actually <em>ThisMethodName</em>. </p>
+</div>
+
+<div class="example">
+<h4>Example PHP Script</h4>
+<p>Here is a short PHP script that calls the Selectricity Service to output all
+active QuickVotes to a table. It assumes that you have the samples/utils folder
+from <a href=http://xmlrpc-epi.sourceforge.net/main.php?t=php_about>The PHP
+  XML-RPC Library</a> installed to utils/ in the include path.
+
+</p>
+<blockquote>
+<pre>
+&lt;?
+include("utils/utils.php");
+
+$host="192.168.195.1";
+$uri="/selectricity_service/vote";
+$result = xu_rpc_http_concise(
+  array(
+    'method' =&gt; "ListQuickvotes",
+    'host'  =&gt; $host,
+    'uri'  =&gt; $uri,
+    'port'  =&gt; 3000
+  )
+);
+echo "&lt;table border=1&gt;\n";echo "&lt;tr&gt;&lt;th&gt;Name&lt;/th&gt;
+&lt;th&gt;Description&lt;/th&gt;&lt;th&gt;ID&lt;/th&gt;
+&lt;th&gt;Candidates&lt;/th&gt;&lt;/tr&gt;\n";
+foreach($result as $i)
+{ 
+  
+  echo "&lt;tr&gt;&lt;td&gt;";
+  echo $i['name'];
+  echo "&lt;/td&gt;&lt;td&gt;";
+  echo $i['description'];
+  echo "&lt;/td&gt;&lt;td&gt;";
+  echo $i['id'];
+  echo "&lt;/td&gt;&lt;td&gt;";
+  foreach($i['candidate_names'] as $cand)
+  { 
+    echo $cand . ", ";
+  }
+  echo "&lt;/td&gt;&lt;/tr&gt;";
+}
+echo "&lt;/table&gt;"
+
+
+?&gt;
+</pre>
+</blockquote>
+</div>
+
+<hr />
+<p><font size="-1">Copyleft 2006 ::
+<a href="http://www.media.mit.edu">MIT Media Lab</a> and
+<a href="http://mako.cc">Benjamin Mako Hill</a></font></p>
+</html>

Benjamin Mako Hill || Want to submit a patch?