Blame - docs/dyn/civicinfo_v2.elections.html - platform/external/python/google-api-python-client

2014-10-15 10:26:14 -0700

[diff] [blame]

85

<p class="firstline">Looks up information relevant to a voter based on the voter's registered address.</p>

86

<h3>Method Details</h3>

87

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

88

<code class="details" id="close">close()</code>

89

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

93

<code class="details" id="electionQuery">electionQuery(x__xgafv=None)</code>

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

94

<pre>List of available elections to query.

95

96

Args:

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

97

x__xgafv: string, V1 error format.

98

Allowed values

99

1 - v1 error format

100

2 - v2 error format

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

101

102

Returns:

103

An object of the form:

104

105

{ # The list of elections available for this version of the API.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

106

"kind": "civicinfo#electionsQueryResponse", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#electionsQueryResponse".

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

107

"elections": [ # A list of available elections

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

108

{ # Information about the election that was queried.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

109

"id": "A String", # The unique ID of this election.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

110

"electionDay": "A String", # Day of the election in YYYY-MM-DD format.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

111

"name": "A String", # A displayable name for the election.

112

"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 Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

},

],

}</pre>

</div>

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

119

<code class="details" id="voterInfoQuery">voterInfoQuery(address, returnAllAvailableData=None, electionId=None, officialOnly=None, x__xgafv=None)</code>

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

120

<pre>Looks up information relevant to a voter based on the voter's registered address.

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

121

122

Args:

123

address: string, The registered address of the voter to look up. (required)

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

124

returnAllAvailableData: boolean, If set to true, the query will return the success code and include any partial information when it is unable to determine a matching address or unable to determine the election for electionId=0 queries.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

125

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}/elections. If 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.

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

126

officialOnly: boolean, If set to true, only data from official state sources will be returned.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame]

127

x__xgafv: string, V1 error format.

128

Allowed values

129

1 - v1 error format

130

2 - v2 error format

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

131

132

Returns:

133

An object of the form:

134

135

