Rename Selectricity API calls to more explicitly call itself quickvotes.

[selectricity] / app / apis / selectricity_api.rb

diff --git a/app/apis/selectricity_api.rb b/app/apis/selectricity_api.rb
index 6a3af7245d3cbb61e111bd761c42a5746b16d217..005985b41db7c55763426e76ef11376065f8e476 100644 (file)
--- a/app/apis/selectricity_api.rb
+++ b/app/apis/selectricity_api.rb
@@ -1,36 +1,36 @@
-class ElectionStruct < ActionWebService::Struct
+class QuickVoteStruct < ActionWebService::Struct
   member :name, :string
   member :description, :string
-  member :candidates, [:int]
+  member :candidate_ids, [:int]
+  member :candidate_names, [:string]
   member :id, :int
 end
-class VoteInfo < ActionWebService::Struct
+class QuickVoterInfo < ActionWebService::Struct
   member :voter_id, :int
+  member :voter_session_id, :string
   member :voter_ipaddress, :string
   member :vote_time, :int
+  member :vote, [:int]
 end
 
-class VoteResultStruct < ActionWebService::Struct
+class QuickVoteResultStruct < ActionWebService::Struct
   member :plurality_winners, [:int]
   member :approval_winners, [:int]
   member :condorcet_winners, [:int]
   member :ssd_winners, [:int]
   member :borda_winners, [:int]
-  member :errors, [:string]
 end
-class CandidateMap < ActionWebService::Struct
+class QuickVoteCandidateMap < ActionWebService::Struct
   member :candidate_ids, [:int]
   member :candidate_names, [:string]
-  member :errors, [:string]
 end
 class SelectricityAPI < ActionWebService::API::Base
   api_method :cast_quickvote, :expects => [:string, :int, [[:int]]], :returns => [:string]
-  api_method :get_quickvote_results, :expects => [:string], :returns => [VoteResultStruct]
-  api_method :get_quickvote_candidate_map, :expects => [:string], :returns => [CandidateMap]
+  api_method :get_quickvote_results, :expects => [:string], :returns => [QuickVoteResultStruct]
+  api_method :get_quickvote_candidate_map, :expects => [:string], :returns => [QuickVoteCandidateMap]
   api_method :quickvote_candidate_ids_to_names, :expects => [:string,[:int]], :returns => [[:string]]
-  api_method :get_quickvote_votes, :expects => [:string], :returns => [ [VoteInfo] ]
-  api_method :list_quickvotes, :expects => [], :returns => [[ElectionStruct]]
-  api_method :get_quickvote, :expects => [:string], :returns => [ElectionStruct]
+  api_method :get_quickvote_votes, :expects => [:string], :returns => [ [QuickVoterInfo] ]
+  api_method :list_quickvotes, :expects => [], :returns => [[QuickVoteStruct]]
+  api_method :get_quickvote, :expects => [:string], :returns => [QuickVoteStruct]
+  api_method :create_quickvote, :expects => [QuickVoteStruct], :returns => [:string]
 end
-
-