docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/civicinfo_v2.elections.html b/docs/dyn/civicinfo_v2.elections.html
index 00e8f42..c375fcf 100644
--- a/docs/dyn/civicinfo_v2.elections.html
+++ b/docs/dyn/civicinfo_v2.elections.html
@@ -81,7 +81,7 @@
<code><a href="#electionQuery">electionQuery(x__xgafv=None)</a></code></p>
<p class="firstline">List of available elections to query.</p>
<p class="toc_element">
- <code><a href="#voterInfoQuery">voterInfoQuery(address, electionId=None, officialOnly=None, returnAllAvailableData=None, x__xgafv=None)</a></code></p>
+ <code><a href="#voterInfoQuery">voterInfoQuery(address, returnAllAvailableData=None, electionId=None, officialOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Looks up information relevant to a voter based on the voter's registered address.</p>
<h3>Method Details</h3>
<div class="method">
@@ -103,27 +103,27 @@
An object of the form:
{ # The list of elections available for this version of the API.
+ "kind": "civicinfo#electionsQueryResponse", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#electionsQueryResponse".
"elections": [ # A list of available elections
{ # Information about the election that was queried.
- "name": "A String", # A displayable name for the election.
"id": "A String", # The unique ID of this election.
- "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).
"electionDay": "A String", # Day of the election in YYYY-MM-DD format.
+ "name": "A String", # A displayable name for the election.
+ "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).
},
],
- "kind": "civicinfo#electionsQueryResponse", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#electionsQueryResponse".
}</pre>
</div>
<div class="method">
- <code class="details" id="voterInfoQuery">voterInfoQuery(address, electionId=None, officialOnly=None, returnAllAvailableData=None, x__xgafv=None)</code>
+ <code class="details" id="voterInfoQuery">voterInfoQuery(address, returnAllAvailableData=None, electionId=None, officialOnly=None, x__xgafv=None)</code>
<pre>Looks up information relevant to a voter based on the voter's registered address.
Args:
address: string, The registered address of the voter to look up. (required)
+ 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.
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.
officialOnly: boolean, If set to true, only data from official state sources will be returned.
- 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -133,230 +133,230 @@
An object of the form:
{ # The result of a voter info lookup query.
- "kind": "civicinfo#voterInfoResponse", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#voterInfoResponse".
- "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).
- "pollingLocations": [ # Locations where the voter is eligible to vote on election day.
- { # 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.
- "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.
- "sources": [ # A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.
- { # Contains information about the data source for the element containing it.
- "name": "A String", # The name of the data source.
- "official": True or False, # Whether this data comes from an official government source.
- },
- ],
- "address": { # A simple representation of an address. # The address of the location.
- "state": "A String", # The US two letter state abbreviation of the address.
- "line3": "A String", # The third line of the address, if needed.
- "city": "A String", # The city or town for the address.
- "locationName": "A String", # The name of the location.
- "line2": "A String", # The second line the address, if needed.
- "zip": "A String", # The US Postal Zip Code of the address.
- "line1": "A String", # The street name and number of this address.
- },
- "voterServices": "A String", # The services provided by this early vote site or drop off location. This field is not populated for polling locations.
- "longitude": 3.14, # Longitude of the location, in degrees east of the Prime Meridian. Note this field may not be available for some locations.
- "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.
- "pollingHours": "A String", # A description of when this location is open.
- "name": "A String", # The name of the early vote site or drop off location. This field is not populated for polling locations.
- "notes": "A String", # Notes about this location (e.g. accessibility ramp or entrance to use).
- "latitude": 3.14, # Latitude of the location, in degrees north of the equator. Note this field may not be available for some locations.
- },
- ],
+ "normalizedInput": { # A simple representation of an address. # The normalized version of the requested address
+ "locationName": "A String", # The name of the location.
+ "line3": "A String", # The third line of the address, if needed.
+ "line1": "A String", # The street name and number of this address.
+ "zip": "A String", # The US Postal Zip Code of the address.
+ "line2": "A String", # The second line the address, if needed.
+ "state": "A String", # The US two letter state abbreviation of the address.
+ "city": "A String", # The city or town for the address.
+ },
+ "election": { # Information about the election that was queried. # The election that was queried.
+ "id": "A String", # The unique ID of this election.
+ "electionDay": "A String", # Day of the election in YYYY-MM-DD format.
+ "name": "A String", # A displayable name for the election.
+ "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).
+ },
+ "precinctId": "A String",
"earlyVoteSites": [ # Locations where the voter is eligible to vote early, prior to election day.
{ # 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.
+ "latitude": 3.14, # Latitude of the location, in degrees north of the equator. Note this field may not be available for some locations.
+ "voterServices": "A String", # The services provided by this early vote site or drop off location. This field is not populated for polling locations.
+ "notes": "A String", # Notes about this location (e.g. accessibility ramp or entrance to use).
+ "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.
+ "address": { # A simple representation of an address. # The address of the location.
+ "locationName": "A String", # The name of the location.
+ "line3": "A String", # The third line of the address, if needed.
+ "line1": "A String", # The street name and number of this address.
+ "zip": "A String", # The US Postal Zip Code of the address.
+ "line2": "A String", # The second line the address, if needed.
+ "state": "A String", # The US two letter state abbreviation of the address.
+ "city": "A String", # The city or town for the address.
+ },
"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.
"sources": [ # A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.
{ # Contains information about the data source for the element containing it.
- "name": "A String", # The name of the data source.
"official": True or False, # Whether this data comes from an official government source.
+ "name": "A String", # The name of the data source.
},
],
- "address": { # A simple representation of an address. # The address of the location.
- "state": "A String", # The US two letter state abbreviation of the address.
- "line3": "A String", # The third line of the address, if needed.
- "city": "A String", # The city or town for the address.
- "locationName": "A String", # The name of the location.
- "line2": "A String", # The second line the address, if needed.
- "zip": "A String", # The US Postal Zip Code of the address.
- "line1": "A String", # The street name and number of this address.
- },
- "voterServices": "A String", # The services provided by this early vote site or drop off location. This field is not populated for polling locations.
- "longitude": 3.14, # Longitude of the location, in degrees east of the Prime Meridian. Note this field may not be available for some locations.
- "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.
"pollingHours": "A String", # A description of when this location is open.
+ "longitude": 3.14, # Longitude of the location, in degrees east of the Prime Meridian. Note this field may not be available for some locations.
"name": "A String", # The name of the early vote site or drop off location. This field is not populated for polling locations.
- "notes": "A String", # Notes about this location (e.g. accessibility ramp or entrance to use).
- "latitude": 3.14, # Latitude of the location, in degrees north of the equator. Note this field may not be available for some locations.
- },
- ],
- "precinctId": "A String",
- "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.
- { # Information about the election that was queried.
- "name": "A String", # A displayable name for the election.
- "id": "A String", # The unique ID of this election.
- "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).
- "electionDay": "A String", # Day of the election in YYYY-MM-DD format.
- },
- ],
- "contests": [ # Contests that will appear on the voter's ballot.
- { # Information about a contest that appears on a voter's ballot.
- "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".
- "A String",
- ],
- "ballotTitle": "A String", # The official title on the ballot for this contest, only where available.
- "referendumUrl": "A String", # A link to the referendum. This field is only populated for contests of type 'Referendum'.
- "referendumTitle": "A String", # The title of the referendum (e.g. 'Proposition 42'). This field is only populated for contests of type 'Referendum'.
- "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'.
- "numberVotingFor": "A String", # The number of candidates that a voter may vote for in this contest.
- "primaryParties": [ # If this is a partisan election, the name of the party/parties it is for.
- "A String",
- ],
- "referendumText": "A String", # The full text of the referendum. This field is only populated for contests of type 'Referendum'.
- "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'.
- "roles": [ # The roles which this office fulfills.
- "A String",
- ],
- "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.
- "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'.
- "electorateSpecifications": "A String", # A description of any additional eligibility requirements for voting in this contest.
- "ballotPlacement": "A String", # A number specifying the position of this contest on the voter's ballot.
- "district": { # Describes the geographic scope of a contest. # Information about the electoral district that this contest is in.
- "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.
- "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
- "name": "A String", # The name of the district.
- },
- "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'.
- "A String",
- ],
- "sources": [ # A list of sources for this contest. If multiple sources are listed, the data has been aggregated from those sources.
- { # Contains information about the data source for the element containing it.
- "name": "A String", # The name of the data source.
- "official": True or False, # Whether this data comes from an official government source.
- },
- ],
- "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'.
- "office": "A String", # The name of the office for this contest.
- "numberElected": "A String", # The number of candidates that will be elected to office in this contest.
- "candidates": [ # The candidate choices for this contest.
- { # Information about a candidate running for elected office.
- "photoUrl": "A String", # A URL for a photo of the candidate.
- "phone": "A String", # The voice phone number for the candidate's campaign office.
- "orderOnBallot": "A String", # The order the candidate appears on the ballot for this contest.
- "candidateUrl": "A String", # The URL for the candidate's campaign web site.
- "channels": [ # A list of known (social) media channels for this candidate.
- { # A social media or web channel for a candidate.
- "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
- "id": "A String", # The unique public identifier for the candidate's channel.
- },
- ],
- "email": "A String", # The email address for the candidate's campaign.
- "party": "A String", # The full name of the party the candidate is a member of.
- "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"
- },
- ],
- "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'.
- "referendumSubtitle": "A String", # A brief description of the referendum. This field is only populated for contests of type 'Referendum'.
- "special": "A String", # "Yes" or "No" depending on whether this a contest being held outside the normal election cycle.
- "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'.
},
],
"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.
{ # 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.
+ "latitude": 3.14, # Latitude of the location, in degrees north of the equator. Note this field may not be available for some locations.
+ "voterServices": "A String", # The services provided by this early vote site or drop off location. This field is not populated for polling locations.
+ "notes": "A String", # Notes about this location (e.g. accessibility ramp or entrance to use).
+ "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.
+ "address": { # A simple representation of an address. # The address of the location.
+ "locationName": "A String", # The name of the location.
+ "line3": "A String", # The third line of the address, if needed.
+ "line1": "A String", # The street name and number of this address.
+ "zip": "A String", # The US Postal Zip Code of the address.
+ "line2": "A String", # The second line the address, if needed.
+ "state": "A String", # The US two letter state abbreviation of the address.
+ "city": "A String", # The city or town for the address.
+ },
"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.
"sources": [ # A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.
{ # Contains information about the data source for the element containing it.
- "name": "A String", # The name of the data source.
"official": True or False, # Whether this data comes from an official government source.
+ "name": "A String", # The name of the data source.
},
],
- "address": { # A simple representation of an address. # The address of the location.
- "state": "A String", # The US two letter state abbreviation of the address.
- "line3": "A String", # The third line of the address, if needed.
- "city": "A String", # The city or town for the address.
- "locationName": "A String", # The name of the location.
- "line2": "A String", # The second line the address, if needed.
- "zip": "A String", # The US Postal Zip Code of the address.
- "line1": "A String", # The street name and number of this address.
- },
- "voterServices": "A String", # The services provided by this early vote site or drop off location. This field is not populated for polling locations.
- "longitude": 3.14, # Longitude of the location, in degrees east of the Prime Meridian. Note this field may not be available for some locations.
- "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.
"pollingHours": "A String", # A description of when this location is open.
+ "longitude": 3.14, # Longitude of the location, in degrees east of the Prime Meridian. Note this field may not be available for some locations.
"name": "A String", # The name of the early vote site or drop off location. This field is not populated for polling locations.
- "notes": "A String", # Notes about this location (e.g. accessibility ramp or entrance to use).
- "latitude": 3.14, # Latitude of the location, in degrees north of the equator. Note this field may not be available for some locations.
},
],
+ "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.
+ { # Information about the election that was queried.
+ "id": "A String", # The unique ID of this election.
+ "electionDay": "A String", # Day of the election in YYYY-MM-DD format.
+ "name": "A String", # A displayable name for the election.
+ "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).
+ },
+ ],
+ "pollingLocations": [ # Locations where the voter is eligible to vote on election day.
+ { # 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.
+ "latitude": 3.14, # Latitude of the location, in degrees north of the equator. Note this field may not be available for some locations.
+ "voterServices": "A String", # The services provided by this early vote site or drop off location. This field is not populated for polling locations.
+ "notes": "A String", # Notes about this location (e.g. accessibility ramp or entrance to use).
+ "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.
+ "address": { # A simple representation of an address. # The address of the location.
+ "locationName": "A String", # The name of the location.
+ "line3": "A String", # The third line of the address, if needed.
+ "line1": "A String", # The street name and number of this address.
+ "zip": "A String", # The US Postal Zip Code of the address.
+ "line2": "A String", # The second line the address, if needed.
+ "state": "A String", # The US two letter state abbreviation of the address.
+ "city": "A String", # The city or town for the address.
+ },
+ "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.
+ "sources": [ # A list of sources for this location. If multiple sources are listed the data has been aggregated from those sources.
+ { # Contains information about the data source for the element containing it.
+ "official": True or False, # Whether this data comes from an official government source.
+ "name": "A String", # The name of the data source.
+ },
+ ],
+ "pollingHours": "A String", # A description of when this location is open.
+ "longitude": 3.14, # Longitude of the location, in degrees east of the Prime Meridian. Note this field may not be available for some locations.
+ "name": "A String", # The name of the early vote site or drop off location. This field is not populated for polling locations.
+ },
+ ],
+ "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).
"state": [ # Local Election Information for the state that the voter votes in. For the US, there will only be one element in this array.
{ # Describes information about a regional election administrative area.
"electionAdministrationBody": { # Information about an election administrative body (e.g. County Board of Elections). # The election administration body for this area.
- "votingLocationFinderUrl": "A String", # A URL provided by this administrative body for looking up where to vote.
- "electionInfoUrl": "A String", # A URL provided by this administrative body for looking up general election information.
- "electionRegistrationConfirmationUrl": "A String", # A URL provided by this administrative body for confirming that the voter is registered to vote.
"name": "A String", # The name of this election administrative body.
- "electionOfficials": [ # The election officials for this election administrative body.
- { # Information about individual election officials.
- "officePhoneNumber": "A String", # The office phone number of the election official.
- "name": "A String", # The full name of the election official.
- "emailAddress": "A String", # The email address of the election official.
- "title": "A String", # The title of the election official.
- "faxNumber": "A String", # The fax number of the election official.
- },
- ],
- "electionRegistrationUrl": "A String", # A URL provided by this administrative body for looking up how to register to vote.
- "electionNoticeUrl": "A String", # A URL provided by this administrative body for additional information related to the last minute or emergency notification.
"electionNoticeText": "A String", # A last minute or emergency notification text provided by this administrative body.
- "ballotInfoUrl": "A String", # A URL provided by this administrative body to give contest information to the voter.
- "electionRulesUrl": "A String", # A URL provided by this administrative body describing election rules to the voter.
"physicalAddress": { # A simple representation of an address. # The physical address of this administrative body.
- "state": "A String", # The US two letter state abbreviation of the address.
- "line3": "A String", # The third line of the address, if needed.
- "city": "A String", # The city or town for the address.
"locationName": "A String", # The name of the location.
- "line2": "A String", # The second line the address, if needed.
- "zip": "A String", # The US Postal Zip Code of the address.
+ "line3": "A String", # The third line of the address, if needed.
"line1": "A String", # The street name and number of this address.
+ "zip": "A String", # The US Postal Zip Code of the address.
+ "line2": "A String", # The second line the address, if needed.
+ "state": "A String", # The US two letter state abbreviation of the address.
+ "city": "A String", # The city or town for the address.
},
+ "electionInfoUrl": "A String", # A URL provided by this administrative body for looking up general election information.
"voter_services": [ # A description of the services this administrative body may provide.
"A String",
],
- "absenteeVotingInfoUrl": "A String", # A URL provided by this administrative body for information on absentee voting.
- "hoursOfOperation": "A String", # A description of the hours of operation for this administrative body.
"correspondenceAddress": { # A simple representation of an address. # The mailing address of this administrative body.
- "state": "A String", # The US two letter state abbreviation of the address.
- "line3": "A String", # The third line of the address, if needed.
- "city": "A String", # The city or town for the address.
"locationName": "A String", # The name of the location.
- "line2": "A String", # The second line the address, if needed.
- "zip": "A String", # The US Postal Zip Code of the address.
+ "line3": "A String", # The third line of the address, if needed.
"line1": "A String", # The street name and number of this address.
+ "zip": "A String", # The US Postal Zip Code of the address.
+ "line2": "A String", # The second line the address, if needed.
+ "state": "A String", # The US two letter state abbreviation of the address.
+ "city": "A String", # The city or town for the address.
},
+ "absenteeVotingInfoUrl": "A String", # A URL provided by this administrative body for information on absentee voting.
+ "electionNoticeUrl": "A String", # A URL provided by this administrative body for additional information related to the last minute or emergency notification.
+ "electionRegistrationUrl": "A String", # A URL provided by this administrative body for looking up how to register to vote.
+ "electionRulesUrl": "A String", # A URL provided by this administrative body describing election rules to the voter.
+ "votingLocationFinderUrl": "A String", # A URL provided by this administrative body for looking up where to vote.
+ "electionRegistrationConfirmationUrl": "A String", # A URL provided by this administrative body for confirming that the voter is registered to vote.
+ "electionOfficials": [ # The election officials for this election administrative body.
+ { # Information about individual election officials.
+ "emailAddress": "A String", # The email address of the election official.
+ "title": "A String", # The title of the election official.
+ "faxNumber": "A String", # The fax number of the election official.
+ "officePhoneNumber": "A String", # The office phone number of the election official.
+ "name": "A String", # The full name of the election official.
+ },
+ ],
+ "hoursOfOperation": "A String", # A description of the hours of operation for this administrative body.
+ "ballotInfoUrl": "A String", # A URL provided by this administrative body to give contest information to the voter.
},
- "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.
"sources": [ # A list of sources for this area. If multiple sources are listed the data has been aggregated from those sources.
{ # Contains information about the data source for the element containing it.
- "name": "A String", # The name of the data source.
"official": True or False, # Whether this data comes from an official government source.
+ "name": "A String", # The name of the data source.
},
],
+ "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.
"name": "A String", # The name of the jurisdiction.
},
],
- "election": { # Information about the election that was queried. # The election that was queried.
- "name": "A String", # A displayable name for the election.
- "id": "A String", # The unique ID of this election.
- "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).
- "electionDay": "A String", # Day of the election in YYYY-MM-DD format.
- },
- "normalizedInput": { # A simple representation of an address. # The normalized version of the requested address
- "state": "A String", # The US two letter state abbreviation of the address.
- "line3": "A String", # The third line of the address, if needed.
- "city": "A String", # The city or town for the address.
- "locationName": "A String", # The name of the location.
- "line2": "A String", # The second line the address, if needed.
- "zip": "A String", # The US Postal Zip Code of the address.
- "line1": "A String", # The street name and number of this address.
- },
+ "kind": "civicinfo#voterInfoResponse", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#voterInfoResponse".
+ "contests": [ # Contests that will appear on the voter's ballot.
+ { # Information about a contest that appears on a voter's ballot.
+ "referendumSubtitle": "A String", # A brief description of the referendum. This field is only populated for contests of type 'Referendum'.
+ "sources": [ # A list of sources for this contest. If multiple sources are listed, the data has been aggregated from those sources.
+ { # Contains information about the data source for the element containing it.
+ "official": True or False, # Whether this data comes from an official government source.
+ "name": "A String", # The name of the data source.
+ },
+ ],
+ "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'.
+ "roles": [ # The roles which this office fulfills.
+ "A String",
+ ],
+ "numberVotingFor": "A String", # The number of candidates that a voter may vote for in this contest.
+ "ballotPlacement": "A String", # A number specifying the position of this contest on the voter's ballot.
+ "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'.
+ "district": { # Describes the geographic scope of a contest. # Information about the electoral district that this contest is in.
+ "name": "A String", # The name of the district.
+ "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.
+ "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
+ },
+ "special": "A String", # "Yes" or "No" depending on whether this a contest being held outside the normal election cycle.
+ "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'.
+ "primaryParties": [ # If this is a partisan election, the name of the party/parties it is for.
+ "A String",
+ ],
+ "office": "A String", # The name of the office for this contest.
+ "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'.
+ "ballotTitle": "A String", # The official title on the ballot for this contest, only where available.
+ "referendumTitle": "A String", # The title of the referendum (e.g. 'Proposition 42'). This field is only populated for contests of type 'Referendum'.
+ "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'.
+ "A String",
+ ],
+ "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.
+ "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'.
+ "electorateSpecifications": "A String", # A description of any additional eligibility requirements for voting in this contest.
+ "candidates": [ # The candidate choices for this contest.
+ { # Information about a candidate running for elected office.
+ "phone": "A String", # The voice phone number for the candidate's campaign office.
+ "email": "A String", # The email address for the candidate's campaign.
+ "party": "A String", # The full name of the party the candidate is a member of.
+ "candidateUrl": "A String", # The URL for the candidate's campaign web site.
+ "orderOnBallot": "A String", # The order the candidate appears on the ballot for this contest.
+ "photoUrl": "A String", # A URL for a photo of the candidate.
+ "channels": [ # A list of known (social) media channels for this candidate.
+ { # A social media or web channel for a candidate.
+ "id": "A String", # The unique public identifier for the candidate's channel.
+ "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
+ },
+ ],
+ "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"
+ },
+ ],
+ "referendumText": "A String", # The full text of the referendum. This field is only populated for contests of type 'Referendum'.
+ "referendumUrl": "A String", # A link to the referendum. This field is only populated for contests of type 'Referendum'.
+ "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".
+ "A String",
+ ],
+ "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'.
+ "numberElected": "A String", # The number of candidates that will be elected to office in this contest.
+ },
+ ],
}</pre>
</div>