-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
civicinfo.v2.json
2171 lines (2171 loc) 路 89.4 KB
/
civicinfo.v2.json
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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"basePath": "",
"baseUrl": "https://civicinfo.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Civic Info",
"description": "Provides polling places, early vote locations, contest data, election officials, and government representatives for U.S. residential addresses.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/civic-information/",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "civicinfo:v2",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://civicinfo.mtls.googleapis.com/",
"name": "civicinfo",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"divisions": {
"methods": {
"search": {
"description": "Searches for political divisions by their natural name or OCD ID.",
"flatPath": "civicinfo/v2/divisions",
"httpMethod": "GET",
"id": "civicinfo.divisions.search",
"parameterOrder": [],
"parameters": {
"query": {
"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 operators of the Apache Lucene library are supported. See http://lucene.apache.org/core/2_9_4/queryparsersyntax.html",
"location": "query",
"type": "string"
}
},
"path": "civicinfo/v2/divisions",
"response": {
"$ref": "DivisionSearchResponse"
}
}
}
},
"elections": {
"methods": {
"electionQuery": {
"description": "List of available elections to query.",
"flatPath": "civicinfo/v2/elections",
"httpMethod": "GET",
"id": "civicinfo.elections.electionQuery",
"parameterOrder": [],
"parameters": {},
"path": "civicinfo/v2/elections",
"response": {
"$ref": "ElectionsQueryResponse"
}
},
"voterInfoQuery": {
"description": "Looks up information relevant to a voter based on the voter's registered address.",
"flatPath": "civicinfo/v2/voterinfo",
"httpMethod": "GET",
"id": "civicinfo.elections.voterInfoQuery",
"parameterOrder": [
"address"
],
"parameters": {
"address": {
"description": "The registered address of the voter to look up.",
"location": "query",
"required": true,
"type": "string"
},
"electionId": {
"default": "0",
"description": "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.",
"format": "int64",
"location": "query",
"type": "string"
},
"officialOnly": {
"default": "false",
"description": "If set to true, only data from official state sources will be returned.",
"location": "query",
"type": "boolean"
},
"returnAllAvailableData": {
"default": "false",
"description": "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.",
"location": "query",
"type": "boolean"
}
},
"path": "civicinfo/v2/voterinfo",
"response": {
"$ref": "VoterInfoResponse"
}
}
}
},
"representatives": {
"methods": {
"representativeInfoByAddress": {
"description": "Looks up political geography and representative information for a single address.",
"flatPath": "civicinfo/v2/representatives",
"httpMethod": "GET",
"id": "civicinfo.representatives.representativeInfoByAddress",
"parameterOrder": [],
"parameters": {
"address": {
"description": "The address to look up. May only be specified if the field ocdId is not given in the URL",
"location": "query",
"type": "string"
},
"includeOffices": {
"default": "true",
"description": "Whether to return information about offices and officials. If false, only the top-level district information will be returned.",
"location": "query",
"type": "boolean"
},
"levels": {
"description": "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.",
"enum": [
"international",
"country",
"administrativeArea1",
"regional",
"administrativeArea2",
"locality",
"subLocality1",
"subLocality2",
"special"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"location": "query",
"repeated": true,
"type": "string"
},
"roles": {
"description": "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.",
"enum": [
"headOfState",
"headOfGovernment",
"deputyHeadOfGovernment",
"governmentOfficer",
"executiveCouncil",
"legislatorUpperBody",
"legislatorLowerBody",
"highestCourtJudge",
"judge",
"schoolBoard",
"specialPurposeOfficer",
"otherRole"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"location": "query",
"repeated": true,
"type": "string"
}
},
"path": "civicinfo/v2/representatives",
"response": {
"$ref": "RepresentativeInfoResponse"
}
},
"representativeInfoByDivision": {
"description": "Looks up representative information for a single geographic division.",
"flatPath": "civicinfo/v2/representatives/{ocdId}",
"httpMethod": "GET",
"id": "civicinfo.representatives.representativeInfoByDivision",
"parameterOrder": [
"ocdId"
],
"parameters": {
"levels": {
"description": "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.",
"enum": [
"international",
"country",
"administrativeArea1",
"regional",
"administrativeArea2",
"locality",
"subLocality1",
"subLocality2",
"special"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"location": "query",
"repeated": true,
"type": "string"
},
"ocdId": {
"description": "The Open Civic Data division identifier of the division to look up.",
"location": "path",
"required": true,
"type": "string"
},
"recursive": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"roles": {
"description": "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.",
"enum": [
"headOfState",
"headOfGovernment",
"deputyHeadOfGovernment",
"governmentOfficer",
"executiveCouncil",
"legislatorUpperBody",
"legislatorLowerBody",
"highestCourtJudge",
"judge",
"schoolBoard",
"specialPurposeOfficer",
"otherRole"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"location": "query",
"repeated": true,
"type": "string"
}
},
"path": "civicinfo/v2/representatives/{ocdId}",
"response": {
"$ref": "RepresentativeInfoData"
}
}
}
}
},
"revision": "20230328",
"rootUrl": "https://civicinfo.googleapis.com/",
"schemas": {
"AdministrationRegion": {
"description": "Describes information about a regional election administrative area.",
"id": "AdministrationRegion",
"properties": {
"electionAdministrationBody": {
"$ref": "AdministrativeBody",
"description": "The election administration body for this area."
},
"local_jurisdiction": {
"$ref": "AdministrationRegion",
"description": "The city or county that provides election information for this voter. This object can have the same elements as state."
},
"name": {
"description": "The name of the jurisdiction.",
"type": "string"
},
"sources": {
"description": "A list of sources for this area. If multiple sources are listed the data has been aggregated from those sources.",
"items": {
"$ref": "Source"
},
"type": "array"
}
},
"type": "object"
},
"AdministrativeBody": {
"description": "Information about an election administrative body (e.g. County Board of Elections).",
"id": "AdministrativeBody",
"properties": {
"absenteeVotingInfoUrl": {
"description": "A URL provided by this administrative body for information on absentee voting.",
"type": "string"
},
"ballotInfoUrl": {
"description": "A URL provided by this administrative body to give contest information to the voter.",
"type": "string"
},
"correspondenceAddress": {
"$ref": "SimpleAddressType",
"description": "The mailing address of this administrative body."
},
"electionInfoUrl": {
"description": "A URL provided by this administrative body for looking up general election information.",
"type": "string"
},
"electionNoticeText": {
"description": "A last minute or emergency notification text provided by this administrative body.",
"type": "string"
},
"electionNoticeUrl": {
"description": "A URL provided by this administrative body for additional information related to the last minute or emergency notification.",
"type": "string"
},
"electionOfficials": {
"description": "The election officials for this election administrative body.",
"items": {
"$ref": "ElectionOfficial"
},
"type": "array"
},
"electionRegistrationConfirmationUrl": {
"description": "A URL provided by this administrative body for confirming that the voter is registered to vote.",
"type": "string"
},
"electionRegistrationUrl": {
"description": "A URL provided by this administrative body for looking up how to register to vote.",
"type": "string"
},
"electionRulesUrl": {
"description": "A URL provided by this administrative body describing election rules to the voter.",
"type": "string"
},
"hoursOfOperation": {
"description": "A description of the hours of operation for this administrative body.",
"type": "string"
},
"name": {
"description": "The name of this election administrative body.",
"type": "string"
},
"physicalAddress": {
"$ref": "SimpleAddressType",
"description": "The physical address of this administrative body."
},
"voter_services": {
"description": "A description of the services this administrative body may provide.",
"items": {
"type": "string"
},
"type": "array"
},
"votingLocationFinderUrl": {
"description": "A URL provided by this administrative body for looking up where to vote.",
"type": "string"
}
},
"type": "object"
},
"Candidate": {
"description": "Information about a candidate running for elected office.",
"id": "Candidate",
"properties": {
"candidateUrl": {
"description": "The URL for the candidate's campaign web site.",
"type": "string"
},
"channels": {
"description": "A list of known (social) media channels for this candidate.",
"items": {
"$ref": "Channel"
},
"type": "array"
},
"email": {
"description": "The email address for the candidate's campaign.",
"type": "string"
},
"name": {
"description": "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\"",
"type": "string"
},
"orderOnBallot": {
"description": "The order the candidate appears on the ballot for this contest.",
"format": "int64",
"type": "string"
},
"party": {
"description": "The full name of the party the candidate is a member of.",
"type": "string"
},
"phone": {
"description": "The voice phone number for the candidate's campaign office.",
"type": "string"
},
"photoUrl": {
"description": "A URL for a photo of the candidate.",
"type": "string"
}
},
"type": "object"
},
"Channel": {
"description": "A social media or web channel for a candidate.",
"id": "Channel",
"properties": {
"id": {
"description": "The unique public identifier for the candidate's channel.",
"type": "string"
},
"type": {
"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",
"type": "string"
}
},
"type": "object"
},
"Contest": {
"description": "Information about a contest that appears on a voter's ballot.",
"id": "Contest",
"properties": {
"ballotPlacement": {
"description": "A number specifying the position of this contest on the voter's ballot.",
"format": "int64",
"type": "string"
},
"ballotTitle": {
"description": "The official title on the ballot for this contest, only where available.",
"type": "string"
},
"candidates": {
"description": "The candidate choices for this contest.",
"items": {
"$ref": "Candidate"
},
"type": "array"
},
"district": {
"$ref": "ElectoralDistrict",
"description": "Information about the electoral district that this contest is in."
},
"electorateSpecifications": {
"description": "A description of any additional eligibility requirements for voting in this contest.",
"type": "string"
},
"level": {
"description": "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\".",
"items": {
"enum": [
"international",
"country",
"administrativeArea1",
"regional",
"administrativeArea2",
"locality",
"subLocality1",
"subLocality2",
"special"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"type": "array"
},
"numberElected": {
"description": "The number of candidates that will be elected to office in this contest.",
"format": "int64",
"type": "string"
},
"numberVotingFor": {
"description": "The number of candidates that a voter may vote for in this contest.",
"format": "int64",
"type": "string"
},
"office": {
"description": "The name of the office for this contest.",
"type": "string"
},
"primaryParties": {
"description": "If this is a partisan election, the name of the party/parties it is for.",
"items": {
"type": "string"
},
"type": "array"
},
"referendumBallotResponses": {
"description": "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'.",
"items": {
"type": "string"
},
"type": "array"
},
"referendumBrief": {
"description": "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'.",
"type": "string"
},
"referendumConStatement": {
"description": "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'.",
"type": "string"
},
"referendumEffectOfAbstain": {
"description": "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'.",
"type": "string"
},
"referendumPassageThreshold": {
"description": "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'.",
"type": "string"
},
"referendumProStatement": {
"description": "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'.",
"type": "string"
},
"referendumSubtitle": {
"description": "A brief description of the referendum. This field is only populated for contests of type 'Referendum'.",
"type": "string"
},
"referendumText": {
"description": "The full text of the referendum. This field is only populated for contests of type 'Referendum'.",
"type": "string"
},
"referendumTitle": {
"description": "The title of the referendum (e.g. 'Proposition 42'). This field is only populated for contests of type 'Referendum'.",
"type": "string"
},
"referendumUrl": {
"description": "A link to the referendum. This field is only populated for contests of type 'Referendum'.",
"type": "string"
},
"roles": {
"description": "The roles which this office fulfills.",
"items": {
"enum": [
"headOfState",
"headOfGovernment",
"deputyHeadOfGovernment",
"governmentOfficer",
"executiveCouncil",
"legislatorUpperBody",
"legislatorLowerBody",
"highestCourtJudge",
"judge",
"schoolBoard",
"specialPurposeOfficer",
"otherRole"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"type": "array"
},
"sources": {
"description": "A list of sources for this contest. If multiple sources are listed, the data has been aggregated from those sources.",
"items": {
"$ref": "Source"
},
"type": "array"
},
"special": {
"description": "\"Yes\" or \"No\" depending on whether this a contest being held outside the normal election cycle.",
"type": "string"
},
"type": {
"description": "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'.",
"type": "string"
}
},
"type": "object"
},
"DivisionSearchResponse": {
"description": "The result of a division search query.",
"id": "DivisionSearchResponse",
"properties": {
"kind": {
"default": "civicinfo#divisionSearchResponse",
"description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#divisionSearchResponse\".",
"type": "string"
},
"results": {
"items": {
"$ref": "DivisionSearchResult"
},
"type": "array"
}
},
"type": "object"
},
"DivisionSearchResult": {
"description": "Represents a political geographic division that matches the requested query.",
"id": "DivisionSearchResult",
"properties": {
"aliases": {
"description": "Other Open Civic Data identifiers that refer to the same division -- for example, those that refer to other political divisions whose boundaries are defined to be coterminous with this one. For example, ocd-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.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the division.",
"type": "string"
},
"ocdId": {
"description": "The unique Open Civic Data identifier for this division",
"type": "string"
}
},
"type": "object"
},
"Election": {
"description": "Information about the election that was queried.",
"id": "Election",
"properties": {
"electionDay": {
"description": "Day of the election in YYYY-MM-DD format.",
"type": "string"
},
"id": {
"description": "The unique ID of this election.",
"format": "int64",
"type": "string"
},
"name": {
"description": "A displayable name for the election.",
"type": "string"
},
"ocdDivisionId": {
"description": "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).",
"type": "string"
},
"shapeLookupBehavior": {
"enum": [
"shapeLookupDefault",
"shapeLookupDisabled",
"shapeLookupEnabled"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"ElectionOfficial": {
"description": "Information about individual election officials.",
"id": "ElectionOfficial",
"properties": {
"emailAddress": {
"description": "The email address of the election official.",
"type": "string"
},
"faxNumber": {
"description": "The fax number of the election official.",
"type": "string"
},
"name": {
"description": "The full name of the election official.",
"type": "string"
},
"officePhoneNumber": {
"description": "The office phone number of the election official.",
"type": "string"
},
"title": {
"description": "The title of the election official.",
"type": "string"
}
},
"type": "object"
},
"ElectionsQueryResponse": {
"description": "The list of elections available for this version of the API.",
"id": "ElectionsQueryResponse",
"properties": {
"elections": {
"description": "A list of available elections",
"items": {
"$ref": "Election"
},
"type": "array"
},
"kind": {
"default": "civicinfo#electionsQueryResponse",
"description": "Identifies what kind of resource this is. Value: the fixed string \"civicinfo#electionsQueryResponse\".",
"type": "string"
}
},
"type": "object"
},
"ElectoralDistrict": {
"description": "Describes the geographic scope of a contest.",
"id": "ElectoralDistrict",
"properties": {
"id": {
"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.",
"type": "string"
},
"name": {
"description": "The name of the district.",
"type": "string"
},
"scope": {
"description": "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",
"enum": [
"statewide",
"congressional",
"stateUpper",
"stateLower",
"countywide",
"judicial",
"schoolBoard",
"citywide",
"special",
"countyCouncil",
"township",
"ward",
"cityCouncil",
"national"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"FeatureIdProto": {
"description": "A globally unique identifier associated with each feature. We use 128-bit identifiers so that we have lots of bits available to distinguish between features. The feature id currently consists of a 64-bit \"cell id\" that **sometimes** corresponds to the approximate centroid of the feature, plus a 64-bit fingerprint of other identifying information. See more on each respective field in its comments. Feature ids are first assigned when the data is created in MapFacts. After initial creation of the feature, they are immutable. This means that the only properties that you should rely on are that they are unique, and that cell_ids often - but not always - preserve spatial locality. The degree of locality varies as the feature undergoes geometry changes, and should not in general be considered a firm guarantee of the location of any particular feature. In fact, some locationless features have randomized cell IDs! Consumers of FeatureProtos from Mapfacts are guaranteed that fprints in the id field of features will be globally unique. Using the fprint allows consumers who don't need the spatial benefit of cell ids to uniquely identify features in a 64-bit address space. This property is not guaranteed for other sources of FeatureProtos.",
"id": "FeatureIdProto",
"properties": {
"cellId": {
"description": "The S2CellId corresponding to the approximate location of this feature as of when it was first created. This can be of variable accuracy, ranging from the exact centroid of the feature at creation, a very large S2 Cell, or even being completely randomized for locationless features. Cell ids have the nice property that they follow a space-filling curve over the surface of the earth. (See s2cellid.h for details.) WARNING: Clients should only use cell IDs to perform spatial locality optimizations. There is no strict guarantee that the cell ID of a feature is related to the current geometry of the feature in any way.",
"format": "uint64",
"type": "string"
},
"fprint": {
"description": "A 64-bit fingerprint used to identify features. Most clients should rely on MapFacts or OneRing to choose fingerprints. If creating new fprints, the strategy should be chosen so that the chance of collision is remote or non-existent, and the distribution should be reasonably uniform. For example, if the source data assigns unique ids to features, then a fingerprint of the provider name, version, and source id is sufficient.",
"format": "uint64",
"type": "string"
},
"temporaryData": {
"$ref": "MessageSet",
"description": "A place for clients to attach arbitrary data to a feature ID. Never set in MapFacts."
}
},
"type": "object"
},
"GeocodingSummary": {
"description": "Detailed summary of the result from geocoding an address",
"id": "GeocodingSummary",
"properties": {
"addressUnderstood": {
"description": "Represents the best estimate of whether or not the input address was fully understood and the address is correctly componentized. Mirrors the same-name field in geostore.staging.AddressLinkupScoringProto.",
"type": "boolean"
},
"featureId": {
"$ref": "FeatureIdProto",
"description": "The ID of the FeatureProto returned by the geocoder"
},
"featureType": {
"description": "The feature type for the FeatureProto returned by the geocoder",
"enum": [
"typeAny",
"typeTransportation",
"typeRoute",
"typeDeprecatedHighwayDoNotUse",
"typeHighway",
"typeHighway1",
"typeHighway2",
"typeHighway3",
"typeHighway4",
"typeHighway5",
"typeHighway6",
"typeHighway7",
"typeHighway8",
"typeHighway9",
"typeBicycleRoute",
"typeTrail",
"typeSegment",
"typeRoad",
"typeRailway",
"typeStandardTrack",
"typeJrTrack",
"typeNarrowTrack",
"typeMonorailTrack",
"typeSubwayTrack",
"typeLightRailTrack",
"typeBroadTrack",
"typeHighSpeedRail",
"typeTrolleyTrack",
"typeFerry",
"typeFerryBoat",
"typeFerryTrain",
"typeVirtualSegment",
"typeIntersection",
"typeTransit",
"typeTransitStation",
"typeBusStation",
"typeTramwayStation",
"typeTrainStation",
"typeSubwayStation",
"typeFerryTerminal",
"typeAirport",
"typeAirportCivil",
"typeAirportMilitary",
"typeAirportMixed",
"typeHeliport",
"typeSeaplaneBase",
"typeAirstrip",
"typeCableCarStation",
"typeGondolaLiftStation",
"typeFunicularStation",
"typeSpecialStation",
"typeHorseCarriageStation",
"typeMonorailStation",
"typeSeaport",
"typeTransitStop",
"typeTransitTrip",
"typeTransitDeparture",
"typeTransitLeg",
"typeTransitLine",
"typeTransitAgencyDeprecatedValue",
"typeTransitTransfer",
"typeSegmentPath",
"typeRoadSign",
"typeIntersectionGroup",
"typePathway",
"typeRestrictionGroup",
"typeTollCluster",
"typePolitical",
"typeCountry",
"typeAdministrativeArea",
"typeAdministrativeArea1",
"typeUsState",
"typeGbCountry",
"typeJpTodoufuken",
"typeAdministrativeArea2",
"typeGbFormerPostalCounty",
"typeGbTraditionalCounty",
"typeAdministrativeArea3",
"typeAdministrativeArea4",
"typeAdministrativeArea5",
"typeAdministrativeArea6",
"typeAdministrativeArea7",
"typeAdministrativeArea8",
"typeAdministrativeArea9",
"typeColloquialArea",
"typeReservation",
"typeLocality",
"typeGbPostTown",
"typeJpGun",
"typeJpShikuchouson",
"typeJpSubShikuchouson",
"typeColloquialCity",
"typeSublocality",
"typeUsBorough",
"typeGbDependentLocality",
"typeJpOoaza",
"typeJpKoaza",
"typeJpGaiku",
"typeGbDoubleDependentLocality",
"typeJpChiban",
"typeJpEdaban",
"typeSublocality1",