Contest List (Version 1.0)
The Contest List shows data by election and voting district that help inform the user on what choices they have on Election Day. When providing this data to your users you must make every effort to disclaim the fact that their Election Day ballot may not match 100% with the contests and candidates provided by this service. The election administrator makes every effort to keep the data current with candidate declination, election commissioner decisions, death, disqualification and court decisions however very last minute changes may be worked out directly with the ballot printer.
Call:
ELECTIONID - this uniquely identifying integer is first found from the pollsiteinfo service returns, see
pollsiteinfo and elections arrary
DISTRICTKEY - this key representing the voting district of the user is first found from the pollsiteinfo returns see
pollsiteinfo and election_district
| NOTE: Be sure to include the key parameter with your call see api_keys |
Returns:
| parties | array of party objects, for elections that are not primaries there will be zero or only one party (a pseudo party called “All Parties, Independent Bodies and Proposals”) |
party object
| abbreviatedName | party name that is sure to fit on a printed ballot |
| code | official state 3 character code |
| color | rgb color code |
| contests | array of contest objects (defined below) |
| created | JSON representation of the date the party was created |
| createdBy | identifier for the user who created the party record |
| emblem | binary data for the emblem image |
| ID | unique integer for the party record |
| isActive | a flag for indicating the status of the party record |
| isEnforced | internal - ignore |
| isEstablished | a flag for a party that has reached Primary eligible status based on State Election Law |
| isMajor | a flag indicating the top two parties according to the standards set by State Election Law |
| isRecognized | a flag for all parties and pseudo parties that a voter in the state may register or enroll under |
| mainFrameCode | one character code |
| modified | JSON representation of the date the party record was last saved |
| modifiedBy | identifier for the user who last modified the party record |
| name | official name of the party |
| objectCount | internal - ignore |
| regCode | code used for voter registration |
| relativeOrder | the sequence of the parties based on State Election Law (please abide by this order wherever they are displayed) |
| sample_ballot_url | URL where a sample ballot image or PDF is hosted |
| trx | internal - ignore |
contest object
| candidacies | array of candidacy object running within the contest (defined below) |
| contest_description | formal ballot description of the contest including office title/party position/proposal number and political subdivision |
| proposal_text | full text of a ballot proposal contest |
| NOTE: The contest objects within the contests array are in proper ballot order |
candidacy object
| ballot_name | the official description of the potential vote-getting entity on the ballot |
| candidacy_name | ballot name plus the running under party or independent body for non-primary elections |
| group | group label for committees or delegates |
| party | the name of the party or independent body the candidacy is running under |
| NOTE: The candidacy objects within the candidacies array are in proper ballot order however do not represent any rotation schemes devised by the election administrator |
Primary Election Sample:
| Name | Value |
| parties | [(see below)] |
party object
| Name | Value |
| abbreviatedName | “Working Families” |
| code | “WOR” |
| color | “#DFC5A4” |
| contests | [(see below)] |
| created | “/Date(-62135568000000-0800)/“ |
| createdBy | 1 |
| emblem | null |
| ID | 60 |
| isActive | true |
| isEnforced | false |
| isEstablished | true |
| isMajor | false |
| isRecognized | true |
| mainFrameCode | “W” |
| modified | ”/Date(-62135568000000-0800)/“ |
| modifiedBy | 1 |
| name | “Working Families” |
| objectCount | null |
| regCode | “WOR” |
| relativeOrder | 4 |
| sample_ballot_url | “http://electiongateway.com/nyc/sample_ballots/380404/10/15/1.pdf“ |
| trx | null |
contest object
| Name | Value |
| candidacies | [(see below)] |
| contest_description | “Dog Catcher 33rd Zone” |
| proposal_text | ”“ |
candidacy object
| Name | Value |
| ballot_name | “Abe Lincoln” |
| candidacy_name | “Abe Lincoln” |
| group | “Group 1” |
| party | “Working Families” |
Non-Primary Election Sample:
| Name | Value |
| parties | [(1 static pseudo party, see below] |
party object
| Name | Value |
| abbreviatedName | null |
| code | null |
| color | null |
| contests | [(see below)] |
| created | ”/Date(-62135568000000-0800)/“ |
| createdBy | 0 |
| emblem | null |
| ID | 0 |
| isActive | |
| isEnforced | false |
| isEstablished | false |
| isMajor | false |
| isRecognized | false |
| mainFrameCode | null |
| modified | ”/Date(-62135568000000-0800)/“ |
| modifiedBy | 0 |
| name | “All Parties, Independent Bodies and Proposals” |
| objectCount | 0 |
| regCode | null |
| relativeOrder | 0 |
| sample_ballot_url | “http://electiongateway.com/nyc/sample_ballots/380519/12/1.pdf“ |
| trx | null |
contest object
| Name | Value |
| candidacies | [(see below)] |
| contest_description | “Mayor Citywide” |
| proposal_text | ”“ |
candidacy object
| Name | Value |
| ballot_name | “Mickey Mouse” |
| candidacy_name | “Mickey Mouse (More Cheese Please)“ |
| group | null |
| party | “More Cheese Please” |
