Author: humbedooh
Date: Sat Mar 21 09:55:18 2015
New Revision: 1668216
URL: http://svn.apache.org/r1668216
Log:
docu for voter link request on open elections
Modified:
steve/trunk/pytest/REST_API_README.txt
Modified: steve/trunk/pytest/REST_API_README.txt
URL:
http://svn.apache.org/viewvc/steve/trunk/pytest/REST_API_README.txt?rev=1668216&r1=1668215&r2=1668216&view=diff
==============================================================================
--- steve/trunk/pytest/REST_API_README.txt (original)
+++ steve/trunk/pytest/REST_API_README.txt Sat Mar 21 09:55:18 2015
@@ -14,6 +14,7 @@ Setting up a new election:
monitors: email addresses of monitors
starts: UNIX timestamp of start (optional)
ends: UNIX timestamp when it closes (optional)
+ open: If set to 'true', allows for an open (public) election
output:
HTTP 201 Created on success
HTTP 400 Bad request if params missing or invalid or already exists
@@ -271,6 +272,24 @@ Viewing a single issue:
}
+=======================
+Requesting a vote link:
+=======================
+/steve/voter/request/$electionid
+ GET
+ input:
+ email: the email to send voter link to
+ output:
+ HTTP 200 Okay if voter link issued
+ HTTP 400 if invalid or no email address specified
+ HTTP 404 Not Found if no such election/issue
+ HTTP 403 Forbidden if issue is not public
+ response payload:
+ JSON formatted
+ {
+ "message": "voter link sent to foo@bar"
+ }
+
MORE TO COME!
\ No newline at end of file
