Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c2228be4630e279e02a25b51566a0f93b67aa499 / . / docs / dyn / civicinfo_v2.representatives.html
blob: d2e795fb56e3d45230309ee7b332f63689d6349a [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.representatives.html">representatives</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]81 <code><a href="#representativeInfoByAddress">representativeInfoByAddress(address=None, includeOffices=None, levels=None, roles=None, x__xgafv=None)</a></code></p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]82<p class="firstline">Looks up political geography and representative information for a single address.</p>
83<p class="toc_element">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]84 <code><a href="#representativeInfoByDivision">representativeInfoByDivision(ocdId, roles=None, recursive=None, levels=None, x__xgafv=None)</a></code></p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]85<p class="firstline">Looks up representative information for a single geographic division.</p>
86<h3>Method Details</h3>
87<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]93 <code class="details" id="representativeInfoByAddress">representativeInfoByAddress(address=None, includeOffices=None, levels=None, roles=None, x__xgafv=None)</code>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]94 <pre>Looks up political geography and representative information for a single address.
95
96Args:
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]97 address: string, The address to look up. May only be specified if the field ocdId is not given in the URL
98 includeOffices: boolean, Whether to return information about offices and officials. If false, only the top-level district information will be returned.
99 levels: string, A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don&#x27;t contain a matching office will not be returned. (repeated)
100 Allowed values
101 international -
102 country -
103 administrativeArea1 -
104 regional -
105 administrativeArea2 -
106 locality -
107 subLocality1 -
108 subLocality2 -
109 special -
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]110 roles: string, A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don&#x27;t contain a matching office will not be returned. (repeated)
111 Allowed values
112 headOfState -
113 headOfGovernment -
114 deputyHeadOfGovernment -
115 governmentOfficer -
116 executiveCouncil -
117 legislatorUpperBody -
118 legislatorLowerBody -
119 highestCourtJudge -
120 judge -
121 schoolBoard -
122 specialPurposeOfficer -
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]123 x__xgafv: string, V1 error format.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]124 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]125 1 - v1 error format
126 2 - v2 error format
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]127
128Returns:
129 An object of the form:
130
131 { # The result of a representative info lookup query.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]132 &quot;normalizedInput&quot;: { # A simple representation of an address. # The normalized version of the requested address
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]133 &quot;locationName&quot;: &quot;A String&quot;, # The name of the location.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]134 &quot;line3&quot;: &quot;A String&quot;, # The third line of the address, if needed.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]135 &quot;line1&quot;: &quot;A String&quot;, # The street name and number of this address.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]136 &quot;zip&quot;: &quot;A String&quot;, # The US Postal Zip Code of the address.
137 &quot;line2&quot;: &quot;A String&quot;, # The second line the address, if needed.
138 &quot;state&quot;: &quot;A String&quot;, # The US two letter state abbreviation of the address.
139 &quot;city&quot;: &quot;A String&quot;, # The city or town for the address.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]140 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]141 &quot;divisions&quot;: { # A map of political geographic divisions that contain the requested address, keyed by the unique Open Civic Data identifier for this division.
142 &quot;a_key&quot;: { # Describes a political geography.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]143 &quot;officeIndices&quot;: [ # List of indices in the offices array, one for each office elected from this division. Will only be present if includeOffices was true (or absent) in the request.
144 42,
145 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]146 &quot;alsoKnownAs&quot;: [ # Any other valid OCD IDs that refer to the same division.\n\nBecause OCD IDs are meant to be human-readable and at least somewhat predictable, there are occasionally several identifiers for a single division. These identifiers are defined to be equivalent to one another, and one is always indicated as the primary identifier. The primary identifier will be returned in ocd_id above, and any other equivalent valid identifiers will be returned in this list.\n\nFor example, if this division&#x27;s OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc.
147 &quot;A String&quot;,
148 ],
149 &quot;name&quot;: &quot;A String&quot;, # The name of the division.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]150 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]151 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]152 &quot;kind&quot;: &quot;civicinfo#representativeInfoResponse&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;civicinfo#representativeInfoResponse&quot;.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]153 &quot;officials&quot;: [ # Officials holding the offices listed above. Will only be present if includeOffices was true in the request.
154 { # Information about a person holding an elected office.
155 &quot;channels&quot;: [ # A list of known (social) media channels for this official.
156 { # A social media or web channel for a candidate.
157 &quot;id&quot;: &quot;A String&quot;, # The unique public identifier for the candidate&#x27;s channel.
158 &quot;type&quot;: &quot;A String&quot;, # 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
159 },
160 ],
161 &quot;address&quot;: [ # Addresses at which to contact the official.
162 { # A simple representation of an address.
163 &quot;locationName&quot;: &quot;A String&quot;, # The name of the location.
164 &quot;line3&quot;: &quot;A String&quot;, # The third line of the address, if needed.
165 &quot;line1&quot;: &quot;A String&quot;, # The street name and number of this address.
166 &quot;zip&quot;: &quot;A String&quot;, # The US Postal Zip Code of the address.
167 &quot;line2&quot;: &quot;A String&quot;, # The second line the address, if needed.
168 &quot;state&quot;: &quot;A String&quot;, # The US two letter state abbreviation of the address.
169 &quot;city&quot;: &quot;A String&quot;, # The city or town for the address.
170 },
171 ],
172 &quot;photoUrl&quot;: &quot;A String&quot;, # A URL for a photo of the official.
173 &quot;emails&quot;: [ # The direct email addresses for the official.
174 &quot;A String&quot;,
175 ],
176 &quot;party&quot;: &quot;A String&quot;, # The full name of the party the official belongs to.
177 &quot;name&quot;: &quot;A String&quot;, # The official&#x27;s name.
178 &quot;phones&quot;: [ # The official&#x27;s public contact phone numbers.
179 &quot;A String&quot;,
180 ],
181 &quot;urls&quot;: [ # The official&#x27;s public website URLs.
182 &quot;A String&quot;,
183 ],
184 },
185 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]186 &quot;offices&quot;: [ # Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.
187 { # Information about an Office held by one or more Officials.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]188 &quot;sources&quot;: [ # A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources.
189 { # Contains information about the data source for the element containing it.
190 &quot;official&quot;: True or False, # Whether this data comes from an official government source.
191 &quot;name&quot;: &quot;A String&quot;, # The name of the data source.
192 },
193 ],
194 &quot;divisionId&quot;: &quot;A String&quot;, # The OCD ID of the division with which this office is associated.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]195 &quot;officialIndices&quot;: [ # List of indices in the officials array of people who presently hold this office.
196 42,
197 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]198 &quot;roles&quot;: [ # The roles which this office fulfills. Roles are not meant to be exhaustive, or to exactly specify the entire set of responsibilities of a given office, but are meant to be rough categories that are useful for general selection from or sorting of a list of offices.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]199 &quot;A String&quot;,
200 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]201 &quot;levels&quot;: [ # The levels of government of which this office is part. 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 &quot;locality&quot; level, but also effectively at both &quot;administrative-area-2&quot; and &quot;administrative-area-1&quot;.
202 &quot;A String&quot;,
203 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]204 &quot;name&quot;: &quot;A String&quot;, # The human-readable name of the office.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]205 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]206 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]207 }</pre>
208</div>
209
210<div class="method">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]211 <code class="details" id="representativeInfoByDivision">representativeInfoByDivision(ocdId, roles=None, recursive=None, levels=None, x__xgafv=None)</code>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]212 <pre>Looks up representative information for a single geographic division.
213
214Args:
215 ocdId: string, The Open Civic Data division identifier of the division to look up. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]216 roles: string, A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don&#x27;t contain a matching office will not be returned. (repeated)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]217 Allowed values
218 headOfState -
219 headOfGovernment -
220 deputyHeadOfGovernment -
221 governmentOfficer -
222 executiveCouncil -
223 legislatorUpperBody -
224 legislatorLowerBody -
225 highestCourtJudge -
226 judge -
227 schoolBoard -
228 specialPurposeOfficer -
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]229 recursive: boolean, If true, information about all divisions contained in the division requested will be included as well. For example, if querying ocd-division/country:us/district:dc, this would also return all DC&#x27;s wards and ANCs.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]230 levels: string, A list of office levels to filter by. Only offices that serve at least one of these levels will be returned. Divisions that don&#x27;t contain a matching office will not be returned. (repeated)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]231 Allowed values
232 international -
233 country -
234 administrativeArea1 -
235 regional -
236 administrativeArea2 -
237 locality -
238 subLocality1 -
239 subLocality2 -
240 special -
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]241 x__xgafv: string, V1 error format.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]242 Allowed values
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]243 1 - v1 error format
244 2 - v2 error format
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]245
246Returns:
247 An object of the form:
248
249 {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]250 &quot;divisions&quot;: { # A map of political geographic divisions that contain the requested address, keyed by the unique Open Civic Data identifier for this division.
251 &quot;a_key&quot;: { # Describes a political geography.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]252 &quot;officeIndices&quot;: [ # List of indices in the offices array, one for each office elected from this division. Will only be present if includeOffices was true (or absent) in the request.
253 42,
254 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]255 &quot;alsoKnownAs&quot;: [ # Any other valid OCD IDs that refer to the same division.\n\nBecause OCD IDs are meant to be human-readable and at least somewhat predictable, there are occasionally several identifiers for a single division. These identifiers are defined to be equivalent to one another, and one is always indicated as the primary identifier. The primary identifier will be returned in ocd_id above, and any other equivalent valid identifiers will be returned in this list.\n\nFor example, if this division&#x27;s OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc.
256 &quot;A String&quot;,
257 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]258 &quot;name&quot;: &quot;A String&quot;, # The name of the division.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]259 },
260 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]261 &quot;offices&quot;: [ # Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.
262 { # Information about an Office held by one or more Officials.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]263 &quot;sources&quot;: [ # A list of sources for this office. If multiple sources are listed, the data has been aggregated from those sources.
264 { # Contains information about the data source for the element containing it.
265 &quot;official&quot;: True or False, # Whether this data comes from an official government source.
266 &quot;name&quot;: &quot;A String&quot;, # The name of the data source.
267 },
268 ],
269 &quot;divisionId&quot;: &quot;A String&quot;, # The OCD ID of the division with which this office is associated.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]270 &quot;officialIndices&quot;: [ # List of indices in the officials array of people who presently hold this office.
271 42,
272 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]273 &quot;roles&quot;: [ # The roles which this office fulfills. Roles are not meant to be exhaustive, or to exactly specify the entire set of responsibilities of a given office, but are meant to be rough categories that are useful for general selection from or sorting of a list of offices.
274 &quot;A String&quot;,
275 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]276 &quot;levels&quot;: [ # The levels of government of which this office is part. 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 &quot;locality&quot; level, but also effectively at both &quot;administrative-area-2&quot; and &quot;administrative-area-1&quot;.
277 &quot;A String&quot;,
278 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]279 &quot;name&quot;: &quot;A String&quot;, # The human-readable name of the office.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]280 },
281 ],
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame^]282 &quot;officials&quot;: [ # Officials holding the offices listed above. Will only be present if includeOffices was true in the request.
283 { # Information about a person holding an elected office.
284 &quot;channels&quot;: [ # A list of known (social) media channels for this official.
285 { # A social media or web channel for a candidate.
286 &quot;id&quot;: &quot;A String&quot;, # The unique public identifier for the candidate&#x27;s channel.
287 &quot;type&quot;: &quot;A String&quot;, # 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
288 },
289 ],
290 &quot;address&quot;: [ # Addresses at which to contact the official.
291 { # A simple representation of an address.
292 &quot;locationName&quot;: &quot;A String&quot;, # The name of the location.
293 &quot;line3&quot;: &quot;A String&quot;, # The third line of the address, if needed.
294 &quot;line1&quot;: &quot;A String&quot;, # The street name and number of this address.
295 &quot;zip&quot;: &quot;A String&quot;, # The US Postal Zip Code of the address.
296 &quot;line2&quot;: &quot;A String&quot;, # The second line the address, if needed.
297 &quot;state&quot;: &quot;A String&quot;, # The US two letter state abbreviation of the address.
298 &quot;city&quot;: &quot;A String&quot;, # The city or town for the address.
299 },
300 ],
301 &quot;photoUrl&quot;: &quot;A String&quot;, # A URL for a photo of the official.
302 &quot;emails&quot;: [ # The direct email addresses for the official.
303 &quot;A String&quot;,
304 ],
305 &quot;party&quot;: &quot;A String&quot;, # The full name of the party the official belongs to.
306 &quot;name&quot;: &quot;A String&quot;, # The official&#x27;s name.
307 &quot;phones&quot;: [ # The official&#x27;s public contact phone numbers.
308 &quot;A String&quot;,
309 ],
310 &quot;urls&quot;: [ # The official&#x27;s public website URLs.
311 &quot;A String&quot;,
312 ],
313 },
314 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]315 }</pre>
316</div>
317
318</body></html>