Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / civicinfo_v2.elections.html
blob: ecd2cfda93205faaf79dcb5493d2b6d4a35f99fb [file] [log] [blame]
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="civicinfo_v2.html">Google Civic Information API</a> . <a href="civicinfo_v2.elections.html">elections</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#electionQuery">electionQuery()</a></code></p>
79<p class="firstline">List of available elections to query.</p>
80<p class="toc_element">
Jon Wayne Parrott2512a0c2016-08-29 10:21:22 -0700[diff] [blame]81 <code><a href="#voterInfoQuery">voterInfoQuery(address, electionId=None, returnAllAvailableData=None, officialOnly=None)</a></code></p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]82<p class="firstline">Looks up information relevant to a voter based on the voter's registered address.</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="electionQuery">electionQuery()</code>
86 <pre>List of available elections to query.
87
88Args:
89
90Returns:
91 An object of the form:
92
93 { # The list of elections available for this version of the API.
94 "kind": "civicinfo#electionsQueryResponse", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#electionsQueryResponse".
95 "elections": [ # A list of available elections
96 { # Information about the election that was queried.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]97 "ocdDivisionId": "A String", # The political division of the election. Represented as an OCD Division ID. Voters within these political jurisdictions are covered by this election. This is typically a state such as ocd-division/country:us/state:ca or for the midterms or general election the entire US (i.e. ocd-division/country:us).
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]98 "electionDay": "A String", # Day of the election in YYYY-MM-DD format.
99 "id": "A String", # The unique ID of this election.
100 "name": "A String", # A displayable name for the election.
101 },
102 ],
103 }</pre>
104</div>
105
106<div class="method">
Jon Wayne Parrott2512a0c2016-08-29 10:21:22 -0700[diff] [blame]107 <code class="details" id="voterInfoQuery">voterInfoQuery(address, electionId=None, returnAllAvailableData=None, officialOnly=None)</code>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]108 <pre>Looks up information relevant to a voter based on the voter's registered address.
109
110Args:
111 address: string, The registered address of the voter to look up. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]112 electionId: string, The unique ID of the election to look up. A list of election IDs can be obtained at https://www.googleapis.com/civicinfo/{version}/electionsIf no election ID is specified in the query and there is more than one election with data for the given voter, the additional elections are provided in the otherElections response field.
Jon Wayne Parrott2512a0c2016-08-29 10:21:22 -0700[diff] [blame]113 returnAllAvailableData: boolean, If set to true, the query will return the success codeand include any partial information when it is unable to determine a matching address or unable to determine the election for electionId=0 queries.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]114 officialOnly: boolean, If set to true, only data from official state sources will be returned.
115
116Returns:
117 An object of the form:
118
119 { # The result of a voter info lookup query.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]120 "earlyVoteSites": [ # Locations where the voter is eligible to vote early, prior to election day.
121 { # A location where a voter can vote. This may be an early vote site, an election day voting location, or a drop off location for a completed ballot.
122 "startDate": "A String", # The first date that this early vote site or drop off location may be used. This field is not populated for polling locations.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]123 "pollingHours": "A String", # A description of when this location is open.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]124 "endDate": "A String", # The last date that this early vote site or drop off location may be used. This field is not populated for polling locations.
125 "name": "A String", # The name of the early vote site or drop off location. This field is not populated for polling locations.
126 "notes": "A String", # Notes about this location (e.g. accessibility ramp or entrance to use).
127 "voterServices": "A String", # The services provided by this early vote site or drop off location. This field is not populated for polling locations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]128 "longitude": 3.14, # Longitude of the location, in degrees east of the Prime Meridian. Only some locations -- generally, ballot drop boxes for vote-by-mail elections -- will have this set; for others, use a geocoding service like the Google Maps API to resolve the address to a geographic point.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]129 "sources": [ # A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.
130 { # Contains information about the data source for the element containing it.
131 "official": True or False, # Whether this data comes from an official government source.
132 "name": "A String", # The name of the data source.
133 },
134 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]135 "address": { # A simple representation of an address. # The address of the location.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]136 "city": "A String", # The city or town for the address.
137 "zip": "A String", # The US Postal Zip Code of the address.
138 "line3": "A String", # The third line of the address, if needed.
139 "line2": "A String", # The second line the address, if needed.
140 "line1": "A String", # The street name and number of this address.
141 "locationName": "A String", # The name of the location.
142 "state": "A String", # The US two letter state abbreviation of the address.
143 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]144 "latitude": 3.14, # Latitude of the location, in degrees north of the equator. Only some locations -- generally, ballot drop boxes for vote-by-mail elections -- will have this set; for others, use a geocoding service like the Google Maps API to resolve the address to a geographic point.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]145 "id": "A String", # An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.
146 },
147 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]148 "dropOffLocations": [ # Locations where a voter is eligible to drop off a completed ballot. The voter must have received and completed a ballot prior to arriving at the location. The location may not have ballots available on the premises. These locations could be open on or before election day as indicated in the pollingHours field.
149 { # A location where a voter can vote. This may be an early vote site, an election day voting location, or a drop off location for a completed ballot.
150 "startDate": "A String", # The first date that this early vote site or drop off location may be used. This field is not populated for polling locations.
151 "pollingHours": "A String", # A description of when this location is open.
152 "endDate": "A String", # The last date that this early vote site or drop off location may be used. This field is not populated for polling locations.
153 "name": "A String", # The name of the early vote site or drop off location. This field is not populated for polling locations.
154 "notes": "A String", # Notes about this location (e.g. accessibility ramp or entrance to use).
155 "voterServices": "A String", # The services provided by this early vote site or drop off location. This field is not populated for polling locations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]156 "longitude": 3.14, # Longitude of the location, in degrees east of the Prime Meridian. Only some locations -- generally, ballot drop boxes for vote-by-mail elections -- will have this set; for others, use a geocoding service like the Google Maps API to resolve the address to a geographic point.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]157 "sources": [ # A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.
158 { # Contains information about the data source for the element containing it.
159 "official": True or False, # Whether this data comes from an official government source.
160 "name": "A String", # The name of the data source.
161 },
162 ],
163 "address": { # A simple representation of an address. # The address of the location.
164 "city": "A String", # The city or town for the address.
165 "zip": "A String", # The US Postal Zip Code of the address.
166 "line3": "A String", # The third line of the address, if needed.
167 "line2": "A String", # The second line the address, if needed.
168 "line1": "A String", # The street name and number of this address.
169 "locationName": "A String", # The name of the location.
170 "state": "A String", # The US two letter state abbreviation of the address.
171 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]172 "latitude": 3.14, # Latitude of the location, in degrees north of the equator. Only some locations -- generally, ballot drop boxes for vote-by-mail elections -- will have this set; for others, use a geocoding service like the Google Maps API to resolve the address to a geographic point.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]173 "id": "A String", # An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.
174 },
175 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]176 "otherElections": [ # When there are multiple elections for a voter address, the otherElections field is populated in the API response and there are two possibilities: 1. If the earliest election is not the intended election, specify the election ID of the desired election in a second API request using the electionId field. 2. If these elections occur on the same day, the API doesn?t return any polling location, contest, or election official information to ensure that an additional query is made. For user-facing applications, we recommend displaying these elections to the user to disambiguate. A second API request using the electionId field should be made for the election that is relevant to the user.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]177 { # Information about the election that was queried.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]178 "ocdDivisionId": "A String", # The political division of the election. Represented as an OCD Division ID. Voters within these political jurisdictions are covered by this election. This is typically a state such as ocd-division/country:us/state:ca or for the midterms or general election the entire US (i.e. ocd-division/country:us).
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]179 "electionDay": "A String", # Day of the election in YYYY-MM-DD format.
180 "id": "A String", # The unique ID of this election.
181 "name": "A String", # A displayable name for the election.
182 },
183 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]184 "segments": [
185 {
186 "targetsmartUniquePrecinctCode": "A String",
187 "stateSenateDistrict": "A String",
188 "precinctName": "A String",
189 "startLatE7": "A String",
190 "judicialDistrict": "A String",
191 "municipalDistrict": "A String",
192 "stateHouseDistrict": "A String",
193 "voterGeographicDivisionOcdIds": [
194 "A String",
195 ],
196 "cityCouncilDistrict": "A String",
197 "id": "A String",
198 "precinctOcdId": "A String",
199 "catalistUniquePrecinctCode": "A String",
200 "city": "A String",
201 "startHouseNumber": "A String",
202 "contestIds": [
203 "A String",
204 ],
205 "surrogateId": "A String",
206 "startLngE7": "A String",
207 "subAdministrativeAreaName": "A String",
208 "state": "A String",
209 "streetName": "A String",
210 "geocodedPoint": {
211 "lngE7": 42,
212 "temporaryData": {
213 "recordMessageSetExt": {
214 "numberOfTriples": "A String",
215 "isRecon": True or False,
216 "expId": "A String",
217 "subscriberReceiveMsec": "A String",
218 "shouldMonitorLatency": True or False,
219 "process": "A String",
220 "topicBuildFinishMsec": "A String",
221 "expInfo": {
222 "deletedIns": [
223 "A String",
224 ],
225 },
226 "priority": "A String",
227 "recordId": "A String",
228 "version": "A String",
229 "isWlmThrottled": True or False,
230 "topicBuildStartMsec": "A String",
231 "proxyReceiveMsec": "A String",
232 "dataSourcePublishMsec": "A String",
233 "proxySentMsec": "A String",
234 },
235 },
236 "latE7": 42,
237 "metadata": {
238 "internal": {
239 "isAuto": True or False,
240 "sourceSummary": {
241 "provider": "A String",
242 "dataset": "A String",
243 },
244 },
245 },
246 },
247 "congressionalDistrict": "A String",
248 "geographicDivisionOcdIds": [
249 "A String",
250 ],
251 "administrationRegionIds": [
252 "A String",
253 ],
254 "oddOrEvens": [
255 "A String",
256 ],
257 "mailOnly": True or False,
258 "earlyVoteSiteByIds": [
259 "A String",
260 ],
261 "pollinglocationByIds": [
262 "A String",
263 ],
264 "townshipDistrict": "A String",
265 "schoolDistrict": "A String",
266 "provenances": [
267 {
268 "collidedSegmentSource": {
269 "segments": [
270 # Object with schema name: StreetSegment
271 ],
272 },
273 "tsStreetSegmentId": "A String",
274 "vip5StreetSegmentId": "A String",
275 "precinctId": "A String",
276 "datasetId": "A String",
277 "ctclContestUuid": "A String",
278 "vip5PrecinctId": "A String",
279 "vipStreetSegmentId": "A String",
280 "precinctSplitId": "A String",
281 "ctclOfficeUuid": "A String",
282 },
283 ],
284 "countyCouncilDistrict": "A String",
285 "datasetId": "A String",
286 "endHouseNumber": "A String",
287 "beforeGeocodeId": "A String",
288 "countyFips": "A String",
289 "zip": "A String",
290 "originalId": "A String",
291 "unitType": "A String",
292 "vanPrecinctCode": "A String",
293 "unitNumber": "A String",
294 "wildcard": True or False,
295 "published": True or False,
296 "wardDistrict": "A String",
297 "ncoaAddress": "A String",
298 },
299 ],
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]300 "mailOnly": True or False, # Specifies whether voters in the precinct vote only by mailing their ballots (with the possible option of dropping off their ballots as well).
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]301 "kind": "civicinfo#voterInfoResponse", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#voterInfoResponse".
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]302 "normalizedInput": { # A simple representation of an address. # The normalized version of the requested address
303 "city": "A String", # The city or town for the address.
304 "zip": "A String", # The US Postal Zip Code of the address.
305 "line3": "A String", # The third line of the address, if needed.
306 "line2": "A String", # The second line the address, if needed.
307 "line1": "A String", # The street name and number of this address.
308 "locationName": "A String", # The name of the location.
309 "state": "A String", # The US two letter state abbreviation of the address.
310 },
311 "state": [ # Local Election Information for the state that the voter votes in. For the US, there will only be one element in this array.
312 { # Describes information about a regional election administrative area.
313 "local_jurisdiction": # Object with schema name: AdministrationRegion # The city or county that provides election information for this voter. This object can have the same elements as state.
314 "sources": [ # A list of sources for this area. If multiple sources are listed the data has been aggregated from those sources.
315 { # Contains information about the data source for the element containing it.
316 "official": True or False, # Whether this data comes from an official government source.
317 "name": "A String", # The name of the data source.
318 },
319 ],
320 "electionAdministrationBody": { # Information about an election administrative body (e.g. County Board of Elections). # The election administration body for this area.
321 "absenteeVotingInfoUrl": "A String", # A URL provided by this administrative body for information on absentee voting.
322 "votingLocationFinderUrl": "A String", # A URL provided by this administrative body for looking up where to vote.
323 "name": "A String", # The name of this election administrative body.
324 "electionRegistrationConfirmationUrl": "A String", # A URL provided by this administrative body for confirming that the voter is registered to vote.
325 "correspondenceAddress": { # A simple representation of an address. # The mailing address of this administrative body.
326 "city": "A String", # The city or town for the address.
327 "zip": "A String", # The US Postal Zip Code of the address.
328 "line3": "A String", # The third line of the address, if needed.
329 "line2": "A String", # The second line the address, if needed.
330 "line1": "A String", # The street name and number of this address.
331 "locationName": "A String", # The name of the location.
332 "state": "A String", # The US two letter state abbreviation of the address.
333 },
334 "electionRegistrationUrl": "A String", # A URL provided by this administrative body for looking up how to register to vote.
335 "electionOfficials": [ # The election officials for this election administrative body.
336 { # Information about individual election officials.
337 "title": "A String", # The title of the election official.
338 "emailAddress": "A String", # The email address of the election official.
339 "name": "A String", # The full name of the election official.
340 "officePhoneNumber": "A String", # The office phone number of the election official.
341 "faxNumber": "A String", # The fax number of the election official.
342 },
343 ],
344 "electionInfoUrl": "A String", # A URL provided by this administrative body for looking up general election information.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]345 "addressLines": [
346 "A String",
347 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]348 "voter_services": [ # A description of the services this administrative body may provide.
349 "A String",
350 ],
351 "ballotInfoUrl": "A String", # A URL provided by this administrative body to give contest information to the voter.
352 "hoursOfOperation": "A String", # A description of the hours of operation for this administrative body.
353 "physicalAddress": { # A simple representation of an address. # The physical address of this administrative body.
354 "city": "A String", # The city or town for the address.
355 "zip": "A String", # The US Postal Zip Code of the address.
356 "line3": "A String", # The third line of the address, if needed.
357 "line2": "A String", # The second line the address, if needed.
358 "line1": "A String", # The street name and number of this address.
359 "locationName": "A String", # The name of the location.
360 "state": "A String", # The US two letter state abbreviation of the address.
361 },
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]362 "electionRulesUrl": "A String", # A URL provided by this administrative body describing election rules to the voter.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]363 },
364 "name": "A String", # The name of the jurisdiction.
365 "id": "A String", # An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.
366 },
367 ],
368 "precinctId": "A String",
369 "election": { # Information about the election that was queried. # The election that was queried.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]370 "ocdDivisionId": "A String", # The political division of the election. Represented as an OCD Division ID. Voters within these political jurisdictions are covered by this election. This is typically a state such as ocd-division/country:us/state:ca or for the midterms or general election the entire US (i.e. ocd-division/country:us).
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]371 "electionDay": "A String", # Day of the election in YYYY-MM-DD format.
372 "id": "A String", # The unique ID of this election.
373 "name": "A String", # A displayable name for the election.
374 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]375 "pollingLocations": [ # Locations where the voter is eligible to vote on election day.
376 { # A location where a voter can vote. This may be an early vote site, an election day voting location, or a drop off location for a completed ballot.
377 "startDate": "A String", # The first date that this early vote site or drop off location may be used. This field is not populated for polling locations.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]378 "pollingHours": "A String", # A description of when this location is open.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]379 "endDate": "A String", # The last date that this early vote site or drop off location may be used. This field is not populated for polling locations.
380 "name": "A String", # The name of the early vote site or drop off location. This field is not populated for polling locations.
381 "notes": "A String", # Notes about this location (e.g. accessibility ramp or entrance to use).
382 "voterServices": "A String", # The services provided by this early vote site or drop off location. This field is not populated for polling locations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]383 "longitude": 3.14, # Longitude of the location, in degrees east of the Prime Meridian. Only some locations -- generally, ballot drop boxes for vote-by-mail elections -- will have this set; for others, use a geocoding service like the Google Maps API to resolve the address to a geographic point.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]384 "sources": [ # A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.
385 { # Contains information about the data source for the element containing it.
386 "official": True or False, # Whether this data comes from an official government source.
387 "name": "A String", # The name of the data source.
388 },
389 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]390 "address": { # A simple representation of an address. # The address of the location.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]391 "city": "A String", # The city or town for the address.
392 "zip": "A String", # The US Postal Zip Code of the address.
393 "line3": "A String", # The third line of the address, if needed.
394 "line2": "A String", # The second line the address, if needed.
395 "line1": "A String", # The street name and number of this address.
396 "locationName": "A String", # The name of the location.
397 "state": "A String", # The US two letter state abbreviation of the address.
398 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]399 "latitude": 3.14, # Latitude of the location, in degrees north of the equator. Only some locations -- generally, ballot drop boxes for vote-by-mail elections -- will have this set; for others, use a geocoding service like the Google Maps API to resolve the address to a geographic point.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]400 "id": "A String", # An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.
401 },
402 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]403 "contests": [ # Contests that will appear on the voter's ballot.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]404 { # Information about a contest that appears on a voter's ballot.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]405 "office": "A String", # The name of the office for this contest.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]406 "referendumBrief": "A String", # Specifies a short summary of the referendum that is typically on the ballot below the title but above the text. This field is only populated for contests of type 'Referendum'.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]407 "sources": [ # A list of sources for this contest. If multiple sources are listed, the data has been aggregated from those sources.
408 { # Contains information about the data source for the element containing it.
409 "official": True or False, # Whether this data comes from an official government source.
410 "name": "A String", # The name of the data source.
411 },
412 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]413 "primaryParty": "A String", # If this is a partisan election, the name of the party it is for.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]414 "electorateSpecifications": "A String", # A description of any additional eligibility requirements for voting in this contest.
415 "numberElected": "A String", # The number of candidates that will be elected to office in this contest.
416 "referendumUrl": "A String", # A link to the referendum. This field is only populated for contests of type 'Referendum'.
417 "referendumTitle": "A String", # The title of the referendum (e.g. 'Proposition 42'). This field is only populated for contests of type 'Referendum'.
418 "id": "A String", # An ID for this object. IDs may change in future requests and should not be cached. Access to this field requires special access that can be requested from the Request more link on the Quotas page.
419 "special": "A String", # "Yes" or "No" depending on whether this a contest being held outside the normal election cycle.
420 "referendumEffectOfAbstain": "A String", # Specifies what effect abstaining (not voting) on the proposition will have (i.e. whether abstaining is considered a vote against it). This field is only populated for contests of type 'Referendum'.
421 "district": { # Describes the geographic scope of a contest. # Information about the electoral district that this contest is in.
422 "scope": "A String", # The geographic scope of this district. If unspecified the district's geography is not known. One of: national, statewide, congressional, stateUpper, stateLower, countywide, judicial, schoolBoard, cityWide, township, countyCouncil, cityCouncil, ward, special
423 "id": "A String", # An identifier for this district, relative to its scope. For example, the 34th State Senate district would have id "34" and a scope of stateUpper.
424 "name": "A String", # The name of the district.
Jon Wayne Parrott2512a0c2016-08-29 10:21:22 -0700[diff] [blame]425 "kgForeignKey": "A String",
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]426 },
427 "ballotPlacement": "A String", # A number specifying the position of this contest on the voter's ballot.
428 "referendumProStatement": "A String", # A statement in favor of the referendum. It does not necessarily appear on the ballot. This field is only populated for contests of type 'Referendum'.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]429 "candidates": [ # The candidate choices for this contest.
430 { # Information about a candidate running for elected office.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]431 "name": "A String", # The candidate's name. If this is a joint ticket it will indicate the name of the candidate at the top of a ticket followed by a / and that name of candidate at the bottom of the ticket. e.g. "Mitt Romney / Paul Ryan"
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]432 "photoUrl": "A String", # A URL for a photo of the candidate.
433 "candidateUrl": "A String", # The URL for the candidate's campaign web site.
434 "channels": [ # A list of known (social) media channels for this candidate.
435 { # A social media or web channel for a candidate.
436 "type": "A String", # The type of channel. The following is a list of types of channels, but is not exhaustive. More channel types may be added at a later time. One of: GooglePlus, YouTube, Facebook, Twitter
437 "id": "A String", # The unique public identifier for the candidate's channel.
438 },
439 ],
440 "phone": "A String", # The voice phone number for the candidate's campaign office.
441 "orderOnBallot": "A String", # The order the candidate appears on the ballot for this contest.
442 "party": "A String", # The full name of the party the candidate is a member of.
443 "email": "A String", # The email address for the candidate's campaign.
444 },
445 ],
Jon Wayne Parrott2512a0c2016-08-29 10:21:22 -0700[diff] [blame]446 "type": "A String", # The type of contest. Usually this will be 'General', 'Primary', or 'Run-off' for contests with candidates. For referenda this will be 'Referendum'. For Retention contests this will typically be 'Retention'.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]447 "referendumText": "A String", # The full text of the referendum. This field is only populated for contests of type 'Referendum'.
448 "referendumConStatement": "A String", # A statement in opposition to the referendum. It does not necessarily appear on the ballot. This field is only populated for contests of type 'Referendum'.
449 "referendumPassageThreshold": "A String", # The threshold of votes that the referendum needs in order to pass, e.g. "two-thirds". This field is only populated for contests of type 'Referendum'.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]450 "ballotTitle": "A String", # The official title on the ballot for this contest, only where available.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]451 "numberVotingFor": "A String", # The number of candidates that a voter may vote for in this contest.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]452 "roles": [ # The roles which this office fulfills.
453 "A String",
454 ],
Jon Wayne Parrott2512a0c2016-08-29 10:21:22 -0700[diff] [blame]455 "referendumBallotResponses": [ # The set of ballot responses for the referendum. A ballot response represents a line on the ballot. Common examples might include "yes" or "no" for referenda. This field is only populated for contests of type 'Referendum'.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]456 "A String",
457 ],
458 "level": [ # The levels of government of the office for this contest. There may be more than one in cases where a jurisdiction effectively acts at two different levels of government; for example, the mayor of the District of Columbia acts at "locality" level, but also effectively at both "administrative-area-2" and "administrative-area-1".
459 "A String",
460 ],
461 "referendumSubtitle": "A String", # A brief description of the referendum. This field is only populated for contests of type 'Referendum'.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]462 },
463 ],
464 }</pre>
465</div>
466
467</body></html>