User Tools

Site Tools


version_1.0_contestlist

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:

contestlist GET Service at https://nyc.electionapi.com/psl/version/1.0/contestlist?districtkey={DISTRICTKEY}&electionid={ELECTIONID}
  • 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:

partiesarray 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

abbreviatedNameparty name that is sure to fit on a printed ballot
codeofficial state 3 character code
colorrgb color code
contestsarray of contest objects (defined below)
createdJSON representation of the date the party was created
createdByidentifier for the user who created the party record
emblembinary data for the emblem image
IDunique integer for the party record
isActivea flag for indicating the status of the party record
isEnforcedinternal - ignore
isEstablisheda flag for a party that has reached Primary eligible status based on State Election Law
isMajora flag indicating the top two parties according to the standards set by State Election Law
isRecognizeda flag for all parties and pseudo parties that a voter in the state may register or enroll under
mainFrameCodeone character code
modifiedJSON representation of the date the party record was last saved
modifiedByidentifier for the user who last modified the party record
nameofficial name of the party
objectCountinternal - ignore
regCodecode used for voter registration
relativeOrderthe sequence of the parties based on State Election Law (please abide by this order wherever they are displayed)
sample_ballot_urlURL where a sample ballot image or PDF is hosted
trxinternal - ignore

contest object

candidaciesarray of candidacy object running within the contest (defined below)
contest_descriptionformal ballot description of the contest including office title/party position/proposal number and political subdivision
proposal_textfull text of a ballot proposal contest
NOTE: The contest objects within the contests array are in proper ballot order

candidacy object

ballot_namethe official description of the potential vote-getting entity on the ballot
candidacy_nameballot name plus the running under party or independent body for non-primary elections
groupgroup label for committees or delegates
partythe 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:

NameValue
parties[(see below)]

party object

NameValue
abbreviatedName“Working Families”
code“WOR”
color“#DFC5A4”
contests[(see below)]
created“/Date(-62135568000000-0800)/“
createdBy1
emblemnull
ID60
isActivetrue
isEnforcedfalse
isEstablishedtrue
isMajorfalse
isRecognizedtrue
mainFrameCode“W”
modified”/Date(-62135568000000-0800)/“
modifiedBy1
name“Working Families”
objectCountnull
regCode“WOR”
relativeOrder4
sample_ballot_urlhttp://electiongateway.com/nyc/sample_ballots/380404/10/15/1.pdf
trxnull

contest object

NameValue
candidacies[(see below)]
contest_description“Dog Catcher 33rd Zone”
proposal_text”“

candidacy object

NameValue
ballot_name“Abe Lincoln”
candidacy_name“Abe Lincoln”
group“Group 1”
party“Working Families”

Non-Primary Election Sample:

NameValue
parties[(1 static pseudo party, see below]

party object

NameValue
abbreviatedNamenull
codenull
colornull
contests[(see below)]
created”/Date(-62135568000000-0800)/“
createdBy0
emblemnull
ID0
isActive
isEnforcedfalse
isEstablishedfalse
isMajorfalse
isRecognizedfalse
mainFrameCodenull
modified”/Date(-62135568000000-0800)/“
modifiedBy0
name“All Parties, Independent Bodies and Proposals”
objectCount0
regCodenull
relativeOrder0
sample_ballot_urlhttp://electiongateway.com/nyc/sample_ballots/380519/12/1.pdf
trxnull

contest object

NameValue
candidacies[(see below)]
contest_description“Mayor Citywide”
proposal_text”“

candidacy object

NameValue
ballot_name“Mickey Mouse”
candidacy_name“Mickey Mouse (More Cheese Please)“
groupnull
party“More Cheese Please”
version_1.0_contestlist.txt · Last modified: 2019/09/10 10:36 by timsmith