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