From 897b987778781e888d458899161c5afdc6afa991 Mon Sep 17 00:00:00 2001 From: John Dong Date: Wed, 29 Aug 2007 13:13:13 -0400 Subject: [PATCH] added quick documentation about XML-RPC interface --- public/selectricity-xmlrpc.html | 80 +++++++++++++++++++++++++++++++++ 1 file changed, 80 insertions(+) create mode 100644 public/selectricity-xmlrpc.html diff --git a/public/selectricity-xmlrpc.html b/public/selectricity-xmlrpc.html new file mode 100644 index 0000000..857ef91 --- /dev/null +++ b/public/selectricity-xmlrpc.html @@ -0,0 +1,80 @@ + + +
+

Selectricity XML-RPC
+ Voting Machinery By the Machinery, for the Machinery

+
+ + +

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 SelectricityService.

+ +

Usage

+ +

The XML-RPC service runs at /selectricity_service/vote of the server. +All of the available methods are documented both below and in the RubyDoc +generated documentation.

+ +
+

Important Note

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 this_method_name, the actual method +name you need to call is actually ThisMethodName.

+
+ +
+

Example PHP Script

+

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 The PHP + XML-RPC Library installed to utils/ in the include path. + +

+
+
+<?
+include("utils/utils.php");
+
+$host="192.168.195.1";
+$uri="/selectricity_service/vote";
+$result = xu_rpc_http_concise(
+  array(
+    'method' => "ListQuickvotes",
+    'host'  => $host,
+    'uri'  => $uri,
+    'port'  => 3000
+  )
+);
+echo "<table border=1>\n";echo "<tr><th>Name</th>
+<th>Description</th><th>ID</th>
+<th>Candidates</th></tr>\n";
+foreach($result as $i)
+{ 
+  
+  echo "<tr><td>";
+  echo $i['name'];
+  echo "</td><td>";
+  echo $i['description'];
+  echo "</td><td>";
+  echo $i['id'];
+  echo "</td><td>";
+  foreach($i['candidate_names'] as $cand)
+  { 
+    echo $cand . ", ";
+  }
+  echo "</td></tr>";
+}
+echo "</table>"
+
+
+?>
+
+
+
+ +
+

Copyleft 2006 :: +MIT Media Lab and +Benjamin Mako Hill

+ -- 2.30.2