1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="civicinfo_v2.html">Google Civic Information API</a> . <a href="civicinfo_v2.representatives.html">representatives</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#representativeInfoByAddress">representativeInfoByAddress(levels=None, roles=None, address=None, includeOffices=None)</a></code></p>
<p class="firstline">Looks up political geography and representative information for a single address.</p>
<p class="toc_element">
<code><a href="#representativeInfoByDivision">representativeInfoByDivision(ocdId, recursive=None, roles=None, levels=None)</a></code></p>
<p class="firstline">Looks up representative information for a single geographic division.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="representativeInfoByAddress">representativeInfoByAddress(levels=None, roles=None, address=None, includeOffices=None)</code>
<pre>Looks up political geography and representative information for a single address.
Args:
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't contain a matching office will not be returned. (repeated)
Allowed values
administrativeArea1 -
administrativeArea2 -
country -
international -
locality -
regional -
special -
subLocality1 -
subLocality2 -
roles: string, A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned. (repeated)
Allowed values
deputyHeadOfGovernment -
executiveCouncil -
governmentOfficer -
headOfGovernment -
headOfState -
highestCourtJudge -
judge -
legislatorLowerBody -
legislatorUpperBody -
schoolBoard -
specialPurposeOfficer -
address: string, The address to look up. May only be specified if the field ocdId is not given in the URL.
includeOffices: boolean, Whether to return information about offices and officials. If false, only the top-level district information will be returned.
Returns:
An object of the form:
{ # The result of a representative info lookup query.
"divisions": { # Political geographic divisions that contain the requested address.
"a_key": { # Describes a political geography. # The unique Open Civic Data identifier for this division.
"officeIndices": [ # 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.
42,
],
"alsoKnownAs": [ # Any other valid OCD IDs that refer to the same division.
#
# Because 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.
#
# For example, if this division's OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc.
"A String",
],
"name": "A String", # The name of the division.
},
},
"kind": "civicinfo#representativeInfoResponse", # Identifies what kind of resource this is. Value: the fixed string "civicinfo#representativeInfoResponse".
"officials": [ # Officials holding the offices listed above. Will only be present if includeOffices was true in the request.
{ # Information about a person holding an elected office.
"name": "A String", # The official's name.
"photoUrl": "A String", # A URL for a photo of the official.
"phones": [ # The official's public contact phone numbers.
"A String",
],
"channels": [ # A list of known (social) media channels for this official.
{ # 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.
},
],
"urls": [ # The official's public website URLs.
"A String",
],
"address": [ # Addresses at which to contact the official.
{ # A simple representation of an address.
"city": "A String", # The city or town for the address.
"zip": "A String", # The US Postal Zip Code of the address.
"line3": "A String", # The third line of the address, if needed.
"line2": "A String", # The second line the address, if needed.
"line1": "A String", # The street name and number of this address.
"locationName": "A String", # The name of the location.
"state": "A String", # The US two letter state abbreviation of the address.
},
],
"party": "A String", # The full name of the party the official belongs to.
"emails": [ # The direct email addresses for the official.
"A String",
],
},
],
"offices": [ # Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.
{ # Information about an Office held by one or more Officials.
"name": "A String", # The human-readable name of the office.
"roles": [ # 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.
"A String",
],
"officialIndices": [ # List of indices in the officials array of people who presently hold this office.
42,
],
"sources": [ # A list of sources for this office. 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.
},
],
"levels": [ # 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 "locality" level, but also effectively at both "administrative-area-2" and "administrative-area-1".
"A String",
],
"divisionId": "A String", # The OCD ID of the division with which this office is associated.
},
],
"normalizedInput": { # A simple representation of an address. # The normalized version of the requested address
"city": "A String", # The city or town for the address.
"zip": "A String", # The US Postal Zip Code of the address.
"line3": "A String", # The third line of the address, if needed.
"line2": "A String", # The second line the address, if needed.
"line1": "A String", # The street name and number of this address.
"locationName": "A String", # The name of the location.
"state": "A String", # The US two letter state abbreviation of the address.
},
}</pre>
</div>
<div class="method">
<code class="details" id="representativeInfoByDivision">representativeInfoByDivision(ocdId, recursive=None, roles=None, levels=None)</code>
<pre>Looks up representative information for a single geographic division.
Args:
ocdId: string, The Open Civic Data division identifier of the division to look up. (required)
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's wards and ANCs.
roles: string, A list of office roles to filter by. Only offices fulfilling one of these roles will be returned. Divisions that don't contain a matching office will not be returned. (repeated)
Allowed values
deputyHeadOfGovernment -
executiveCouncil -
governmentOfficer -
headOfGovernment -
headOfState -
highestCourtJudge -
judge -
legislatorLowerBody -
legislatorUpperBody -
schoolBoard -
specialPurposeOfficer -
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't contain a matching office will not be returned. (repeated)
Allowed values
administrativeArea1 -
administrativeArea2 -
country -
international -
locality -
regional -
special -
subLocality1 -
subLocality2 -
Returns:
An object of the form:
{
"divisions": { # Political geographic divisions that contain the requested address.
"a_key": { # Describes a political geography. # The unique Open Civic Data identifier for this division.
"officeIndices": [ # 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.
42,
],
"alsoKnownAs": [ # Any other valid OCD IDs that refer to the same division.
#
# Because 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.
#
# For example, if this division's OCD ID is ocd-division/country:us/district:dc, this will contain ocd-division/country:us/state:dc.
"A String",
],
"name": "A String", # The name of the division.
},
},
"officials": [ # Officials holding the offices listed above. Will only be present if includeOffices was true in the request.
{ # Information about a person holding an elected office.
"name": "A String", # The official's name.
"photoUrl": "A String", # A URL for a photo of the official.
"phones": [ # The official's public contact phone numbers.
"A String",
],
"channels": [ # A list of known (social) media channels for this official.
{ # 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.
},
],
"urls": [ # The official's public website URLs.
"A String",
],
"address": [ # Addresses at which to contact the official.
{ # A simple representation of an address.
"city": "A String", # The city or town for the address.
"zip": "A String", # The US Postal Zip Code of the address.
"line3": "A String", # The third line of the address, if needed.
"line2": "A String", # The second line the address, if needed.
"line1": "A String", # The street name and number of this address.
"locationName": "A String", # The name of the location.
"state": "A String", # The US two letter state abbreviation of the address.
},
],
"party": "A String", # The full name of the party the official belongs to.
"emails": [ # The direct email addresses for the official.
"A String",
],
},
],
"offices": [ # Elected offices referenced by the divisions listed above. Will only be present if includeOffices was true in the request.
{ # Information about an Office held by one or more Officials.
"name": "A String", # The human-readable name of the office.
"roles": [ # 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.
"A String",
],
"officialIndices": [ # List of indices in the officials array of people who presently hold this office.
42,
],
"sources": [ # A list of sources for this office. 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.
},
],
"levels": [ # 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 "locality" level, but also effectively at both "administrative-area-2" and "administrative-area-1".
"A String",
],
"divisionId": "A String", # The OCD ID of the division with which this office is associated.
},
],
}</pre>
</div>
</body></html>
|