{ # The result of a voter info lookup query.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

136

"normalizedInput": { # A simple representation of an address. # The normalized version of the requested address

137

"locationName": "A String", # The name of the location.

138

"line3": "A String", # The third line of the address, if needed.

139

"line1": "A String", # The street name and number of this address.

140

"zip": "A String", # The US Postal Zip Code of the address.

141

"line2": "A String", # The second line the address, if needed.

142

"state": "A String", # The US two letter state abbreviation of the address.

143

"city": "A String", # The city or town for the address.

144

},

145

"election": { # Information about the election that was queried. # The election that was queried.

146

"id": "A String", # The unique ID of this election.

147

"electionDay": "A String", # Day of the election in YYYY-MM-DD format.

148

"name": "A String", # A displayable name for the election.

149

"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).

150

},

151

"precinctId": "A String",

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

152

"earlyVoteSites": [ # Locations where the voter is eligible to vote early, prior to election day.

153

{ # 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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

154

"latitude": 3.14, # Latitude of the location, in degrees north of the equator. Note this field may not be available for some locations.

155

"voterServices": "A String", # The services provided by this early vote site or drop off location. This field is not populated for polling locations.

156

"notes": "A String", # Notes about this location (e.g. accessibility ramp or entrance to use).

157

"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.

158

"address": { # A simple representation of an address. # The address of the location.

159

"locationName": "A String", # The name of the location.

160

"line3": "A String", # The third line of the address, if needed.

161

"line1": "A String", # The street name and number of this address.

162

"zip": "A String", # The US Postal Zip Code of the address.

163

"line2": "A String", # The second line the address, if needed.

164

"state": "A String", # The US two letter state abbreviation of the address.

165

"city": "A String", # The city or town for the address.

166

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

167

"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.

168

"sources": [ # A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.

169

{ # Contains information about the data source for the element containing it.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

170

"official": True or False, # Whether this data comes from an official government source.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

171

"name": "A String", # The name of the data source.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

172

},

173

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

174

"pollingHours": "A String", # A description of when this location is open.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

175

"longitude": 3.14, # Longitude of the location, in degrees east of the Prime Meridian. Note this field may not be available for some locations.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

176

"name": "A String", # The name of the early vote site or drop off location. This field is not populated for polling locations.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

177

},

178

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

179

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

180

{ # 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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

181

"latitude": 3.14, # Latitude of the location, in degrees north of the equator. Note this field may not be available for some locations.

182

"voterServices": "A String", # The services provided by this early vote site or drop off location. This field is not populated for polling locations.

183

"notes": "A String", # Notes about this location (e.g. accessibility ramp or entrance to use).

184

"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.

185

"address": { # A simple representation of an address. # The address of the location.

186

"locationName": "A String", # The name of the location.

187

"line3": "A String", # The third line of the address, if needed.

188

"line1": "A String", # The street name and number of this address.

189

"zip": "A String", # The US Postal Zip Code of the address.

190

"line2": "A String", # The second line the address, if needed.

191

"state": "A String", # The US two letter state abbreviation of the address.

192

"city": "A String", # The city or town for the address.

193

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

194

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

195

"sources": [ # A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.

196

{ # Contains information about the data source for the element containing it.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

197

"official": True or False, # Whether this data comes from an official government source.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

198

"name": "A String", # The name of the data source.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

199

},

200

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

201

"pollingHours": "A String", # A description of when this location is open.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

202

"longitude": 3.14, # Longitude of the location, in degrees east of the Prime Meridian. Note this field may not be available for some locations.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

203

"name": "A String", # The name of the early vote site or drop off location. This field is not populated for polling locations.

Craig Citro

2014-10-15 10:26:14 -0700

[diff] [blame]

204

},

205

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

206

"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.

207

{ # Information about the election that was queried.

208

"id": "A String", # The unique ID of this election.

209

"electionDay": "A String", # Day of the election in YYYY-MM-DD format.

210

"name": "A String", # A displayable name for the election.

211

"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).

212

},

213

],

214

"pollingLocations": [ # Locations where the voter is eligible to vote on election day.

215

{ # 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.

216

"latitude": 3.14, # Latitude of the location, in degrees north of the equator. Note this field may not be available for some locations.

217

"voterServices": "A String", # The services provided by this early vote site or drop off location. This field is not populated for polling locations.

218

"notes": "A String", # Notes about this location (e.g. accessibility ramp or entrance to use).

219

"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.

220

"address": { # A simple representation of an address. # The address of the location.

221

"locationName": "A String", # The name of the location.

222

"line3": "A String", # The third line of the address, if needed.

223

"line1": "A String", # The street name and number of this address.

224

"zip": "A String", # The US Postal Zip Code of the address.

225

"line2": "A String", # The second line the address, if needed.

226

"state": "A String", # The US two letter state abbreviation of the address.

227

"city": "A String", # The city or town for the address.

228

},

229

"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.

230

"sources": [ # A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.

231

{ # Contains information about the data source for the element containing it.

232

"official": True or False, # Whether this data comes from an official government source.

233

"name": "A String", # The name of the data source.

234

},

235

],

236

"pollingHours": "A String", # A description of when this location is open.

237

"longitude": 3.14, # Longitude of the location, in degrees east of the Prime Meridian. Note this field may not be available for some locations.

238

"name": "A String", # The name of the early vote site or drop off location. This field is not populated for polling locations.

239

},

240

],

241

"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).

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

242

"state": [ # Local Election Information for the state that the voter votes in. For the US, there will only be one element in this array.

243

{ # Describes information about a regional election administrative area.

244

"electionAdministrationBody": { # Information about an election administrative body (e.g. County Board of Elections). # The election administration body for this area.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

245

"name": "A String", # The name of this election administrative body.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

246

"electionNoticeText": "A String", # A last minute or emergency notification text provided by this administrative body.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

247

"physicalAddress": { # A simple representation of an address. # The physical address of this administrative body.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

248

"locationName": "A String", # The name of the location.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

249

"line3": "A String", # The third line of the address, if needed.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

250

"line1": "A String", # The street name and number of this address.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

251

"zip": "A String", # The US Postal Zip Code of the address.

252

"line2": "A String", # The second line the address, if needed.

253

"state": "A String", # The US two letter state abbreviation of the address.

254

"city": "A String", # The city or town for the address.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

255

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

256

"electionInfoUrl": "A String", # A URL provided by this administrative body for looking up general election information.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

257

"voter_services": [ # A description of the services this administrative body may provide.

258

"A String",

259

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

260

"correspondenceAddress": { # A simple representation of an address. # The mailing address of this administrative body.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

261

"locationName": "A String", # The name of the location.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

262

"line3": "A String", # The third line of the address, if needed.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

263

"line1": "A String", # The street name and number of this address.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

264

"zip": "A String", # The US Postal Zip Code of the address.

265

"line2": "A String", # The second line the address, if needed.

266

"state": "A String", # The US two letter state abbreviation of the address.

267

"city": "A String", # The city or town for the address.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

268

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

269

"absenteeVotingInfoUrl": "A String", # A URL provided by this administrative body for information on absentee voting.

270

"electionNoticeUrl": "A String", # A URL provided by this administrative body for additional information related to the last minute or emergency notification.

271

"electionRegistrationUrl": "A String", # A URL provided by this administrative body for looking up how to register to vote.

272

"electionRulesUrl": "A String", # A URL provided by this administrative body describing election rules to the voter.

273

"votingLocationFinderUrl": "A String", # A URL provided by this administrative body for looking up where to vote.

274

"electionRegistrationConfirmationUrl": "A String", # A URL provided by this administrative body for confirming that the voter is registered to vote.

275

"electionOfficials": [ # The election officials for this election administrative body.

276

{ # Information about individual election officials.

277

"emailAddress": "A String", # The email address of the election official.

278

"title": "A String", # The title of the election official.

279

"faxNumber": "A String", # The fax number of the election official.

280

"officePhoneNumber": "A String", # The office phone number of the election official.

281

"name": "A String", # The full name of the election official.

282

},

283

],

284

"hoursOfOperation": "A String", # A description of the hours of operation for this administrative body.

285

"ballotInfoUrl": "A String", # A URL provided by this administrative body to give contest information to the voter.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

286

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

287

"sources": [ # A list of sources for this area. If multiple sources are listed the data has been aggregated from those sources.

288

{ # Contains information about the data source for the element containing it.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

289

"official": True or False, # Whether this data comes from an official government source.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

290

"name": "A String", # The name of the data source.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

291

},

292

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

293

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

294

"name": "A String", # The name of the jurisdiction.

295

},

296

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

297

"kind": "civicinfo#voterInfoResponse", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#voterInfoResponse".

298

"contests": [ # Contests that will appear on the voter's ballot.

299

{ # Information about a contest that appears on a voter's ballot.

300

"referendumSubtitle": "A String", # A brief description of the referendum. This field is only populated for contests of type 'Referendum'.

301

"sources": [ # A list of sources for this contest. If multiple sources are listed, the data has been aggregated from those sources.

302

{ # Contains information about the data source for the element containing it.

303

"official": True or False, # Whether this data comes from an official government source.

304

"name": "A String", # The name of the data source.

305

},

306

],

307

"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'.

308

"roles": [ # The roles which this office fulfills.

309

"A String",

310

],

311

"numberVotingFor": "A String", # The number of candidates that a voter may vote for in this contest.

312

"ballotPlacement": "A String", # A number specifying the position of this contest on the voter's ballot.

313

"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'.

314

"district": { # Describes the geographic scope of a contest. # Information about the electoral district that this contest is in.

315

"name": "A String", # The name of the district.

316

"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.

317

"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

318

},

319

"special": "A String", # "Yes" or "No" depending on whether this a contest being held outside the normal election cycle.

320

"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'.

321

"primaryParties": [ # If this is a partisan election, the name of the party/parties it is for.

322

"A String",

323

],

324

"office": "A String", # The name of the office for this contest.

325

"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'.

326

"ballotTitle": "A String", # The official title on the ballot for this contest, only where available.

327

"referendumTitle": "A String", # The title of the referendum (e.g. 'Proposition 42'). This field is only populated for contests of type 'Referendum'.

328

"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'.

329

"A String",

330

],

331

"primaryParty": "A String", # [DEPRECATED] If this is a partisan election, the name of the party it is for. This field as deprecated in favor of the array "primaryParties", as contests may contain more than one party.

332

"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'.

333

"electorateSpecifications": "A String", # A description of any additional eligibility requirements for voting in this contest.

334

"candidates": [ # The candidate choices for this contest.

335

{ # Information about a candidate running for elected office.

336

"phone": "A String", # The voice phone number for the candidate's campaign office.

337

"email": "A String", # The email address for the candidate's campaign.

338

"party": "A String", # The full name of the party the candidate is a member of.

339

"candidateUrl": "A String", # The URL for the candidate's campaign web site.

340

"orderOnBallot": "A String", # The order the candidate appears on the ballot for this contest.

341

"photoUrl": "A String", # A URL for a photo of the candidate.

342

"channels": [ # A list of known (social) media channels for this candidate.

343

{ # A social media or web channel for a candidate.

344

"id": "A String", # The unique public identifier for the candidate's channel.

345

"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

346

},

347

],

348

"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"

349

},

350

],

351

"referendumText": "A String", # The full text of the referendum. This field is only populated for contests of type 'Referendum'.

352

"referendumUrl": "A String", # A link to the referendum. This field is only populated for contests of type 'Referendum'.

353

"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".

354

"A String",

355

],

356

"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'.

357

"numberElected": "A String", # The number of candidates that will be elected to office in this contest.

358

},

359

],

Craig Citro