blocks-api-docs 0.0.9 → 0.0.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,2597 +0,0 @@
1
- {
2
- "info": {
3
- "version": "1.0.0",
4
- "title": "Blocks API"
5
- },
6
- "components": {
7
- "parameters": {
8
- "Fields": {
9
- "in": "query",
10
- "name": "fields",
11
- "description": "Fields to include in response data, grouped by type",
12
- "schema": {
13
- "type": "object",
14
- "additionalProperties": {
15
- "type": "string"
16
- }
17
- },
18
- "example": {
19
- "accounts/users": "first_name,last_name"
20
- },
21
- "explode": false
22
- },
23
- "Filter": {
24
- "in": "query",
25
- "name": "filter",
26
- "description": "Criteria to limit which data is returned",
27
- "schema": {
28
- "type": "object",
29
- "properties": {
30
- "view": {
31
- "type": "integer"
32
- },
33
- "rules": {
34
- "type": "array",
35
- "items": {
36
- "type": "string",
37
- "description": "Column to filter on and either an operator, a param or both, in the format column:operator:param",
38
- "example": "first_name:contains:mary"
39
- }
40
- },
41
- "conjunction": {
42
- "default": "exclusive",
43
- "type": "string",
44
- "enum": [
45
- "inclusive",
46
- "exclusive"
47
- ]
48
- }
49
- },
50
- "oneOf": [
51
- {
52
- "required": [
53
- "view"
54
- ]
55
- },
56
- {
57
- "required": [
58
- "rules"
59
- ]
60
- }
61
- ]
62
- },
63
- "style": "deepObject",
64
- "examples": {
65
- "rules_filter": {
66
- "value": {
67
- "rules": [
68
- "first_name:contains:mary"
69
- ]
70
- },
71
- "summary": "Filter by rules"
72
- },
73
- "view_filter": {
74
- "value": {
75
- "view": 1
76
- },
77
- "summary": "Filter by view"
78
- }
79
- }
80
- },
81
- "Page": {
82
- "in": "query",
83
- "name": "page",
84
- "description": "Configure how response data is paginated",
85
- "schema": {
86
- "type": "object",
87
- "properties": {
88
- "size": {
89
- "type": "integer"
90
- },
91
- "number": {
92
- "type": "integer"
93
- }
94
- }
95
- },
96
- "style": "deepObject"
97
- },
98
- "Sort": {
99
- "in": "query",
100
- "name": "sort",
101
- "description": "Fields to sort on optionally prefixed with '-' to reverse order",
102
- "schema": {
103
- "type": "array",
104
- "items": {
105
- "type": "string"
106
- }
107
- },
108
- "example": [
109
- "-last_name",
110
- "first_name"
111
- ],
112
- "explode": false
113
- }
114
- },
115
- "responses": {
116
- "Empty": {
117
- "description": "No response body"
118
- },
119
- "InvalidParams": {
120
- "description": "Invalid params for action",
121
- "content": {
122
- "application/vnd.api+json": {
123
- "schema": {
124
- "$ref": "#/components/schemas/ErrorList"
125
- }
126
- }
127
- }
128
- },
129
- "UnexpectedParams": {
130
- "description": "Unexpected and/or incorrect params for action",
131
- "content": {
132
- "application/vnd.api+json": {
133
- "schema": {
134
- "$ref": "#/components/schemas/ErrorList"
135
- }
136
- }
137
- }
138
- }
139
- },
140
- "schemas": {
141
- "Relationship": {
142
- "type": "object",
143
- "properties": {
144
- "data": {
145
- "type": "object",
146
- "properties": {
147
- "id": {
148
- "type": "integer"
149
- },
150
- "type": {
151
- "type": "string"
152
- }
153
- }
154
- },
155
- "links": {
156
- "type": "object",
157
- "properties": {
158
- "related": {
159
- "type": "string",
160
- "format": "uri"
161
- }
162
- }
163
- }
164
- }
165
- },
166
- "ErrorList": {
167
- "type": "array",
168
- "items": {
169
- "type": "object",
170
- "properties": {
171
- "detail": {
172
- "type": "string"
173
- }
174
- }
175
- }
176
- },
177
- "PaginationLinks": {
178
- "type": "object",
179
- "properties": {
180
- "first": {
181
- "type": "string",
182
- "format": "uri"
183
- },
184
- "last": {
185
- "type": "string",
186
- "format": "uri"
187
- },
188
- "next": {
189
- "type": "string",
190
- "format": "uri"
191
- },
192
- "prev": {
193
- "type": "string",
194
- "format": "uri"
195
- }
196
- }
197
- },
198
- "AccountsToken": {
199
- "type": "object",
200
- "properties": {
201
- "attributes": {
202
- "type": "object",
203
- "properties": {}
204
- },
205
- "id": {
206
- "type": "string"
207
- },
208
- "type": {
209
- "const": "accounts/token"
210
- }
211
- }
212
- },
213
- "CanvassingCanvasser": {
214
- "type": "object",
215
- "properties": {
216
- "attributes": {
217
- "type": "object",
218
- "properties": {
219
- "first_name": {
220
- "type": "string"
221
- },
222
- "last_name": {
223
- "type": "string"
224
- },
225
- "phone_number": {
226
- "type": "string"
227
- },
228
- "email": {
229
- "type": "string"
230
- },
231
- "notes": {
232
- "type": "string"
233
- },
234
- "extras": {
235
- "type": "object"
236
- },
237
- "archived": {
238
- "type": "boolean"
239
- },
240
- "full_name": {
241
- "type": "string"
242
- },
243
- "all_time_counts": {
244
- "type": "object"
245
- }
246
- }
247
- },
248
- "id": {
249
- "type": "integer"
250
- },
251
- "type": {
252
- "const": "canvassing/canvasser"
253
- }
254
- }
255
- },
256
- "CanvassingShift": {
257
- "type": "object",
258
- "properties": {
259
- "attributes": {
260
- "type": "object",
261
- "properties": {
262
- "soft_count_cards_total_collected": {
263
- "type": "integer"
264
- },
265
- "soft_count_cards_complete_collected": {
266
- "type": "integer"
267
- },
268
- "soft_count_cards_incomplete_collected": {
269
- "type": "integer"
270
- },
271
- "soft_count_cards_with_phone_collected": {
272
- "type": "integer"
273
- },
274
- "soft_count_pre_registration_cards_collected": {
275
- "type": "integer"
276
- },
277
- "shift_start": {
278
- "type": "string",
279
- "format": "date-time"
280
- },
281
- "shift_end": {
282
- "type": "string",
283
- "format": "date-time"
284
- },
285
- "field_start": {
286
- "type": "string",
287
- "format": "date-time"
288
- },
289
- "field_end": {
290
- "type": "string",
291
- "format": "date-time"
292
- },
293
- "ready_for_qc_at": {
294
- "type": "string",
295
- "format": "date-time"
296
- },
297
- "ready_for_phone_verification_at": {
298
- "type": "string",
299
- "format": "date-time"
300
- },
301
- "completed_at": {
302
- "type": "string",
303
- "format": "date-time"
304
- },
305
- "notes": {
306
- "type": "string"
307
- },
308
- "tags": {
309
- "type": "array",
310
- "items": {
311
- "type": "string"
312
- }
313
- },
314
- "type": {
315
- "type": "string",
316
- "enum": [
317
- "voter_registration",
318
- "petitions"
319
- ]
320
- },
321
- "delivered": {
322
- "type": "boolean"
323
- },
324
- "name": {
325
- "type": "string"
326
- },
327
- "qc_deadline": {
328
- "type": "string",
329
- "format": "date-time"
330
- },
331
- "status": {
332
- "type": "string",
333
- "enum": [
334
- "ready_for_scans",
335
- "ready_for_separation",
336
- "ready_for_qc",
337
- "in_qc",
338
- "ready_for_phone_verification",
339
- "in_phone_verification",
340
- "ready_for_delivery",
341
- "completed"
342
- ]
343
- }
344
- }
345
- },
346
- "id": {
347
- "type": "integer"
348
- },
349
- "type": {
350
- "const": "canvassing/shift"
351
- }
352
- }
353
- },
354
- "QualityControlFormIssue": {
355
- "type": "object",
356
- "properties": {
357
- "attributes": {
358
- "type": "object",
359
- "properties": {}
360
- },
361
- "id": {
362
- "type": "integer"
363
- },
364
- "type": {
365
- "const": "quality_control/form_issue"
366
- }
367
- }
368
- },
369
- "QualityControlIssue": {
370
- "type": "object",
371
- "properties": {
372
- "attributes": {
373
- "type": "object",
374
- "properties": {
375
- "name": {
376
- "type": "string"
377
- },
378
- "description": {
379
- "type": "string"
380
- }
381
- }
382
- },
383
- "id": {
384
- "type": "integer"
385
- },
386
- "type": {
387
- "const": "quality_control/issue"
388
- }
389
- }
390
- },
391
- "TurfsLocation": {
392
- "type": "object",
393
- "properties": {
394
- "attributes": {
395
- "type": "object",
396
- "properties": {
397
- "name": {
398
- "type": "string"
399
- },
400
- "street_address": {
401
- "type": "string"
402
- },
403
- "city": {
404
- "type": "string"
405
- },
406
- "state": {
407
- "type": "string"
408
- },
409
- "county": {
410
- "type": "string"
411
- },
412
- "zipcode": {
413
- "type": "string"
414
- },
415
- "timezone": {
416
- "type": "string",
417
- "enum": [
418
- "America/New_York",
419
- "America/Chicago",
420
- "America/Denver",
421
- "America/Phoenix",
422
- "America/Los_Angeles",
423
- "America/Anchorage",
424
- "Pacific/Honolulu",
425
- "America/Adak"
426
- ]
427
- },
428
- "notes": {
429
- "type": "string"
430
- },
431
- "geoid": {
432
- "type": "string"
433
- },
434
- "category": {
435
- "type": "string"
436
- },
437
- "delivery_point_barcode": {
438
- "type": "string"
439
- },
440
- "location_type": {
441
- "type": "string",
442
- "enum": [
443
- "canvassing",
444
- "delivery",
445
- "venue"
446
- ]
447
- }
448
- }
449
- },
450
- "id": {
451
- "type": "integer"
452
- },
453
- "type": {
454
- "const": "turfs/location"
455
- }
456
- }
457
- },
458
- "TurfsTurf": {
459
- "type": "object",
460
- "properties": {
461
- "attributes": {
462
- "type": "object",
463
- "properties": {
464
- "name": {
465
- "type": "string"
466
- }
467
- }
468
- },
469
- "id": {
470
- "type": "integer"
471
- },
472
- "type": {
473
- "const": "turfs/turf"
474
- }
475
- }
476
- },
477
- "ViewsFile": {
478
- "type": "object",
479
- "properties": {
480
- "attributes": {
481
- "type": "object",
482
- "properties": {
483
- "metadata": {
484
- "type": "object",
485
- "properties": {
486
- "additionalProperties": true
487
- }
488
- },
489
- "url": {
490
- "type": "string",
491
- "format": "uri"
492
- }
493
- }
494
- },
495
- "id": {
496
- "type": "string"
497
- },
498
- "type": {
499
- "const": "views/file"
500
- }
501
- }
502
- },
503
- "VoterRegistrationForm": {
504
- "type": "object",
505
- "properties": {
506
- "attributes": {
507
- "type": "object",
508
- "properties": {
509
- "scan_number": {
510
- "type": "integer"
511
- },
512
- "phone_number": {
513
- "type": "string"
514
- },
515
- "first_name": {
516
- "type": "string"
517
- },
518
- "last_name": {
519
- "type": "string"
520
- },
521
- "date_of_birth": {
522
- "type": "string",
523
- "format": "date"
524
- },
525
- "middle_name": {
526
- "type": "string"
527
- },
528
- "name_suffix": {
529
- "type": "string"
530
- },
531
- "email_address": {
532
- "type": "string"
533
- },
534
- "voting_street_address_one": {
535
- "type": "string"
536
- },
537
- "voting_street_address_two": {
538
- "type": "string"
539
- },
540
- "voting_city": {
541
- "type": "string"
542
- },
543
- "voting_state": {
544
- "type": "string"
545
- },
546
- "voting_zipcode": {
547
- "type": "string"
548
- },
549
- "county": {
550
- "type": "string"
551
- },
552
- "mailing_street_address_one": {
553
- "type": "string"
554
- },
555
- "mailing_street_address_two": {
556
- "type": "string"
557
- },
558
- "mailing_city": {
559
- "type": "string"
560
- },
561
- "mailing_state": {
562
- "type": "string"
563
- },
564
- "mailing_zipcode": {
565
- "type": "string"
566
- },
567
- "gender": {
568
- "type": "string"
569
- },
570
- "us_citizen": {
571
- "type": "boolean"
572
- },
573
- "eligible_voting_age": {
574
- "type": "boolean"
575
- },
576
- "signature": {
577
- "type": "boolean"
578
- },
579
- "social_security": {
580
- "type": "boolean"
581
- },
582
- "state_id": {
583
- "type": "boolean"
584
- },
585
- "ethnicity": {
586
- "type": "string"
587
- },
588
- "registration_date": {
589
- "type": "string",
590
- "format": "date"
591
- },
592
- "hard_copy_collected": {
593
- "type": "boolean"
594
- },
595
- "registration_type": {
596
- "type": "string"
597
- },
598
- "notes": {
599
- "type": "string"
600
- },
601
- "reviewed_at": {
602
- "type": "string",
603
- "format": "date-time"
604
- },
605
- "visual_review_approved": {
606
- "type": "boolean"
607
- },
608
- "custom_field_data": {
609
- "type": "object"
610
- }
611
- }
612
- },
613
- "id": {
614
- "type": "integer"
615
- },
616
- "type": {
617
- "const": "voter_registration/form"
618
- }
619
- }
620
- }
621
- }
622
- },
623
- "paths": {
624
- "/accounts/token": {
625
- "post": {
626
- "parameters": [],
627
- "responses": {
628
- "200": {
629
- "description": "accounts/token create was successful",
630
- "content": {
631
- "application/vnd.api+json": {
632
- "schema": {
633
- "type": "object",
634
- "properties": {
635
- "data": {
636
- "allOf": [
637
- {
638
- "$ref": "#/components/schemas/AccountsToken"
639
- },
640
- {}
641
- ]
642
- }
643
- }
644
- }
645
- }
646
- }
647
- },
648
- "400": {
649
- "$ref": "#/components/responses/UnexpectedParams"
650
- },
651
- "422": {
652
- "$ref": "#/components/responses/InvalidParams"
653
- }
654
- },
655
- "requestBody": {
656
- "content": {
657
- "application/vnd.api+json": {
658
- "schema": {
659
- "type": "object",
660
- "required": [
661
- "data"
662
- ],
663
- "properties": {
664
- "data": {
665
- "type": "object",
666
- "required": [
667
- "type"
668
- ],
669
- "properties": {
670
- "attributes": {
671
- "type": "object",
672
- "properties": {
673
- "password": {
674
- "type": "string"
675
- },
676
- "email": {
677
- "type": "string"
678
- },
679
- "tenant": {
680
- "type": "string"
681
- }
682
- }
683
- },
684
- "type": {
685
- "const": "accounts/token",
686
- "type": "string"
687
- }
688
- }
689
- }
690
- }
691
- }
692
- }
693
- }
694
- },
695
- "operationId": "accounts/token-create"
696
- }
697
- },
698
- "/canvassing/canvassers": {
699
- "get": {
700
- "parameters": [
701
- {
702
- "$ref": "#/components/parameters/Sort"
703
- },
704
- {
705
- "$ref": "#/components/parameters/Fields"
706
- },
707
- {
708
- "$ref": "#/components/parameters/Page"
709
- },
710
- {
711
- "$ref": "#/components/parameters/Filter"
712
- }
713
- ],
714
- "responses": {
715
- "200": {
716
- "description": "Lists canvassing/canvasser",
717
- "content": {
718
- "application/vnd.api+json": {
719
- "schema": {
720
- "type": "object",
721
- "properties": {
722
- "data": {
723
- "type": "array",
724
- "items": {
725
- "allOf": [
726
- {
727
- "$ref": "#/components/schemas/CanvassingCanvasser"
728
- },
729
- {
730
- "type": "object",
731
- "properties": {
732
- "relationships": {
733
- "type": "object",
734
- "properties": {
735
- "turf": {
736
- "allOf": [
737
- {
738
- "$ref": "#/components/schemas/Relationship"
739
- },
740
- {
741
- "example": {
742
- "data": {
743
- "id": 1,
744
- "type": "turfs/turf"
745
- }
746
- }
747
- }
748
- ]
749
- }
750
- }
751
- }
752
- }
753
- }
754
- ]
755
- }
756
- },
757
- "links": {
758
- "$ref": "#/components/schemas/PaginationLinks"
759
- },
760
- "includes": {
761
- "type": "array",
762
- "items": {
763
- "anyOf": [
764
- {
765
- "$ref": "#/components/schemas/TurfsTurf"
766
- }
767
- ]
768
- }
769
- }
770
- }
771
- }
772
- }
773
- }
774
- },
775
- "400": {
776
- "$ref": "#/components/responses/UnexpectedParams"
777
- }
778
- },
779
- "operationId": "canvassing/canvasser-index"
780
- },
781
- "post": {
782
- "parameters": [
783
- {
784
- "$ref": "#/components/parameters/Fields"
785
- }
786
- ],
787
- "responses": {
788
- "200": {
789
- "description": "canvassing/canvasser create was successful",
790
- "content": {
791
- "application/vnd.api+json": {
792
- "schema": {
793
- "type": "object",
794
- "properties": {
795
- "data": {
796
- "allOf": [
797
- {
798
- "$ref": "#/components/schemas/CanvassingCanvasser"
799
- },
800
- {
801
- "type": "object",
802
- "properties": {
803
- "relationships": {
804
- "type": "object",
805
- "properties": {
806
- "turf": {
807
- "allOf": [
808
- {
809
- "$ref": "#/components/schemas/Relationship"
810
- },
811
- {
812
- "example": {
813
- "data": {
814
- "id": 1,
815
- "type": "turfs/turf"
816
- }
817
- }
818
- }
819
- ]
820
- }
821
- }
822
- }
823
- }
824
- }
825
- ]
826
- },
827
- "includes": {
828
- "type": "array",
829
- "items": {
830
- "anyOf": [
831
- {
832
- "$ref": "#/components/schemas/TurfsTurf"
833
- }
834
- ]
835
- }
836
- }
837
- }
838
- }
839
- }
840
- }
841
- },
842
- "400": {
843
- "$ref": "#/components/responses/UnexpectedParams"
844
- },
845
- "422": {
846
- "$ref": "#/components/responses/InvalidParams"
847
- }
848
- },
849
- "requestBody": {
850
- "content": {
851
- "application/vnd.api+json": {
852
- "schema": {
853
- "type": "object",
854
- "required": [
855
- "data"
856
- ],
857
- "properties": {
858
- "data": {
859
- "type": "object",
860
- "required": [
861
- "type"
862
- ],
863
- "properties": {
864
- "attributes": {
865
- "type": "object",
866
- "required": [],
867
- "properties": {
868
- "email": {
869
- "type": "string"
870
- },
871
- "first_name": {
872
- "type": "string"
873
- },
874
- "last_name": {
875
- "type": "string"
876
- },
877
- "notes": {
878
- "type": "string"
879
- },
880
- "phone_number": {
881
- "type": "string"
882
- },
883
- "turf_id": {
884
- "type": "integer"
885
- }
886
- }
887
- },
888
- "type": {
889
- "const": "canvassing/canvasser",
890
- "type": "string"
891
- }
892
- }
893
- }
894
- }
895
- }
896
- }
897
- }
898
- },
899
- "operationId": "canvassing/canvasser-create"
900
- }
901
- },
902
- "/canvassing/canvassers/{id}": {
903
- "get": {
904
- "parameters": [
905
- {
906
- "in": "path",
907
- "name": "id",
908
- "required": true,
909
- "schema": {
910
- "type": "integer"
911
- }
912
- },
913
- {
914
- "$ref": "#/components/parameters/Fields"
915
- }
916
- ],
917
- "responses": {
918
- "200": {
919
- "description": "canvassing/canvasser show was successful",
920
- "content": {
921
- "application/vnd.api+json": {
922
- "schema": {
923
- "type": "object",
924
- "properties": {
925
- "data": {
926
- "allOf": [
927
- {
928
- "$ref": "#/components/schemas/CanvassingCanvasser"
929
- },
930
- {
931
- "type": "object",
932
- "properties": {
933
- "relationships": {
934
- "type": "object",
935
- "properties": {
936
- "turf": {
937
- "allOf": [
938
- {
939
- "$ref": "#/components/schemas/Relationship"
940
- },
941
- {
942
- "example": {
943
- "data": {
944
- "id": 1,
945
- "type": "turfs/turf"
946
- }
947
- }
948
- }
949
- ]
950
- }
951
- }
952
- }
953
- }
954
- }
955
- ]
956
- },
957
- "includes": {
958
- "type": "array",
959
- "items": {
960
- "anyOf": [
961
- {
962
- "$ref": "#/components/schemas/TurfsTurf"
963
- }
964
- ]
965
- }
966
- }
967
- }
968
- }
969
- }
970
- }
971
- },
972
- "400": {
973
- "$ref": "#/components/responses/UnexpectedParams"
974
- }
975
- },
976
- "operationId": "canvassing/canvasser-show"
977
- },
978
- "put": {
979
- "parameters": [
980
- {
981
- "in": "path",
982
- "name": "id",
983
- "required": true,
984
- "schema": {
985
- "type": "integer"
986
- }
987
- },
988
- {
989
- "$ref": "#/components/parameters/Fields"
990
- }
991
- ],
992
- "responses": {
993
- "200": {
994
- "description": "canvassing/canvasser update was successful",
995
- "content": {
996
- "application/vnd.api+json": {
997
- "schema": {
998
- "type": "object",
999
- "properties": {
1000
- "data": {
1001
- "allOf": [
1002
- {
1003
- "$ref": "#/components/schemas/CanvassingCanvasser"
1004
- },
1005
- {
1006
- "type": "object",
1007
- "properties": {
1008
- "relationships": {
1009
- "type": "object",
1010
- "properties": {
1011
- "turf": {
1012
- "allOf": [
1013
- {
1014
- "$ref": "#/components/schemas/Relationship"
1015
- },
1016
- {
1017
- "example": {
1018
- "data": {
1019
- "id": 1,
1020
- "type": "turfs/turf"
1021
- }
1022
- }
1023
- }
1024
- ]
1025
- }
1026
- }
1027
- }
1028
- }
1029
- }
1030
- ]
1031
- },
1032
- "includes": {
1033
- "type": "array",
1034
- "items": {
1035
- "anyOf": [
1036
- {
1037
- "$ref": "#/components/schemas/TurfsTurf"
1038
- }
1039
- ]
1040
- }
1041
- }
1042
- }
1043
- }
1044
- }
1045
- }
1046
- },
1047
- "400": {
1048
- "$ref": "#/components/responses/UnexpectedParams"
1049
- },
1050
- "422": {
1051
- "$ref": "#/components/responses/InvalidParams"
1052
- }
1053
- },
1054
- "requestBody": {
1055
- "content": {
1056
- "application/vnd.api+json": {
1057
- "schema": {
1058
- "type": "object",
1059
- "required": [
1060
- "data"
1061
- ],
1062
- "properties": {
1063
- "data": {
1064
- "type": "object",
1065
- "required": [
1066
- "type"
1067
- ],
1068
- "properties": {
1069
- "attributes": {
1070
- "type": "object",
1071
- "required": [],
1072
- "properties": {
1073
- "email": {
1074
- "type": "string"
1075
- },
1076
- "first_name": {
1077
- "type": "string"
1078
- },
1079
- "last_name": {
1080
- "type": "string"
1081
- },
1082
- "notes": {
1083
- "type": "string"
1084
- },
1085
- "phone_number": {
1086
- "type": "string"
1087
- },
1088
- "turf_id": {
1089
- "type": "integer"
1090
- },
1091
- "archived": {
1092
- "type": "boolean"
1093
- }
1094
- }
1095
- },
1096
- "type": {
1097
- "const": "canvassing/canvasser",
1098
- "type": "string"
1099
- }
1100
- }
1101
- }
1102
- }
1103
- }
1104
- }
1105
- }
1106
- },
1107
- "operationId": "canvassing/canvasser-update"
1108
- }
1109
- },
1110
- "/canvassing/shifts": {
1111
- "post": {
1112
- "parameters": [
1113
- {
1114
- "$ref": "#/components/parameters/Fields"
1115
- }
1116
- ],
1117
- "responses": {
1118
- "200": {
1119
- "description": "canvassing/shift create was successful",
1120
- "content": {
1121
- "application/vnd.api+json": {
1122
- "schema": {
1123
- "type": "object",
1124
- "properties": {
1125
- "data": {
1126
- "allOf": [
1127
- {
1128
- "$ref": "#/components/schemas/CanvassingShift"
1129
- },
1130
- {
1131
- "type": "object",
1132
- "properties": {
1133
- "relationships": {
1134
- "type": "object",
1135
- "properties": {
1136
- "location": {
1137
- "allOf": [
1138
- {
1139
- "$ref": "#/components/schemas/Relationship"
1140
- },
1141
- {
1142
- "example": {
1143
- "data": {
1144
- "id": 1,
1145
- "type": "turfs/location"
1146
- }
1147
- }
1148
- }
1149
- ]
1150
- },
1151
- "canvasser": {
1152
- "allOf": [
1153
- {
1154
- "$ref": "#/components/schemas/Relationship"
1155
- },
1156
- {
1157
- "example": {
1158
- "data": {
1159
- "id": 1,
1160
- "type": "canvassing/canvasser"
1161
- }
1162
- }
1163
- }
1164
- ]
1165
- },
1166
- "turf": {
1167
- "allOf": [
1168
- {
1169
- "$ref": "#/components/schemas/Relationship"
1170
- },
1171
- {
1172
- "example": {}
1173
- }
1174
- ]
1175
- }
1176
- }
1177
- }
1178
- }
1179
- }
1180
- ]
1181
- },
1182
- "includes": {
1183
- "type": "array",
1184
- "items": {
1185
- "anyOf": [
1186
- {
1187
- "$ref": "#/components/schemas/CanvassingCanvasser"
1188
- },
1189
- {
1190
- "$ref": "#/components/schemas/TurfsLocation"
1191
- }
1192
- ]
1193
- }
1194
- }
1195
- }
1196
- }
1197
- }
1198
- }
1199
- },
1200
- "400": {
1201
- "$ref": "#/components/responses/UnexpectedParams"
1202
- },
1203
- "422": {
1204
- "$ref": "#/components/responses/InvalidParams"
1205
- }
1206
- },
1207
- "requestBody": {
1208
- "content": {
1209
- "application/vnd.api+json": {
1210
- "schema": {
1211
- "type": "object",
1212
- "required": [
1213
- "data"
1214
- ],
1215
- "properties": {
1216
- "data": {
1217
- "type": "object",
1218
- "required": [
1219
- "type"
1220
- ],
1221
- "properties": {
1222
- "attributes": {
1223
- "type": "object",
1224
- "required": [],
1225
- "properties": {
1226
- "name": {
1227
- "type": "string"
1228
- },
1229
- "type": {
1230
- "type": "string",
1231
- "enum": [
1232
- "voter_registration",
1233
- "petitions"
1234
- ]
1235
- },
1236
- "location_id": {
1237
- "type": "integer"
1238
- },
1239
- "canvasser_id": {
1240
- "type": "integer"
1241
- },
1242
- "shift_start": {
1243
- "type": "string",
1244
- "format": "date-time"
1245
- },
1246
- "shift_end": {
1247
- "type": "string",
1248
- "format": "date-time"
1249
- },
1250
- "field_start": {
1251
- "type": "string",
1252
- "format": "date-time"
1253
- },
1254
- "field_end": {
1255
- "type": "string",
1256
- "format": "date-time"
1257
- },
1258
- "tags": {
1259
- "type": "array",
1260
- "items": {
1261
- "type": "string"
1262
- }
1263
- },
1264
- "soft_count_cards_total_collected": {
1265
- "type": "integer"
1266
- },
1267
- "soft_count_cards_complete_collected": {
1268
- "type": "integer"
1269
- },
1270
- "soft_count_cards_incomplete_collected": {
1271
- "type": "integer"
1272
- },
1273
- "soft_count_cards_with_phone_collected": {
1274
- "type": "integer"
1275
- },
1276
- "soft_count_pre_registration_cards_collected": {
1277
- "type": "integer"
1278
- }
1279
- }
1280
- },
1281
- "type": {
1282
- "const": "canvassing/shift",
1283
- "type": "string"
1284
- }
1285
- }
1286
- }
1287
- }
1288
- }
1289
- }
1290
- }
1291
- },
1292
- "operationId": "canvassing/shift-create"
1293
- }
1294
- },
1295
- "/canvassing/shifts/{id}": {
1296
- "put": {
1297
- "parameters": [
1298
- {
1299
- "in": "path",
1300
- "name": "id",
1301
- "required": true,
1302
- "schema": {
1303
- "type": "integer"
1304
- }
1305
- },
1306
- {
1307
- "$ref": "#/components/parameters/Fields"
1308
- }
1309
- ],
1310
- "responses": {
1311
- "200": {
1312
- "description": "canvassing/shift update was successful",
1313
- "content": {
1314
- "application/vnd.api+json": {
1315
- "schema": {
1316
- "type": "object",
1317
- "properties": {
1318
- "data": {
1319
- "allOf": [
1320
- {
1321
- "$ref": "#/components/schemas/CanvassingShift"
1322
- },
1323
- {
1324
- "type": "object",
1325
- "properties": {
1326
- "relationships": {
1327
- "type": "object",
1328
- "properties": {
1329
- "location": {
1330
- "allOf": [
1331
- {
1332
- "$ref": "#/components/schemas/Relationship"
1333
- },
1334
- {
1335
- "example": {
1336
- "data": {
1337
- "id": 1,
1338
- "type": "turfs/location"
1339
- }
1340
- }
1341
- }
1342
- ]
1343
- },
1344
- "canvasser": {
1345
- "allOf": [
1346
- {
1347
- "$ref": "#/components/schemas/Relationship"
1348
- },
1349
- {
1350
- "example": {
1351
- "data": {
1352
- "id": 1,
1353
- "type": "canvassing/canvasser"
1354
- }
1355
- }
1356
- }
1357
- ]
1358
- },
1359
- "turf": {
1360
- "allOf": [
1361
- {
1362
- "$ref": "#/components/schemas/Relationship"
1363
- },
1364
- {
1365
- "example": {}
1366
- }
1367
- ]
1368
- }
1369
- }
1370
- }
1371
- }
1372
- }
1373
- ]
1374
- },
1375
- "includes": {
1376
- "type": "array",
1377
- "items": {
1378
- "anyOf": [
1379
- {
1380
- "$ref": "#/components/schemas/CanvassingCanvasser"
1381
- },
1382
- {
1383
- "$ref": "#/components/schemas/TurfsLocation"
1384
- }
1385
- ]
1386
- }
1387
- }
1388
- }
1389
- }
1390
- }
1391
- }
1392
- },
1393
- "400": {
1394
- "$ref": "#/components/responses/UnexpectedParams"
1395
- },
1396
- "422": {
1397
- "$ref": "#/components/responses/InvalidParams"
1398
- }
1399
- },
1400
- "requestBody": {
1401
- "content": {
1402
- "application/vnd.api+json": {
1403
- "schema": {
1404
- "type": "object",
1405
- "required": [
1406
- "data"
1407
- ],
1408
- "properties": {
1409
- "data": {
1410
- "type": "object",
1411
- "required": [
1412
- "type"
1413
- ],
1414
- "properties": {
1415
- "attributes": {
1416
- "type": "object",
1417
- "required": [],
1418
- "properties": {
1419
- "notes": {
1420
- "type": "string"
1421
- },
1422
- "shift_start": {
1423
- "type": "string",
1424
- "format": "date-time"
1425
- },
1426
- "shift_end": {
1427
- "type": "string",
1428
- "format": "date-time"
1429
- },
1430
- "field_start": {
1431
- "type": "string",
1432
- "format": "date-time"
1433
- },
1434
- "field_end": {
1435
- "type": "string",
1436
- "format": "date-time"
1437
- },
1438
- "tags": {
1439
- "type": "array",
1440
- "items": {
1441
- "type": "string"
1442
- }
1443
- },
1444
- "soft_count_cards_total_collected": {
1445
- "type": "integer"
1446
- },
1447
- "soft_count_cards_complete_collected": {
1448
- "type": "integer"
1449
- },
1450
- "soft_count_cards_incomplete_collected": {
1451
- "type": "integer"
1452
- },
1453
- "soft_count_cards_with_phone_collected": {
1454
- "type": "integer"
1455
- },
1456
- "soft_count_pre_registration_cards_collected": {
1457
- "type": "integer"
1458
- }
1459
- }
1460
- },
1461
- "type": {
1462
- "const": "canvassing/shift",
1463
- "type": "string"
1464
- }
1465
- }
1466
- }
1467
- }
1468
- }
1469
- }
1470
- }
1471
- },
1472
- "operationId": "canvassing/shift-update"
1473
- }
1474
- },
1475
- "/canvassing/shifts/{shift_id}/send_to_qc": {
1476
- "put": {
1477
- "parameters": [
1478
- {
1479
- "in": "path",
1480
- "name": "shift_id",
1481
- "required": true,
1482
- "schema": {
1483
- "type": "integer"
1484
- }
1485
- }
1486
- ],
1487
- "responses": {
1488
- "200": {
1489
- "description": "Shift was successfully sent to QC",
1490
- "content": {
1491
- "application/vnd.api+json": {
1492
- "schema": {
1493
- "type": "object",
1494
- "properties": {
1495
- "data": {
1496
- "allOf": [
1497
- {
1498
- "$ref": "#/components/schemas/CanvassingShift"
1499
- },
1500
- {
1501
- "type": "object",
1502
- "properties": {
1503
- "relationships": {
1504
- "type": "object",
1505
- "properties": {
1506
- "location": {
1507
- "allOf": [
1508
- {
1509
- "$ref": "#/components/schemas/Relationship"
1510
- },
1511
- {
1512
- "example": {
1513
- "data": {
1514
- "id": 1,
1515
- "type": "turfs/location"
1516
- }
1517
- }
1518
- }
1519
- ]
1520
- },
1521
- "canvasser": {
1522
- "allOf": [
1523
- {
1524
- "$ref": "#/components/schemas/Relationship"
1525
- },
1526
- {
1527
- "example": {
1528
- "data": {
1529
- "id": 1,
1530
- "type": "canvassing/canvasser"
1531
- }
1532
- }
1533
- }
1534
- ]
1535
- },
1536
- "turf": {
1537
- "allOf": [
1538
- {
1539
- "$ref": "#/components/schemas/Relationship"
1540
- },
1541
- {
1542
- "example": {}
1543
- }
1544
- ]
1545
- }
1546
- }
1547
- }
1548
- }
1549
- }
1550
- ]
1551
- },
1552
- "includes": {
1553
- "type": "array",
1554
- "items": {
1555
- "anyOf": [
1556
- {
1557
- "$ref": "#/components/schemas/CanvassingCanvasser"
1558
- },
1559
- {
1560
- "$ref": "#/components/schemas/TurfsLocation"
1561
- }
1562
- ]
1563
- }
1564
- }
1565
- }
1566
- }
1567
- }
1568
- }
1569
- },
1570
- "400": {
1571
- "description": "Shift not eligible for QC",
1572
- "content": {
1573
- "application/json": {
1574
- "schema": {
1575
- "$ref": "#/components/schemas/ErrorList"
1576
- }
1577
- }
1578
- }
1579
- }
1580
- },
1581
- "operationId": "canvassing/shift-send_to_qc"
1582
- }
1583
- },
1584
- "/quality_control/issues": {
1585
- "get": {
1586
- "parameters": [
1587
- {
1588
- "$ref": "#/components/parameters/Sort"
1589
- },
1590
- {
1591
- "$ref": "#/components/parameters/Fields"
1592
- },
1593
- {
1594
- "$ref": "#/components/parameters/Page"
1595
- },
1596
- {
1597
- "$ref": "#/components/parameters/Filter"
1598
- }
1599
- ],
1600
- "responses": {
1601
- "200": {
1602
- "description": "Lists quality_control/issue",
1603
- "content": {
1604
- "application/vnd.api+json": {
1605
- "schema": {
1606
- "type": "object",
1607
- "properties": {
1608
- "data": {
1609
- "type": "array",
1610
- "items": {
1611
- "allOf": [
1612
- {
1613
- "$ref": "#/components/schemas/QualityControlIssue"
1614
- },
1615
- {}
1616
- ]
1617
- }
1618
- },
1619
- "links": {
1620
- "$ref": "#/components/schemas/PaginationLinks"
1621
- }
1622
- }
1623
- }
1624
- }
1625
- }
1626
- },
1627
- "400": {
1628
- "$ref": "#/components/responses/UnexpectedParams"
1629
- }
1630
- },
1631
- "operationId": "quality_control/issue-index"
1632
- }
1633
- },
1634
- "/turfs": {
1635
- "get": {
1636
- "parameters": [
1637
- {
1638
- "$ref": "#/components/parameters/Sort"
1639
- },
1640
- {
1641
- "$ref": "#/components/parameters/Fields"
1642
- },
1643
- {
1644
- "$ref": "#/components/parameters/Page"
1645
- },
1646
- {
1647
- "$ref": "#/components/parameters/Filter"
1648
- }
1649
- ],
1650
- "responses": {
1651
- "200": {
1652
- "description": "Lists turfs/turf",
1653
- "content": {
1654
- "application/vnd.api+json": {
1655
- "schema": {
1656
- "type": "object",
1657
- "properties": {
1658
- "data": {
1659
- "type": "array",
1660
- "items": {
1661
- "allOf": [
1662
- {
1663
- "$ref": "#/components/schemas/TurfsTurf"
1664
- },
1665
- {
1666
- "type": "object",
1667
- "properties": {
1668
- "relationships": {
1669
- "type": "object",
1670
- "properties": {
1671
- "shifts": {
1672
- "allOf": [
1673
- {
1674
- "$ref": "#/components/schemas/Relationship"
1675
- },
1676
- {
1677
- "example": {
1678
- "links": {
1679
- "related": "canvassing/shifts"
1680
- }
1681
- }
1682
- }
1683
- ]
1684
- },
1685
- "locations": {
1686
- "allOf": [
1687
- {
1688
- "$ref": "#/components/schemas/Relationship"
1689
- },
1690
- {
1691
- "example": {
1692
- "links": {
1693
- "related": "turfs/locations"
1694
- }
1695
- }
1696
- }
1697
- ]
1698
- }
1699
- }
1700
- }
1701
- }
1702
- }
1703
- ]
1704
- }
1705
- },
1706
- "links": {
1707
- "$ref": "#/components/schemas/PaginationLinks"
1708
- }
1709
- }
1710
- }
1711
- }
1712
- }
1713
- },
1714
- "400": {
1715
- "$ref": "#/components/responses/UnexpectedParams"
1716
- }
1717
- },
1718
- "operationId": "turfs/turf-index"
1719
- }
1720
- },
1721
- "/turfs/locations": {
1722
- "get": {
1723
- "parameters": [
1724
- {
1725
- "$ref": "#/components/parameters/Sort"
1726
- },
1727
- {
1728
- "$ref": "#/components/parameters/Fields"
1729
- },
1730
- {
1731
- "$ref": "#/components/parameters/Page"
1732
- },
1733
- {
1734
- "$ref": "#/components/parameters/Filter"
1735
- }
1736
- ],
1737
- "responses": {
1738
- "200": {
1739
- "description": "Lists turfs/location",
1740
- "content": {
1741
- "application/vnd.api+json": {
1742
- "schema": {
1743
- "type": "object",
1744
- "properties": {
1745
- "data": {
1746
- "type": "array",
1747
- "items": {
1748
- "allOf": [
1749
- {
1750
- "$ref": "#/components/schemas/TurfsLocation"
1751
- },
1752
- {
1753
- "type": "object",
1754
- "properties": {
1755
- "relationships": {
1756
- "type": "object",
1757
- "properties": {
1758
- "turf": {
1759
- "allOf": [
1760
- {
1761
- "$ref": "#/components/schemas/Relationship"
1762
- },
1763
- {
1764
- "example": {}
1765
- }
1766
- ]
1767
- }
1768
- }
1769
- }
1770
- }
1771
- }
1772
- ]
1773
- }
1774
- },
1775
- "links": {
1776
- "$ref": "#/components/schemas/PaginationLinks"
1777
- }
1778
- }
1779
- }
1780
- }
1781
- }
1782
- },
1783
- "400": {
1784
- "$ref": "#/components/responses/UnexpectedParams"
1785
- }
1786
- },
1787
- "operationId": "turfs/location-index"
1788
- },
1789
- "post": {
1790
- "parameters": [
1791
- {
1792
- "$ref": "#/components/parameters/Fields"
1793
- }
1794
- ],
1795
- "responses": {
1796
- "200": {
1797
- "description": "turfs/location create was successful",
1798
- "content": {
1799
- "application/vnd.api+json": {
1800
- "schema": {
1801
- "type": "object",
1802
- "properties": {
1803
- "data": {
1804
- "allOf": [
1805
- {
1806
- "$ref": "#/components/schemas/TurfsLocation"
1807
- },
1808
- {
1809
- "type": "object",
1810
- "properties": {
1811
- "relationships": {
1812
- "type": "object",
1813
- "properties": {
1814
- "turf": {
1815
- "allOf": [
1816
- {
1817
- "$ref": "#/components/schemas/Relationship"
1818
- },
1819
- {
1820
- "example": {}
1821
- }
1822
- ]
1823
- }
1824
- }
1825
- }
1826
- }
1827
- }
1828
- ]
1829
- }
1830
- }
1831
- }
1832
- }
1833
- }
1834
- },
1835
- "400": {
1836
- "$ref": "#/components/responses/UnexpectedParams"
1837
- },
1838
- "422": {
1839
- "$ref": "#/components/responses/InvalidParams"
1840
- }
1841
- },
1842
- "requestBody": {
1843
- "content": {
1844
- "application/vnd.api+json": {
1845
- "schema": {
1846
- "type": "object",
1847
- "required": [
1848
- "data"
1849
- ],
1850
- "properties": {
1851
- "data": {
1852
- "type": "object",
1853
- "required": [
1854
- "type",
1855
- "attributes"
1856
- ],
1857
- "properties": {
1858
- "attributes": {
1859
- "type": "object",
1860
- "required": [
1861
- "name",
1862
- "location_type",
1863
- "street_address",
1864
- "city",
1865
- "state",
1866
- "zipcode"
1867
- ],
1868
- "properties": {
1869
- "name": {
1870
- "type": "string"
1871
- },
1872
- "state": {
1873
- "type": "string"
1874
- },
1875
- "category": {
1876
- "type": "string"
1877
- },
1878
- "timezone": {
1879
- "type": "string",
1880
- "enum": [
1881
- "America/New_York",
1882
- "America/Chicago",
1883
- "America/Denver",
1884
- "America/Phoenix",
1885
- "America/Los_Angeles",
1886
- "America/Anchorage",
1887
- "Pacific/Honolulu",
1888
- "America/Adak"
1889
- ]
1890
- },
1891
- "county": {
1892
- "type": "string"
1893
- },
1894
- "notes": {
1895
- "type": "string"
1896
- },
1897
- "city": {
1898
- "type": "string"
1899
- },
1900
- "zipcode": {
1901
- "type": "string"
1902
- },
1903
- "street_address": {
1904
- "type": "string"
1905
- },
1906
- "location_type": {
1907
- "type": "string",
1908
- "enum": [
1909
- "canvassing",
1910
- "delivery",
1911
- "venue"
1912
- ]
1913
- },
1914
- "turf_id": {
1915
- "type": "integer"
1916
- }
1917
- }
1918
- },
1919
- "type": {
1920
- "const": "turfs/location",
1921
- "type": "string"
1922
- }
1923
- }
1924
- }
1925
- }
1926
- }
1927
- }
1928
- }
1929
- },
1930
- "operationId": "turfs/location-create"
1931
- }
1932
- },
1933
- "/turfs/locations/{id}": {
1934
- "put": {
1935
- "parameters": [
1936
- {
1937
- "in": "path",
1938
- "name": "id",
1939
- "required": true,
1940
- "schema": {
1941
- "type": "integer"
1942
- }
1943
- },
1944
- {
1945
- "$ref": "#/components/parameters/Fields"
1946
- }
1947
- ],
1948
- "responses": {
1949
- "200": {
1950
- "description": "turfs/location update was successful",
1951
- "content": {
1952
- "application/vnd.api+json": {
1953
- "schema": {
1954
- "type": "object",
1955
- "properties": {
1956
- "data": {
1957
- "allOf": [
1958
- {
1959
- "$ref": "#/components/schemas/TurfsLocation"
1960
- },
1961
- {
1962
- "type": "object",
1963
- "properties": {
1964
- "relationships": {
1965
- "type": "object",
1966
- "properties": {
1967
- "turf": {
1968
- "allOf": [
1969
- {
1970
- "$ref": "#/components/schemas/Relationship"
1971
- },
1972
- {
1973
- "example": {}
1974
- }
1975
- ]
1976
- }
1977
- }
1978
- }
1979
- }
1980
- }
1981
- ]
1982
- }
1983
- }
1984
- }
1985
- }
1986
- }
1987
- },
1988
- "400": {
1989
- "$ref": "#/components/responses/UnexpectedParams"
1990
- },
1991
- "422": {
1992
- "$ref": "#/components/responses/InvalidParams"
1993
- }
1994
- },
1995
- "requestBody": {
1996
- "content": {
1997
- "application/vnd.api+json": {
1998
- "schema": {
1999
- "type": "object",
2000
- "required": [
2001
- "data"
2002
- ],
2003
- "properties": {
2004
- "data": {
2005
- "type": "object",
2006
- "required": [
2007
- "type"
2008
- ],
2009
- "properties": {
2010
- "attributes": {
2011
- "type": "object",
2012
- "required": [],
2013
- "properties": {
2014
- "name": {
2015
- "type": "string"
2016
- },
2017
- "state": {
2018
- "type": "string"
2019
- },
2020
- "category": {
2021
- "type": "string"
2022
- },
2023
- "timezone": {
2024
- "type": "string",
2025
- "enum": [
2026
- "America/New_York",
2027
- "America/Chicago",
2028
- "America/Denver",
2029
- "America/Phoenix",
2030
- "America/Los_Angeles",
2031
- "America/Anchorage",
2032
- "Pacific/Honolulu",
2033
- "America/Adak"
2034
- ]
2035
- },
2036
- "county": {
2037
- "type": "string"
2038
- },
2039
- "notes": {
2040
- "type": "string"
2041
- },
2042
- "city": {
2043
- "type": "string"
2044
- },
2045
- "zipcode": {
2046
- "type": "string"
2047
- },
2048
- "street_address": {
2049
- "type": "string"
2050
- },
2051
- "turf_id": {
2052
- "type": "integer"
2053
- }
2054
- }
2055
- },
2056
- "type": {
2057
- "const": "turfs/location",
2058
- "type": "string"
2059
- }
2060
- }
2061
- }
2062
- }
2063
- }
2064
- }
2065
- }
2066
- },
2067
- "operationId": "turfs/location-update"
2068
- }
2069
- },
2070
- "/turfs/{id}": {
2071
- "get": {
2072
- "parameters": [
2073
- {
2074
- "in": "path",
2075
- "name": "id",
2076
- "required": true,
2077
- "schema": {
2078
- "type": "integer"
2079
- }
2080
- },
2081
- {
2082
- "$ref": "#/components/parameters/Fields"
2083
- }
2084
- ],
2085
- "responses": {
2086
- "200": {
2087
- "description": "turfs/turf show was successful",
2088
- "content": {
2089
- "application/vnd.api+json": {
2090
- "schema": {
2091
- "type": "object",
2092
- "properties": {
2093
- "data": {
2094
- "allOf": [
2095
- {
2096
- "$ref": "#/components/schemas/TurfsTurf"
2097
- },
2098
- {
2099
- "type": "object",
2100
- "properties": {
2101
- "relationships": {
2102
- "type": "object",
2103
- "properties": {
2104
- "shifts": {
2105
- "allOf": [
2106
- {
2107
- "$ref": "#/components/schemas/Relationship"
2108
- },
2109
- {
2110
- "example": {
2111
- "links": {
2112
- "related": "canvassing/shifts"
2113
- }
2114
- }
2115
- }
2116
- ]
2117
- },
2118
- "locations": {
2119
- "allOf": [
2120
- {
2121
- "$ref": "#/components/schemas/Relationship"
2122
- },
2123
- {
2124
- "example": {
2125
- "links": {
2126
- "related": "turfs/locations"
2127
- }
2128
- }
2129
- }
2130
- ]
2131
- }
2132
- }
2133
- }
2134
- }
2135
- }
2136
- ]
2137
- }
2138
- }
2139
- }
2140
- }
2141
- }
2142
- },
2143
- "400": {
2144
- "$ref": "#/components/responses/UnexpectedParams"
2145
- }
2146
- },
2147
- "operationId": "turfs/turf-show"
2148
- }
2149
- },
2150
- "/voter_registration/forms/{form_id}/file": {
2151
- "get": {
2152
- "parameters": [
2153
- {
2154
- "in": "path",
2155
- "name": "form_id",
2156
- "required": true,
2157
- "schema": {
2158
- "type": "integer"
2159
- }
2160
- },
2161
- {
2162
- "$ref": "#/components/parameters/Fields"
2163
- }
2164
- ],
2165
- "responses": {
2166
- "200": {
2167
- "description": "views/file show was successful",
2168
- "content": {
2169
- "application/vnd.api+json": {
2170
- "schema": {
2171
- "type": "object",
2172
- "properties": {
2173
- "data": {
2174
- "allOf": [
2175
- {
2176
- "$ref": "#/components/schemas/ViewsFile"
2177
- },
2178
- {}
2179
- ]
2180
- }
2181
- }
2182
- }
2183
- }
2184
- }
2185
- },
2186
- "400": {
2187
- "$ref": "#/components/responses/UnexpectedParams"
2188
- }
2189
- },
2190
- "operationId": "views/file-show"
2191
- }
2192
- },
2193
- "/voter_registration/forms/{form_id}/issues": {
2194
- "post": {
2195
- "parameters": [
2196
- {
2197
- "in": "path",
2198
- "name": "form_id",
2199
- "required": true,
2200
- "schema": {
2201
- "type": "integer"
2202
- }
2203
- },
2204
- {
2205
- "$ref": "#/components/parameters/Fields"
2206
- }
2207
- ],
2208
- "responses": {
2209
- "200": {
2210
- "description": "quality_control/form_issue create was successful",
2211
- "content": {
2212
- "application/vnd.api+json": {
2213
- "schema": {
2214
- "type": "object",
2215
- "properties": {
2216
- "data": {
2217
- "allOf": [
2218
- {
2219
- "$ref": "#/components/schemas/QualityControlFormIssue"
2220
- },
2221
- {}
2222
- ]
2223
- }
2224
- }
2225
- }
2226
- }
2227
- }
2228
- },
2229
- "400": {
2230
- "$ref": "#/components/responses/UnexpectedParams"
2231
- },
2232
- "422": {
2233
- "$ref": "#/components/responses/InvalidParams"
2234
- }
2235
- },
2236
- "requestBody": {
2237
- "content": {
2238
- "application/vnd.api+json": {
2239
- "schema": {
2240
- "type": "object",
2241
- "required": [
2242
- "data"
2243
- ],
2244
- "properties": {
2245
- "data": {
2246
- "type": "object",
2247
- "required": [
2248
- "type"
2249
- ],
2250
- "properties": {
2251
- "attributes": {
2252
- "type": "object",
2253
- "required": [],
2254
- "properties": {
2255
- "issue_id": {
2256
- "type": "integer"
2257
- }
2258
- }
2259
- },
2260
- "type": {
2261
- "const": "quality_control/form_issue",
2262
- "type": "string"
2263
- }
2264
- }
2265
- }
2266
- }
2267
- }
2268
- }
2269
- }
2270
- },
2271
- "operationId": "quality_control/form_issue-create"
2272
- }
2273
- },
2274
- "/voter_registration/forms/{id}": {
2275
- "get": {
2276
- "parameters": [
2277
- {
2278
- "in": "path",
2279
- "name": "id",
2280
- "required": true,
2281
- "schema": {
2282
- "type": "integer"
2283
- }
2284
- },
2285
- {
2286
- "$ref": "#/components/parameters/Fields"
2287
- }
2288
- ],
2289
- "responses": {
2290
- "200": {
2291
- "description": "voter_registration/form show was successful",
2292
- "content": {
2293
- "application/vnd.api+json": {
2294
- "schema": {
2295
- "type": "object",
2296
- "properties": {
2297
- "data": {
2298
- "allOf": [
2299
- {
2300
- "$ref": "#/components/schemas/VoterRegistrationForm"
2301
- },
2302
- {
2303
- "type": "object",
2304
- "properties": {
2305
- "relationships": {
2306
- "type": "object",
2307
- "properties": {
2308
- "file": {
2309
- "allOf": [
2310
- {
2311
- "$ref": "#/components/schemas/Relationship"
2312
- },
2313
- {
2314
- "example": {
2315
- "links": {
2316
- "related": "/voter_registration/forms/:id/file"
2317
- }
2318
- }
2319
- }
2320
- ]
2321
- },
2322
- "shift": {
2323
- "allOf": [
2324
- {
2325
- "$ref": "#/components/schemas/Relationship"
2326
- },
2327
- {
2328
- "example": {
2329
- "data": {
2330
- "id": 1,
2331
- "type": "canvassing/shift"
2332
- }
2333
- }
2334
- }
2335
- ]
2336
- }
2337
- }
2338
- }
2339
- }
2340
- }
2341
- ]
2342
- },
2343
- "includes": {
2344
- "type": "array",
2345
- "items": {
2346
- "anyOf": [
2347
- {
2348
- "$ref": "#/components/schemas/CanvassingShift"
2349
- }
2350
- ]
2351
- }
2352
- }
2353
- }
2354
- }
2355
- }
2356
- }
2357
- },
2358
- "400": {
2359
- "$ref": "#/components/responses/UnexpectedParams"
2360
- }
2361
- },
2362
- "operationId": "voter_registration/form-show"
2363
- }
2364
- },
2365
- "/voter_registration/shifts/{shift_id}/forms": {
2366
- "post": {
2367
- "parameters": [
2368
- {
2369
- "in": "path",
2370
- "name": "shift_id",
2371
- "required": true,
2372
- "schema": {
2373
- "type": "integer"
2374
- }
2375
- },
2376
- {
2377
- "$ref": "#/components/parameters/Fields"
2378
- }
2379
- ],
2380
- "responses": {
2381
- "200": {
2382
- "description": "voter_registration/form create was successful",
2383
- "content": {
2384
- "application/vnd.api+json": {
2385
- "schema": {
2386
- "type": "object",
2387
- "properties": {
2388
- "data": {
2389
- "allOf": [
2390
- {
2391
- "$ref": "#/components/schemas/VoterRegistrationForm"
2392
- },
2393
- {
2394
- "type": "object",
2395
- "properties": {
2396
- "relationships": {
2397
- "type": "object",
2398
- "properties": {
2399
- "file": {
2400
- "allOf": [
2401
- {
2402
- "$ref": "#/components/schemas/Relationship"
2403
- },
2404
- {
2405
- "example": {
2406
- "links": {
2407
- "related": "/voter_registration/forms/:id/file"
2408
- }
2409
- }
2410
- }
2411
- ]
2412
- },
2413
- "shift": {
2414
- "allOf": [
2415
- {
2416
- "$ref": "#/components/schemas/Relationship"
2417
- },
2418
- {
2419
- "example": {
2420
- "data": {
2421
- "id": 1,
2422
- "type": "canvassing/shift"
2423
- }
2424
- }
2425
- }
2426
- ]
2427
- }
2428
- }
2429
- }
2430
- }
2431
- }
2432
- ]
2433
- },
2434
- "includes": {
2435
- "type": "array",
2436
- "items": {
2437
- "anyOf": [
2438
- {
2439
- "$ref": "#/components/schemas/CanvassingShift"
2440
- }
2441
- ]
2442
- }
2443
- }
2444
- }
2445
- }
2446
- }
2447
- }
2448
- },
2449
- "400": {
2450
- "$ref": "#/components/responses/UnexpectedParams"
2451
- },
2452
- "422": {
2453
- "$ref": "#/components/responses/InvalidParams"
2454
- }
2455
- },
2456
- "requestBody": {
2457
- "content": {
2458
- "application/vnd.api+json": {
2459
- "schema": {
2460
- "type": "object",
2461
- "required": [
2462
- "data"
2463
- ],
2464
- "properties": {
2465
- "data": {
2466
- "type": "object",
2467
- "required": [
2468
- "type"
2469
- ],
2470
- "properties": {
2471
- "attributes": {
2472
- "type": "object",
2473
- "required": [],
2474
- "properties": {
2475
- "signature": {
2476
- "type": "boolean"
2477
- },
2478
- "first_name": {
2479
- "type": "string"
2480
- },
2481
- "county": {
2482
- "type": "string"
2483
- },
2484
- "date_of_birth": {
2485
- "type": "string",
2486
- "format": "date"
2487
- },
2488
- "eligible_voting_age": {
2489
- "type": "boolean"
2490
- },
2491
- "email_address": {
2492
- "type": "string"
2493
- },
2494
- "ethnicity": {
2495
- "type": "string"
2496
- },
2497
- "gender": {
2498
- "type": "string"
2499
- },
2500
- "last_name": {
2501
- "type": "string"
2502
- },
2503
- "mailing_city": {
2504
- "type": "string"
2505
- },
2506
- "mailing_state": {
2507
- "type": "string"
2508
- },
2509
- "mailing_street_address_one": {
2510
- "type": "string"
2511
- },
2512
- "mailing_street_address_two": {
2513
- "type": "string"
2514
- },
2515
- "mailing_zipcode": {
2516
- "type": "string"
2517
- },
2518
- "middle_name": {
2519
- "type": "string"
2520
- },
2521
- "name_suffix": {
2522
- "type": "string"
2523
- },
2524
- "phone_number": {
2525
- "type": "string"
2526
- },
2527
- "registration_date": {
2528
- "type": "string",
2529
- "format": "date"
2530
- },
2531
- "social_security": {
2532
- "type": "boolean"
2533
- },
2534
- "state_id": {
2535
- "type": "boolean"
2536
- },
2537
- "us_citizen": {
2538
- "type": "boolean"
2539
- },
2540
- "voting_city": {
2541
- "type": "string"
2542
- },
2543
- "voting_state": {
2544
- "type": "string"
2545
- },
2546
- "voting_street_address_one": {
2547
- "type": "string"
2548
- },
2549
- "voting_street_address_two": {
2550
- "type": "string"
2551
- },
2552
- "voting_zipcode": {
2553
- "type": "string"
2554
- },
2555
- "file_url": {
2556
- "type": "string",
2557
- "format": "uri"
2558
- }
2559
- }
2560
- },
2561
- "type": {
2562
- "const": "voter_registration/form",
2563
- "type": "string"
2564
- }
2565
- }
2566
- }
2567
- }
2568
- }
2569
- }
2570
- }
2571
- },
2572
- "operationId": "voter_registration/form-create"
2573
- }
2574
- }
2575
- },
2576
- "openapi": "3.1.1",
2577
- "servers": [
2578
- {
2579
- "variables": {
2580
- "port": {
2581
- "default": "80"
2582
- },
2583
- "scheme": {
2584
- "default": "https",
2585
- "enum": [
2586
- "https",
2587
- "http"
2588
- ]
2589
- },
2590
- "host": {
2591
- "default": "localhost.tv"
2592
- }
2593
- },
2594
- "url": "{scheme}://api.{host}:{port}/v2"
2595
- }
2596
- ]
2597
- }