-
Notifications
You must be signed in to change notification settings - Fork 13
/
v1.1-events.yml
1033 lines (1033 loc) · 21.6 KB
/
v1.1-events.yml
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: /v1.1
definitions:
BadRequest:
properties:
message:
type: string
type: object
Credentials:
properties:
district_username:
type: string
type: object
District:
properties:
id:
type: string
x-validation: true
mdr_number:
type: string
x-nullable: true
name:
type: string
type: object
DistrictObject:
properties:
object:
$ref: '#/definitions/District'
type: object
DistrictResponse:
properties:
data:
$ref: '#/definitions/District'
type: object
DistrictStatus:
properties:
error:
type: string
id:
type: string
x-validation: true
instant_login:
type: boolean
last_sync:
format: datetime
type: string
x-nullable: true
x-validation: true
sis_type:
type: string
x-validation: true
state:
enum:
- running
- pending
- error
type: string
x-validation: true
type: object
DistrictStatusResponse:
properties:
data:
$ref: '#/definitions/DistrictStatus'
type: object
DistrictStatusResponses:
properties:
data:
items:
$ref: '#/definitions/DistrictStatusResponse'
type: array
type: object
DistrictsResponse:
properties:
data:
items:
$ref: '#/definitions/DistrictResponse'
type: array
type: object
Event:
discriminator: type
properties:
created:
format: datetime
type: string
x-validation: true
id:
type: string
x-validation: true
type:
type: string
x-validation: true
required:
- type
type: object
EventResponse:
properties:
data:
$ref: '#/definitions/Event'
type: object
EventsResponse:
properties:
data:
items:
$ref: '#/definitions/EventResponse'
type: array
type: object
InternalError:
properties:
message:
type: string
type: object
Location:
properties:
address:
type: string
x-nullable: true
city:
type: string
x-nullable: true
lat:
type: string
x-nullable: true
lon:
type: string
x-nullable: true
state:
type: string
x-nullable: true
zip:
type: string
x-nullable: true
type: object
Name:
properties:
first:
type: string
x-nullable: true
last:
type: string
x-nullable: true
middle:
type: string
x-nullable: true
type: object
NotFound:
properties:
message:
type: string
type: object
Principal:
properties:
email:
type: string
x-nullable: true
name:
type: string
x-nullable: true
type: object
School:
properties:
created:
format: datetime
type: string
x-validation: true
district:
type: string
x-validation: true
high_grade:
enum:
- "1"
- "2"
- "3"
- "4"
- "5"
- "6"
- "7"
- "8"
- "9"
- "10"
- "11"
- "12"
- PreKindergarten
- Kindergarten
- PostGraduate
- Other
type: string
x-nullable: true
x-validation: true
id:
type: string
x-validation: true
last_modified:
format: datetime
type: string
x-validation: true
location:
$ref: '#/definitions/Location'
x-nullable: true
low_grade:
enum:
- "1"
- "2"
- "3"
- "4"
- "5"
- "6"
- "7"
- "8"
- "9"
- "10"
- "11"
- "12"
- PreKindergarten
- Kindergarten
- PostGraduate
- Other
type: string
x-nullable: true
x-validation: true
mdr_number:
type: string
x-nullable: true
name:
type: string
nces_id:
type: string
x-nullable: true
phone:
type: string
x-nullable: true
principal:
$ref: '#/definitions/Principal'
school_number:
type: string
sis_id:
type: string
state_id:
type: string
x-nullable: true
type: object
SchoolAdmin:
properties:
credentials:
$ref: '#/definitions/Credentials'
district:
type: string
x-validation: true
email:
type: string
id:
type: string
x-validation: true
name:
$ref: '#/definitions/Name'
schools:
items:
type: string
type: array
x-validation: true
staff_id:
type: string
title:
type: string
x-nullable: true
type: object
SchoolAdminObject:
properties:
object:
$ref: '#/definitions/SchoolAdmin'
type: object
SchoolAdminResponse:
properties:
data:
$ref: '#/definitions/SchoolAdmin'
type: object
SchoolAdminsResponse:
properties:
data:
items:
$ref: '#/definitions/SchoolAdminResponse'
type: array
type: object
SchoolObject:
properties:
object:
$ref: '#/definitions/School'
type: object
SchoolResponse:
properties:
data:
$ref: '#/definitions/School'
type: object
SchoolsResponse:
properties:
data:
items:
$ref: '#/definitions/SchoolResponse'
type: array
type: object
Section:
properties:
course_description:
type: string
x-nullable: true
course_name:
type: string
x-nullable: true
course_number:
type: string
x-nullable: true
created:
format: datetime
type: string
x-validation: true
district:
type: string
x-validation: true
grade:
enum:
- "1"
- "2"
- "3"
- "4"
- "5"
- "6"
- "7"
- "8"
- "9"
- "10"
- "11"
- "12"
- PreKindergarten
- Kindergarten
- PostGraduate
- Other
type: string
x-nullable: true
x-validation: true
id:
type: string
x-validation: true
last_modified:
format: datetime
type: string
x-validation: true
name:
type: string
period:
type: string
x-nullable: true
school:
type: string
x-validation: true
section_number:
type: string
x-nullable: true
sis_id:
type: string
students:
items:
type: string
type: array
x-validation: true
subject:
enum:
- english/language arts
- math
- science
- social studies
- language
- homeroom/advisory
- interventions/online learning
- technology and engineering
- PE and health
- arts and music
- other
type: string
x-validation: true
teacher:
type: string
x-nullable: true
x-validation: true
teachers:
items:
type: string
type: array
x-validation: true
term:
$ref: '#/definitions/Term'
x-nullable: true
type: object
SectionObject:
properties:
object:
$ref: '#/definitions/Section'
type: object
SectionResponse:
properties:
data:
$ref: '#/definitions/Section'
type: object
SectionsResponse:
properties:
data:
items:
$ref: '#/definitions/SectionResponse'
type: array
type: object
Student:
properties:
created:
format: datetime
type: string
x-validation: true
credentials:
$ref: '#/definitions/Credentials'
district:
type: string
x-validation: true
dob:
pattern: (?:[0-9]{1,2})/([0-9]{1,2})/([0-9]{4})
type: string
x-nullable: true
x-validation: true
ell_status:
enum:
- "Y"
- "N"
- ""
type: string
x-nullable: true
x-validation: true
email:
type: string
x-nullable: true
gender:
enum:
- M
- F
- ""
type: string
x-nullable: true
x-validation: true
grade:
enum:
- "1"
- "2"
- "3"
- "4"
- "5"
- "6"
- "7"
- "8"
- "9"
- "10"
- "11"
- "12"
- PreKindergarten
- Kindergarten
- PostGraduate
- Other
type: string
x-nullable: true
x-validation: true
hispanic_ethnicity:
enum:
- "Y"
- "N"
- ""
type: string
x-nullable: true
x-validation: true
id:
type: string
x-validation: true
last_modified:
format: datetime
type: string
x-validation: true
location:
$ref: '#/definitions/Location'
x-nullable: true
name:
$ref: '#/definitions/Name'
race:
enum:
- Caucasian
- Asian
- Black or African American
- American Indian
- Hawaiian or Other Pacific Islander
- Two or More Races
- Unknown
- ""
type: string
x-nullable: true
x-validation: true
school:
type: string
x-validation: true
sis_id:
type: string
state_id:
type: string
x-nullable: true
student_number:
type: string
x-nullable: true
type: object
StudentContact:
properties:
district:
type: string
x-validation: true
email:
type: string
x-nullable: true
id:
type: string
x-validation: true
name:
type: string
phone:
type: string
x-nullable: true
phone_type:
type: string
x-nullable: true
relationship:
type: string
x-nullable: true
student:
type: string
x-validation: true
type:
type: string
type: object
StudentContactObject:
properties:
object:
$ref: '#/definitions/StudentContact'
type: object
StudentContactResponse:
properties:
data:
$ref: '#/definitions/StudentContact'
type: object
StudentContactsForStudentResponse:
properties:
data:
items:
$ref: '#/definitions/StudentContact'
type: array
type: object
StudentContactsResponse:
properties:
data:
items:
$ref: '#/definitions/StudentContactResponse'
type: array
type: object
StudentObject:
properties:
object:
$ref: '#/definitions/Student'
type: object
StudentResponse:
properties:
data:
$ref: '#/definitions/Student'
type: object
StudentsResponse:
properties:
data:
items:
$ref: '#/definitions/StudentResponse'
type: array
type: object
Teacher:
properties:
created:
format: datetime
type: string
x-validation: true
credentials:
$ref: '#/definitions/Credentials'
x-nullable: true
district:
type: string
x-validation: true
email:
type: string
x-nullable: true
id:
type: string
x-validation: true
last_modified:
format: datetime
type: string
x-validation: true
name:
$ref: '#/definitions/Name'
school:
type: string
x-validation: true
sis_id:
type: string
state_id:
type: string
x-nullable: true
teacher_number:
type: string
x-nullable: true
title:
type: string
x-nullable: true
type: object
TeacherObject:
properties:
object:
$ref: '#/definitions/Teacher'
type: object
TeacherResponse:
properties:
data:
$ref: '#/definitions/Teacher'
type: object
TeachersResponse:
properties:
data:
items:
$ref: '#/definitions/TeacherResponse'
type: array
type: object
Term:
properties:
end_date:
format: datetime
type: string
x-nullable: true
x-validation: true
name:
type: string
x-nullable: true
start_date:
format: datetime
type: string
x-nullable: true
x-validation: true
type: object
districts.created:
allOf:
- $ref: '#/definitions/Event'
- properties:
data:
$ref: '#/definitions/DistrictObject'
type: object
districts.deleted:
allOf:
- $ref: '#/definitions/Event'
- properties:
data:
$ref: '#/definitions/DistrictObject'
type: object
districts.updated:
allOf:
- $ref: '#/definitions/Event'
- properties:
data:
$ref: '#/definitions/DistrictObject'
previous_attributes:
additionalProperties:
type: object
type: object
schooladmins.created:
allOf:
- $ref: '#/definitions/Event'
- properties:
data:
$ref: '#/definitions/SchoolAdminObject'
type: object
schooladmins.deleted:
allOf:
- $ref: '#/definitions/Event'
- properties:
data:
$ref: '#/definitions/SchoolAdminObject'
type: object
schooladmins.updated:
allOf:
- $ref: '#/definitions/Event'
- properties:
data:
$ref: '#/definitions/SchoolAdminObject'
previous_attributes:
additionalProperties:
type: object
type: object
schools.created:
allOf:
- $ref: '#/definitions/Event'
- properties:
data:
$ref: '#/definitions/SchoolObject'
type: object
schools.deleted:
allOf:
- $ref: '#/definitions/Event'
- properties:
data:
$ref: '#/definitions/SchoolObject'
type: object
schools.updated:
allOf:
- $ref: '#/definitions/Event'
- properties:
data:
$ref: '#/definitions/SchoolObject'
previous_attributes:
additionalProperties:
type: object
type: object
sections.created:
allOf:
- $ref: '#/definitions/Event'
- properties:
data:
$ref: '#/definitions/SectionObject'
type: object
sections.deleted:
allOf:
- $ref: '#/definitions/Event'
- properties:
data:
$ref: '#/definitions/SectionObject'
type: object
sections.updated:
allOf:
- $ref: '#/definitions/Event'
- properties:
data:
$ref: '#/definitions/SectionObject'
previous_attributes:
additionalProperties:
type: object
type: object
studentcontacts.created:
allOf:
- $ref: '#/definitions/Event'
- properties:
data:
$ref: '#/definitions/StudentContactObject'
type: object
studentcontacts.deleted:
allOf:
- $ref: '#/definitions/Event'
- properties:
data:
$ref: '#/definitions/StudentContactObject'
type: object
studentcontacts.updated:
allOf:
- $ref: '#/definitions/Event'
- properties:
data:
$ref: '#/definitions/StudentContactObject'
previous_attributes:
additionalProperties:
type: object
type: object
students.created:
allOf:
- $ref: '#/definitions/Event'
- properties:
data:
$ref: '#/definitions/StudentObject'
type: object
students.deleted:
allOf:
- $ref: '#/definitions/Event'
- properties:
data:
$ref: '#/definitions/StudentObject'
type: object
students.updated:
allOf:
- $ref: '#/definitions/Event'
- properties:
data:
$ref: '#/definitions/StudentObject'
previous_attributes:
additionalProperties:
type: object
type: object
teachers.created:
allOf:
- $ref: '#/definitions/Event'
- properties:
data:
$ref: '#/definitions/TeacherObject'
type: object
teachers.deleted:
allOf:
- $ref: '#/definitions/Event'
- properties:
data:
$ref: '#/definitions/TeacherObject'
type: object
teachers.updated:
allOf:
- $ref: '#/definitions/Event'
- properties:
data:
$ref: '#/definitions/TeacherObject'
previous_attributes:
additionalProperties:
type: object
type: object
host: api.clever.com
info:
description: The Clever Events API
title: Events API
version: 1.1.0
paths:
/events:
get:
description: Returns a list of events
operationId: getEvents
parameters:
- in: query
name: limit
type: integer
- in: query
name: starting_after
type: string
- in: query
name: ending_before
type: string
responses:
"200":
description: OK Response
schema:
$ref: '#/definitions/EventsResponse'
"404":
$ref: '#/responses/NotFound'
tags:
- Events
/events/{id}:
get:
description: Returns the specific event
operationId: getEvent
parameters:
- in: path
name: id
required: true
type: string
responses:
"200":
description: OK Response
schema:
$ref: '#/definitions/EventResponse'
"404":
$ref: '#/responses/NotFound'
tags:
- Events
/school_admins/{id}/events:
get:
description: Returns a list of events for a school admin
operationId: getEventsForSchoolAdmin
parameters:
- in: path
name: id
required: true
type: string
- in: query
name: limit
type: integer
- in: query
name: starting_after
type: string
- in: query
name: ending_before
type: string
responses:
"200":
description: OK Response
schema:
$ref: '#/definitions/EventsResponse'
"404":
$ref: '#/responses/NotFound'
tags:
- Record-specific Events
/schools/{id}/events:
get:
description: Returns a list of events for a school
operationId: getEventsForSchool
parameters:
- in: path
name: id
required: true
type: string
- in: query
name: limit
type: integer
- in: query
name: starting_after
type: string
- in: query
name: ending_before
type: string
responses:
"200":
description: OK Response
schema:
$ref: '#/definitions/EventsResponse'
"404":
$ref: '#/responses/NotFound'
tags:
- Record-specific Events
/sections/{id}/events:
get:
description: Returns a list of events for a section
operationId: getEventsForSection
parameters:
- in: path
name: id
required: true
type: string
- in: query
name: limit
type: integer
- in: query
name: starting_after
type: string
- in: query
name: ending_before
type: string
responses:
"200":
description: OK Response
schema:
$ref: '#/definitions/EventsResponse'
"404":
$ref: '#/responses/NotFound'
tags:
- Record-specific Events
/students/{id}/events:
get:
description: Returns a list of events for a student
operationId: getEventsForStudent
parameters:
- in: path
name: id
required: true
type: string
- in: query
name: limit
type: integer
- in: query
name: starting_after
type: string
- in: query
name: ending_before
type: string
responses:
"200":
description: OK Response
schema:
$ref: '#/definitions/EventsResponse'
"404":
$ref: '#/responses/NotFound'
tags:
- Record-specific Events
/teachers/{id}/events:
get:
description: Returns a list of events for a teacher
operationId: getEventsForTeacher
parameters:
- in: path
name: id
required: true
type: string
- in: query
name: limit
type: integer
- in: query
name: starting_after
type: string
- in: query
name: ending_before
type: string
responses:
"200":
description: OK Response
schema:
$ref: '#/definitions/EventsResponse'
"404":
$ref: '#/responses/NotFound'
tags:
- Record-specific Events
produces: