OLD | NEW |
(Empty) | |
| 1 { |
| 2 "basePath": "/civicinfo/v1/", |
| 3 "baseUrl": "https://www.googleapis.com/civicinfo/v1/", |
| 4 "batchPath": "batch", |
| 5 "canonicalName": "Civic Info", |
| 6 "description": "An API for accessing civic information.", |
| 7 "discoveryVersion": "v1", |
| 8 "documentationLink": "https://developers.google.com/civic-information", |
| 9 "etag": "\"uUWyYHXmEn-ab7WLvo8qNz2S8ws/Sze2Rhamx1amW6d_XzjhazX9mXA\"", |
| 10 "icons": { |
| 11 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| 12 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| 13 }, |
| 14 "id": "civicinfo:v1", |
| 15 "kind": "discovery#restDescription", |
| 16 "name": "civicinfo", |
| 17 "ownerDomain": "google.com", |
| 18 "ownerName": "Google", |
| 19 "parameters": { |
| 20 "alt": { |
| 21 "default": "json", |
| 22 "description": "Data format for the response.", |
| 23 "enum": [ |
| 24 "json" |
| 25 ], |
| 26 "enumDescriptions": [ |
| 27 "Responses with Content-Type of application/json" |
| 28 ], |
| 29 "location": "query", |
| 30 "type": "string" |
| 31 }, |
| 32 "fields": { |
| 33 "description": "Selector specifying which fields to include in a par
tial response.", |
| 34 "location": "query", |
| 35 "type": "string" |
| 36 }, |
| 37 "key": { |
| 38 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 39 "location": "query", |
| 40 "type": "string" |
| 41 }, |
| 42 "oauth_token": { |
| 43 "description": "OAuth 2.0 token for the current user.", |
| 44 "location": "query", |
| 45 "type": "string" |
| 46 }, |
| 47 "prettyPrint": { |
| 48 "default": "true", |
| 49 "description": "Returns response with indentations and line breaks."
, |
| 50 "location": "query", |
| 51 "type": "boolean" |
| 52 }, |
| 53 "quotaUser": { |
| 54 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters. Overrides userIp if both are provided.", |
| 55 "location": "query", |
| 56 "type": "string" |
| 57 }, |
| 58 "userIp": { |
| 59 "description": "IP address of the site where the request originates.
Use this if you want to enforce per-user limits.", |
| 60 "location": "query", |
| 61 "type": "string" |
| 62 } |
| 63 }, |
| 64 "protocol": "rest", |
| 65 "resources": { |
| 66 "divisions": { |
| 67 "methods": { |
| 68 "search": { |
| 69 "description": "Searches for political divisions by their na
tural name or OCD ID.", |
| 70 "httpMethod": "GET", |
| 71 "id": "civicinfo.divisions.search", |
| 72 "parameters": { |
| 73 "query": { |
| 74 "description": "The search query. Queries can cover
any parts of a OCD ID or a human readable division name. All words given in the
query are treated as required patterns. In addition to that, most query operator
s of the Apache Lucene library are supported. See http://lucene.apache.org/core/
2_9_4/queryparsersyntax.html", |
| 75 "location": "query", |
| 76 "type": "string" |
| 77 } |
| 78 }, |
| 79 "path": "representatives/division_search", |
| 80 "response": { |
| 81 "$ref": "DivisionSearchResponse" |
| 82 } |
| 83 } |
| 84 } |
| 85 }, |
| 86 "elections": { |
| 87 "methods": { |
| 88 "electionQuery": { |
| 89 "description": "List of available elections to query.", |
| 90 "httpMethod": "GET", |
| 91 "id": "civicinfo.elections.electionQuery", |
| 92 "path": "elections", |
| 93 "response": { |
| 94 "$ref": "ElectionsQueryResponse" |
| 95 } |
| 96 }, |
| 97 "voterInfoQuery": { |
| 98 "description": "Looks up information relevant to a voter bas
ed on the voter's registered address.", |
| 99 "httpMethod": "POST", |
| 100 "id": "civicinfo.elections.voterInfoQuery", |
| 101 "parameterOrder": [ |
| 102 "electionId" |
| 103 ], |
| 104 "parameters": { |
| 105 "electionId": { |
| 106 "description": "The unique ID of the election to loo
k up. A list of election IDs can be obtained at https://www.googleapis.com/civic
info/{version}/elections", |
| 107 "format": "int64", |
| 108 "location": "path", |
| 109 "required": true, |
| 110 "type": "string" |
| 111 }, |
| 112 "officialOnly": { |
| 113 "default": "false", |
| 114 "description": "If set to true, only data from offic
ial state sources will be returned.", |
| 115 "location": "query", |
| 116 "type": "boolean" |
| 117 } |
| 118 }, |
| 119 "path": "voterinfo/{electionId}/lookup", |
| 120 "request": { |
| 121 "$ref": "VoterInfoRequest" |
| 122 }, |
| 123 "response": { |
| 124 "$ref": "VoterInfoResponse" |
| 125 } |
| 126 } |
| 127 } |
| 128 }, |
| 129 "representatives": { |
| 130 "methods": { |
| 131 "representativeInfoQuery": { |
| 132 "description": "Looks up political geography and representat
ive information based on an address or Open Civic Data division identifier.", |
| 133 "httpMethod": "POST", |
| 134 "id": "civicinfo.representatives.representativeInfoQuery", |
| 135 "parameters": { |
| 136 "includeOffices": { |
| 137 "default": "true", |
| 138 "description": "Whether to return information about
offices and officials. If false, only the top-level district information will be
returned.", |
| 139 "location": "query", |
| 140 "type": "boolean" |
| 141 }, |
| 142 "ocdId": { |
| 143 "description": "The division to look up. May only be
specified if the address field is not given in the request body.", |
| 144 "location": "query", |
| 145 "type": "string" |
| 146 }, |
| 147 "recursive": { |
| 148 "default": "false", |
| 149 "description": "When ocd_id is supplied, return all
divisions which are hierarchically nested within the queried division. For examp
le, if querying ocd-division/country:us/district:dc, this would also return all
DC's wards and ANCs.", |
| 150 "location": "query", |
| 151 "type": "boolean" |
| 152 } |
| 153 }, |
| 154 "path": "representatives/lookup", |
| 155 "request": { |
| 156 "$ref": "RepresentativeInfoRequest" |
| 157 }, |
| 158 "response": { |
| 159 "$ref": "RepresentativeInfoResponse" |
| 160 } |
| 161 } |
| 162 } |
| 163 } |
| 164 }, |
| 165 "revision": "20140815", |
| 166 "rootUrl": "https://www.googleapis.com/", |
| 167 "schemas": { |
| 168 "AdministrationRegion": { |
| 169 "description": "Describes information about a regional election admi
nistrative area.", |
| 170 "id": "AdministrationRegion", |
| 171 "properties": { |
| 172 "electionAdministrationBody": { |
| 173 "$ref": "AdministrativeBody", |
| 174 "description": "The election administration body for this ar
ea." |
| 175 }, |
| 176 "id": { |
| 177 "description": "An ID for this object. IDs may change in fut
ure requests and should not be cached. Access to this field requires special acc
ess that can be requested from the Request more link on the Quotas page.", |
| 178 "type": "string" |
| 179 }, |
| 180 "local_jurisdiction": { |
| 181 "$ref": "AdministrationRegion", |
| 182 "description": "The city or county that provides election in
formation for this voter. This object can have the same elements as state." |
| 183 }, |
| 184 "name": { |
| 185 "description": "The name of the jurisdiction.", |
| 186 "type": "string" |
| 187 }, |
| 188 "sources": { |
| 189 "description": "A list of sources for this area. If multiple
sources are listed the data has been aggregated from those sources.", |
| 190 "items": { |
| 191 "$ref": "Source" |
| 192 }, |
| 193 "type": "array" |
| 194 } |
| 195 }, |
| 196 "type": "object" |
| 197 }, |
| 198 "AdministrativeBody": { |
| 199 "description": "Information about an election administrative body (e
.g. County Board of Elections).", |
| 200 "id": "AdministrativeBody", |
| 201 "properties": { |
| 202 "absenteeVotingInfoUrl": { |
| 203 "description": "A URL provided by this administrative body f
or information on absentee voting.", |
| 204 "type": "string" |
| 205 }, |
| 206 "ballotInfoUrl": { |
| 207 "description": "A URL provided by this administrative body t
o give contest information to the voter.", |
| 208 "type": "string" |
| 209 }, |
| 210 "correspondenceAddress": { |
| 211 "$ref": "SimpleAddressType", |
| 212 "description": "The mailing address of this administrative b
ody." |
| 213 }, |
| 214 "electionInfoUrl": { |
| 215 "description": "A URL provided by this administrative body f
or looking up general election information.", |
| 216 "type": "string" |
| 217 }, |
| 218 "electionOfficials": { |
| 219 "description": "The election officials for this election adm
inistrative body.", |
| 220 "items": { |
| 221 "$ref": "ElectionOfficial" |
| 222 }, |
| 223 "type": "array" |
| 224 }, |
| 225 "electionRegistrationConfirmationUrl": { |
| 226 "description": "A URL provided by this administrative body f
or confirming that the voter is registered to vote.", |
| 227 "type": "string" |
| 228 }, |
| 229 "electionRegistrationUrl": { |
| 230 "description": "A URL provided by this administrative body f
or looking up how to register to vote.", |
| 231 "type": "string" |
| 232 }, |
| 233 "electionRulesUrl": { |
| 234 "description": "A URL provided by this administrative body d
escribing election rules to the voter.", |
| 235 "type": "string" |
| 236 }, |
| 237 "hoursOfOperation": { |
| 238 "description": "A description of the hours of operation for
this administrative body.", |
| 239 "type": "string" |
| 240 }, |
| 241 "name": { |
| 242 "description": "The name of this election administrative bod
y.", |
| 243 "type": "string" |
| 244 }, |
| 245 "physicalAddress": { |
| 246 "$ref": "SimpleAddressType", |
| 247 "description": "The physical address of this administrative
body." |
| 248 }, |
| 249 "voter_services": { |
| 250 "description": "A description of the services this administr
ative body may provide.", |
| 251 "items": { |
| 252 "type": "string" |
| 253 }, |
| 254 "type": "array" |
| 255 }, |
| 256 "votingLocationFinderUrl": { |
| 257 "description": "A URL provided by this administrative body f
or looking up where to vote.", |
| 258 "type": "string" |
| 259 } |
| 260 }, |
| 261 "type": "object" |
| 262 }, |
| 263 "Candidate": { |
| 264 "description": "Information about a candidate running for elected of
fice.", |
| 265 "id": "Candidate", |
| 266 "properties": { |
| 267 "candidateUrl": { |
| 268 "description": "The URL for the candidate's campaign web sit
e.", |
| 269 "type": "string" |
| 270 }, |
| 271 "channels": { |
| 272 "description": "A list of known (social) media channels for
this candidate.", |
| 273 "items": { |
| 274 "$ref": "Channel" |
| 275 }, |
| 276 "type": "array" |
| 277 }, |
| 278 "email": { |
| 279 "description": "The email address for the candidate's campai
gn.", |
| 280 "type": "string" |
| 281 }, |
| 282 "name": { |
| 283 "description": "The candidate's name.", |
| 284 "type": "string" |
| 285 }, |
| 286 "orderOnBallot": { |
| 287 "description": "The order the candidate appears on the ballo
t for this contest.", |
| 288 "format": "int64", |
| 289 "type": "string" |
| 290 }, |
| 291 "party": { |
| 292 "description": "The full name of the party the candidate is
a member of.", |
| 293 "type": "string" |
| 294 }, |
| 295 "phone": { |
| 296 "description": "The voice phone number for the candidate's c
ampaign office.", |
| 297 "type": "string" |
| 298 }, |
| 299 "photoUrl": { |
| 300 "description": "A URL for a photo of the candidate.", |
| 301 "type": "string" |
| 302 } |
| 303 }, |
| 304 "type": "object" |
| 305 }, |
| 306 "Channel": { |
| 307 "description": "A social media or web channel for a candidate.", |
| 308 "id": "Channel", |
| 309 "properties": { |
| 310 "id": { |
| 311 "description": "The unique public identifier for the candida
te's channel.", |
| 312 "type": "string" |
| 313 }, |
| 314 "type": { |
| 315 "description": "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", |
| 316 "type": "string" |
| 317 } |
| 318 }, |
| 319 "type": "object" |
| 320 }, |
| 321 "Contest": { |
| 322 "description": "Information about a contest that appears on a voter'
s ballot.", |
| 323 "id": "Contest", |
| 324 "properties": { |
| 325 "ballotPlacement": { |
| 326 "description": "A number specifying the position of this con
test on the voter's ballot.", |
| 327 "format": "int64", |
| 328 "type": "string" |
| 329 }, |
| 330 "candidates": { |
| 331 "description": "The candidate choices for this contest.", |
| 332 "items": { |
| 333 "$ref": "Candidate" |
| 334 }, |
| 335 "type": "array" |
| 336 }, |
| 337 "district": { |
| 338 "$ref": "ElectoralDistrict", |
| 339 "description": "Information about the electoral district tha
t this contest is in." |
| 340 }, |
| 341 "electorateSpecifications": { |
| 342 "description": "A description of any additional eligibility
requirements for voting in this contest.", |
| 343 "type": "string" |
| 344 }, |
| 345 "id": { |
| 346 "description": "An ID for this object. IDs may change in fut
ure requests and should not be cached. Access to this field requires special acc
ess that can be requested from the Request more link on the Quotas page.", |
| 347 "type": "string" |
| 348 }, |
| 349 "level": { |
| 350 "description": "The level of office for this contest. One of
: federal, state, county, city, other", |
| 351 "type": "string" |
| 352 }, |
| 353 "numberElected": { |
| 354 "description": "The number of candidates that will be electe
d to office in this contest.", |
| 355 "format": "int64", |
| 356 "type": "string" |
| 357 }, |
| 358 "numberVotingFor": { |
| 359 "description": "The number of candidates that a voter may vo
te for in this contest.", |
| 360 "format": "int64", |
| 361 "type": "string" |
| 362 }, |
| 363 "office": { |
| 364 "description": "The name of the office for this contest.", |
| 365 "type": "string" |
| 366 }, |
| 367 "primaryParty": { |
| 368 "description": "If this is a partisan election, the name of
the party it is for.", |
| 369 "type": "string" |
| 370 }, |
| 371 "referendumSubtitle": { |
| 372 "description": "A brief description of the referendum. This
field is only populated for contests of type 'Referendum'.", |
| 373 "type": "string" |
| 374 }, |
| 375 "referendumTitle": { |
| 376 "description": "The title of the referendum (e.g. 'Propositi
on 42'). This field is only populated for contests of type 'Referendum'.", |
| 377 "type": "string" |
| 378 }, |
| 379 "referendumUrl": { |
| 380 "description": "A link to the referendum. This field is only
populated for contests of type 'Referendum'.", |
| 381 "type": "string" |
| 382 }, |
| 383 "sources": { |
| 384 "description": "A list of sources for this contest. If multi
ple sources are listed, the data has been aggregated from those sources.", |
| 385 "items": { |
| 386 "$ref": "Source" |
| 387 }, |
| 388 "type": "array" |
| 389 }, |
| 390 "special": { |
| 391 "description": "\"Yes\" or \"No\" depending on whether this
a contest being held outside the normal election cycle.", |
| 392 "type": "string" |
| 393 }, |
| 394 "type": { |
| 395 "description": "The type of contest. Usually this will be 'G
eneral', 'Primary', or 'Run-off' for contests with candidates. For referenda thi
s will be 'Referendum'.", |
| 396 "type": "string" |
| 397 } |
| 398 }, |
| 399 "type": "object" |
| 400 }, |
| 401 "DivisionSearchResponse": { |
| 402 "description": "The result of a division search query.", |
| 403 "id": "DivisionSearchResponse", |
| 404 "properties": { |
| 405 "kind": { |
| 406 "default": "civicinfo#divisionSearchResponse", |
| 407 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"civicinfo#divisionSearchResponse\".", |
| 408 "type": "string" |
| 409 }, |
| 410 "results": { |
| 411 "items": { |
| 412 "$ref": "DivisionSearchResult" |
| 413 }, |
| 414 "type": "array" |
| 415 }, |
| 416 "status": { |
| 417 "description": "The result of the request. One of: success,
addressUnparseable, noAddressParameter, internalLookupFailure", |
| 418 "type": "string" |
| 419 } |
| 420 }, |
| 421 "type": "object" |
| 422 }, |
| 423 "DivisionSearchResult": { |
| 424 "description": "Represents a political geographic division that matc
hes the requested query.", |
| 425 "id": "DivisionSearchResult", |
| 426 "properties": { |
| 427 "aliases": { |
| 428 "description": "Other Open Civic Data identifiers that refer
to the same division -- for example, those that refer to other political divisi
ons whose boundaries are defined to be coterminous with this one. For example, o
cd-division/country:us/state:wy will include an alias of ocd-division/country:us
/state:wy/cd:1, since Wyoming has only one Congressional district.", |
| 429 "items": { |
| 430 "type": "string" |
| 431 }, |
| 432 "type": "array" |
| 433 }, |
| 434 "name": { |
| 435 "description": "The name of the division.", |
| 436 "type": "string" |
| 437 }, |
| 438 "ocdId": { |
| 439 "description": "The unique Open Civic Data identifier for th
is division.", |
| 440 "type": "string" |
| 441 } |
| 442 }, |
| 443 "type": "object" |
| 444 }, |
| 445 "Election": { |
| 446 "description": "Information about the election that was queried.", |
| 447 "id": "Election", |
| 448 "properties": { |
| 449 "electionDay": { |
| 450 "description": "Day of the election in YYYY-MM-DD format.", |
| 451 "type": "string" |
| 452 }, |
| 453 "id": { |
| 454 "description": "The unique ID of this election.", |
| 455 "format": "int64", |
| 456 "type": "string" |
| 457 }, |
| 458 "name": { |
| 459 "description": "A displayable name for the election.", |
| 460 "type": "string" |
| 461 } |
| 462 }, |
| 463 "type": "object" |
| 464 }, |
| 465 "ElectionOfficial": { |
| 466 "description": "Information about individual election officials.", |
| 467 "id": "ElectionOfficial", |
| 468 "properties": { |
| 469 "emailAddress": { |
| 470 "description": "The email address of the election official."
, |
| 471 "type": "string" |
| 472 }, |
| 473 "faxNumber": { |
| 474 "description": "The fax number of the election official.", |
| 475 "type": "string" |
| 476 }, |
| 477 "name": { |
| 478 "description": "The full name of the election official.", |
| 479 "type": "string" |
| 480 }, |
| 481 "officePhoneNumber": { |
| 482 "description": "The office phone number of the election offi
cial.", |
| 483 "type": "string" |
| 484 }, |
| 485 "title": { |
| 486 "description": "The title of the election official.", |
| 487 "type": "string" |
| 488 } |
| 489 }, |
| 490 "type": "object" |
| 491 }, |
| 492 "ElectionsQueryResponse": { |
| 493 "description": "The list of elections available for this version of
the API.", |
| 494 "id": "ElectionsQueryResponse", |
| 495 "properties": { |
| 496 "elections": { |
| 497 "description": "A list of available elections", |
| 498 "items": { |
| 499 "$ref": "Election" |
| 500 }, |
| 501 "type": "array" |
| 502 }, |
| 503 "kind": { |
| 504 "default": "civicinfo#electionsQueryResponse", |
| 505 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"civicinfo#electionsQueryResponse\".", |
| 506 "type": "string" |
| 507 } |
| 508 }, |
| 509 "type": "object" |
| 510 }, |
| 511 "ElectoralDistrict": { |
| 512 "description": "Describes the geographic scope of a contest.", |
| 513 "id": "ElectoralDistrict", |
| 514 "properties": { |
| 515 "id": { |
| 516 "description": "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.", |
| 517 "type": "string" |
| 518 }, |
| 519 "name": { |
| 520 "description": "The name of the district.", |
| 521 "type": "string" |
| 522 }, |
| 523 "scope": { |
| 524 "description": "The geographic scope of this district. If un
specified the district's geography is not known. One of: national, statewide, co
ngressional, stateUpper, stateLower, countywide, judicial, schoolBoard, cityWide
, township, countyCouncil, cityCouncil, ward, special", |
| 525 "type": "string" |
| 526 } |
| 527 }, |
| 528 "type": "object" |
| 529 }, |
| 530 "GeographicDivision": { |
| 531 "description": "Describes a political geography.", |
| 532 "id": "GeographicDivision", |
| 533 "properties": { |
| 534 "alsoKnownAs": { |
| 535 "description": "Any other valid OCD IDs that refer to the sa
me division. For example, if this division's OCD ID is ocd-division/country:us/d
istrict:dc, this will contain ocd-division/country:us/state:dc.", |
| 536 "items": { |
| 537 "type": "string" |
| 538 }, |
| 539 "type": "array" |
| 540 }, |
| 541 "name": { |
| 542 "description": "The name of the division.", |
| 543 "type": "string" |
| 544 }, |
| 545 "officeIds": { |
| 546 "description": "List of keys in the offices object, one for
each office elected from this division. Will only be present if includeOffices w
as true (or absent) in the request.", |
| 547 "items": { |
| 548 "type": "string" |
| 549 }, |
| 550 "type": "array" |
| 551 }, |
| 552 "scope": { |
| 553 "description": "The geographic scope of the division. If uns
pecified, the division's geography is not known. One of: national, statewide, co
ngressional, stateUpper, stateLower, countywide, judicial, schoolBoard, cityWide
, township, countyCouncil, cityCouncil, ward, special", |
| 554 "type": "string" |
| 555 } |
| 556 }, |
| 557 "type": "object" |
| 558 }, |
| 559 "Office": { |
| 560 "description": "Information about an Office held by one or more Offi
cials.", |
| 561 "id": "Office", |
| 562 "properties": { |
| 563 "divisionId": { |
| 564 "description": "The OCD ID of the division with which this o
ffice is associated.", |
| 565 "type": "string" |
| 566 }, |
| 567 "level": { |
| 568 "description": "The level of this elected office. One of: fe
deral, state, county, city, other", |
| 569 "type": "string" |
| 570 }, |
| 571 "name": { |
| 572 "description": "The human-readable name of the office.", |
| 573 "type": "string" |
| 574 }, |
| 575 "officialIds": { |
| 576 "description": "List of keys in the officials object of peop
le who presently hold this office.", |
| 577 "items": { |
| 578 "type": "string" |
| 579 }, |
| 580 "type": "array" |
| 581 }, |
| 582 "sources": { |
| 583 "description": "A list of sources for this office. If multip
le sources are listed, the data has been aggregated from those sources.", |
| 584 "items": { |
| 585 "$ref": "Source" |
| 586 }, |
| 587 "type": "array" |
| 588 } |
| 589 }, |
| 590 "type": "object" |
| 591 }, |
| 592 "Official": { |
| 593 "description": "Information about a official holding an elected offi
ce.", |
| 594 "id": "Official", |
| 595 "properties": { |
| 596 "address": { |
| 597 "description": "Addresses at which to contact the official."
, |
| 598 "items": { |
| 599 "$ref": "SimpleAddressType" |
| 600 }, |
| 601 "type": "array" |
| 602 }, |
| 603 "channels": { |
| 604 "description": "A list of known (social) media channels for
this official.", |
| 605 "items": { |
| 606 "$ref": "Channel" |
| 607 }, |
| 608 "type": "array" |
| 609 }, |
| 610 "emails": { |
| 611 "description": "The direct email addresses for the official.
", |
| 612 "items": { |
| 613 "type": "string" |
| 614 }, |
| 615 "type": "array" |
| 616 }, |
| 617 "name": { |
| 618 "description": "The official's name.", |
| 619 "type": "string" |
| 620 }, |
| 621 "party": { |
| 622 "description": "The full name of the party the official belo
ngs to.", |
| 623 "type": "string" |
| 624 }, |
| 625 "phones": { |
| 626 "description": "The official's public contact phone numbers.
", |
| 627 "items": { |
| 628 "type": "string" |
| 629 }, |
| 630 "type": "array" |
| 631 }, |
| 632 "photoUrl": { |
| 633 "description": "A URL for a photo of the official.", |
| 634 "type": "string" |
| 635 }, |
| 636 "urls": { |
| 637 "description": "The official's public website URLs.", |
| 638 "items": { |
| 639 "type": "string" |
| 640 }, |
| 641 "type": "array" |
| 642 } |
| 643 }, |
| 644 "type": "object" |
| 645 }, |
| 646 "PollingLocation": { |
| 647 "description": "A location where a voter can vote. This may be an ea
rly vote site or an election day voting location.", |
| 648 "id": "PollingLocation", |
| 649 "properties": { |
| 650 "address": { |
| 651 "$ref": "SimpleAddressType", |
| 652 "description": "The address of the location" |
| 653 }, |
| 654 "endDate": { |
| 655 "description": "The last date that this early vote site may
be used. This field is not populated for polling locations.", |
| 656 "type": "string" |
| 657 }, |
| 658 "id": { |
| 659 "description": "An ID for this object. IDs may change in fut
ure requests and should not be cached. Access to this field requires special acc
ess that can be requested from the Request more link on the Quotas page.", |
| 660 "type": "string" |
| 661 }, |
| 662 "name": { |
| 663 "description": "The name of the early vote site. This field
is not populated for polling locations.", |
| 664 "type": "string" |
| 665 }, |
| 666 "notes": { |
| 667 "description": "Notes about this location (e.g. accessibilit
y ramp or entrance to use)", |
| 668 "type": "string" |
| 669 }, |
| 670 "pollingHours": { |
| 671 "description": "A description of when this location is open.
", |
| 672 "type": "string" |
| 673 }, |
| 674 "sources": { |
| 675 "description": "A list of sources for this location. If mult
iple sources are listed the data has been aggregated from those sources.", |
| 676 "items": { |
| 677 "$ref": "Source" |
| 678 }, |
| 679 "type": "array" |
| 680 }, |
| 681 "startDate": { |
| 682 "description": "The first date that this early vote site may
be used. This field is not populated for polling locations.", |
| 683 "type": "string" |
| 684 }, |
| 685 "voterServices": { |
| 686 "description": "The services provided by this early vote sit
e. This field is not populated for polling locations.", |
| 687 "type": "string" |
| 688 } |
| 689 }, |
| 690 "type": "object" |
| 691 }, |
| 692 "RepresentativeInfoRequest": { |
| 693 "description": "A request for political geography and representative
information for an address.", |
| 694 "id": "RepresentativeInfoRequest", |
| 695 "properties": { |
| 696 "address": { |
| 697 "description": "The address to look up. May only be specifie
d if the field ocdId is not given in the URL.", |
| 698 "type": "string" |
| 699 } |
| 700 }, |
| 701 "type": "object" |
| 702 }, |
| 703 "RepresentativeInfoResponse": { |
| 704 "description": "The result of a representative info lookup query.", |
| 705 "id": "RepresentativeInfoResponse", |
| 706 "properties": { |
| 707 "divisions": { |
| 708 "additionalProperties": { |
| 709 "$ref": "GeographicDivision", |
| 710 "description": "The unique Open Civic Data identifier fo
r this division." |
| 711 }, |
| 712 "description": "Political geographic divisions that contain
the requested address.", |
| 713 "type": "object" |
| 714 }, |
| 715 "kind": { |
| 716 "default": "civicinfo#representativeInfoResponse", |
| 717 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"civicinfo#representativeInfoResponse\".", |
| 718 "type": "string" |
| 719 }, |
| 720 "normalizedInput": { |
| 721 "$ref": "SimpleAddressType", |
| 722 "description": "The normalized version of the requested addr
ess" |
| 723 }, |
| 724 "offices": { |
| 725 "additionalProperties": { |
| 726 "$ref": "Office", |
| 727 "description": "A unique identifier for this office, wit
hin the context of this request. Identifiers are *not* long-lived: the same offi
ce may get different IDs on different requests." |
| 728 }, |
| 729 "description": "Elected offices referenced by the divisions
listed above. Will only be present if includeOffices was true in the request.", |
| 730 "type": "object" |
| 731 }, |
| 732 "officials": { |
| 733 "additionalProperties": { |
| 734 "$ref": "Official", |
| 735 "description": "A unique identifier for this official, w
ithin the context of this request. Identifiers are *not* long-lived: the same of
ficial may get different IDs on different requests." |
| 736 }, |
| 737 "description": "Officials holding the offices listed above.
Will only be present if includeOffices was true in the request.", |
| 738 "type": "object" |
| 739 }, |
| 740 "status": { |
| 741 "description": "The result of the request. One of: success,
noStreetSegmentFound, addressUnparseable, noAddressParameter, multipleStreetSegm
entsFound, electionOver, electionUnknown, internalLookupFailure, RequestedBothAd
dressAndOcdId", |
| 742 "type": "string" |
| 743 } |
| 744 }, |
| 745 "type": "object" |
| 746 }, |
| 747 "SimpleAddressType": { |
| 748 "description": "A simple representation of an address.", |
| 749 "id": "SimpleAddressType", |
| 750 "properties": { |
| 751 "city": { |
| 752 "description": "The city or town for the address.", |
| 753 "type": "string" |
| 754 }, |
| 755 "line1": { |
| 756 "description": "The street name and number of this address."
, |
| 757 "type": "string" |
| 758 }, |
| 759 "line2": { |
| 760 "description": "The second line the address, if needed.", |
| 761 "type": "string" |
| 762 }, |
| 763 "line3": { |
| 764 "description": "The third line of the address, if needed.", |
| 765 "type": "string" |
| 766 }, |
| 767 "locationName": { |
| 768 "description": "The name of the location.", |
| 769 "type": "string" |
| 770 }, |
| 771 "state": { |
| 772 "description": "The US two letter state abbreviation of the
address.", |
| 773 "type": "string" |
| 774 }, |
| 775 "zip": { |
| 776 "description": "The US Postal Zip Code of the address.", |
| 777 "type": "string" |
| 778 } |
| 779 }, |
| 780 "type": "object" |
| 781 }, |
| 782 "Source": { |
| 783 "description": "Contains information about the data source for the e
lement containing it.", |
| 784 "id": "Source", |
| 785 "properties": { |
| 786 "name": { |
| 787 "description": "The name of the data source.", |
| 788 "type": "string" |
| 789 }, |
| 790 "official": { |
| 791 "description": "Whether this data comes from an official gov
ernment source.", |
| 792 "type": "boolean" |
| 793 } |
| 794 }, |
| 795 "type": "object" |
| 796 }, |
| 797 "VoterInfoRequest": { |
| 798 "description": "A request for information about a voter.", |
| 799 "id": "VoterInfoRequest", |
| 800 "properties": { |
| 801 "address": { |
| 802 "description": "The registered address of the voter to look
up.", |
| 803 "type": "string" |
| 804 } |
| 805 }, |
| 806 "type": "object" |
| 807 }, |
| 808 "VoterInfoResponse": { |
| 809 "description": "The result of a voter info lookup query.", |
| 810 "id": "VoterInfoResponse", |
| 811 "properties": { |
| 812 "contests": { |
| 813 "description": "Contests that will appear on the voter's bal
lot", |
| 814 "items": { |
| 815 "$ref": "Contest" |
| 816 }, |
| 817 "type": "array" |
| 818 }, |
| 819 "earlyVoteSites": { |
| 820 "description": "Locations where the voter is eligible to vot
e early, prior to election day", |
| 821 "items": { |
| 822 "$ref": "PollingLocation" |
| 823 }, |
| 824 "type": "array" |
| 825 }, |
| 826 "election": { |
| 827 "$ref": "Election", |
| 828 "description": "The election that was queried." |
| 829 }, |
| 830 "kind": { |
| 831 "default": "civicinfo#voterInfoResponse", |
| 832 "description": "Identifies what kind of resource this is. Va
lue: the fixed string \"civicinfo#voterInfoResponse\".", |
| 833 "type": "string" |
| 834 }, |
| 835 "normalizedInput": { |
| 836 "$ref": "SimpleAddressType", |
| 837 "description": "The normalized version of the requested addr
ess" |
| 838 }, |
| 839 "pollingLocations": { |
| 840 "description": "Locations where the voter is eligible to vot
e on election day. For states with mail-in voting only, these locations will be
nearby drop box locations. Drop box locations are free to the voter and may be u
sed instead of placing the ballot in the mail.", |
| 841 "items": { |
| 842 "$ref": "PollingLocation" |
| 843 }, |
| 844 "type": "array" |
| 845 }, |
| 846 "state": { |
| 847 "description": "Local Election Information for the state tha
t the voter votes in. For the US, there will only be one element in this array."
, |
| 848 "items": { |
| 849 "$ref": "AdministrationRegion" |
| 850 }, |
| 851 "type": "array" |
| 852 }, |
| 853 "status": { |
| 854 "description": "The result of the request. One of: success,
noStreetSegmentFound, addressUnparseable, noAddressParameter, multipleStreetSegm
entsFound, electionOver, electionUnknown, internalLookupFailure", |
| 855 "type": "string" |
| 856 } |
| 857 }, |
| 858 "type": "object" |
| 859 } |
| 860 }, |
| 861 "servicePath": "civicinfo/v1/", |
| 862 "title": "Google Civic Information API", |
| 863 "version": "v1" |
| 864 } |
OLD | NEW |