commonlit-clever-ruby 2.1.4 → 2.1.6.beta1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (154) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +27 -30
  3. data/Makefile +1 -1
  4. data/README.md +60 -61
  5. data/clever-ruby.gemspec +6 -6
  6. data/docs/Contact.md +1 -1
  7. data/docs/ContactsApi.md +231 -0
  8. data/docs/ContactsCreated.md +2 -2
  9. data/docs/ContactsDeleted.md +2 -2
  10. data/docs/ContactsUpdated.md +2 -2
  11. data/docs/Course.md +1 -1
  12. data/docs/CoursesApi.md +231 -0
  13. data/docs/CoursesCreated.md +2 -2
  14. data/docs/CoursesDeleted.md +2 -2
  15. data/docs/CoursesUpdated.md +2 -2
  16. data/docs/District.md +9 -9
  17. data/docs/DistrictAdmin.md +2 -2
  18. data/docs/DistrictAdminsApi.md +171 -0
  19. data/docs/DistrictadminsCreated.md +2 -2
  20. data/docs/DistrictadminsDeleted.md +2 -2
  21. data/docs/DistrictadminsUpdated.md +2 -2
  22. data/docs/DistrictsApi.md +113 -0
  23. data/docs/DistrictsCreated.md +2 -2
  24. data/docs/DistrictsDeleted.md +2 -2
  25. data/docs/DistrictsUpdated.md +2 -2
  26. data/docs/Event.md +2 -2
  27. data/docs/EventsApi.md +1 -1
  28. data/docs/Location.md +2 -2
  29. data/docs/Name.md +1 -1
  30. data/docs/Principal.md +1 -1
  31. data/docs/School.md +3 -3
  32. data/docs/SchoolAdmin.md +3 -3
  33. data/docs/SchoolAdminsApi.md +231 -0
  34. data/docs/SchoolEnrollment.md +1 -1
  35. data/docs/SchooladminsCreated.md +2 -2
  36. data/docs/SchooladminsDeleted.md +2 -2
  37. data/docs/SchooladminsUpdated.md +2 -2
  38. data/docs/SchoolsApi.md +351 -0
  39. data/docs/SchoolsCreated.md +2 -2
  40. data/docs/SchoolsDeleted.md +2 -2
  41. data/docs/SchoolsUpdated.md +2 -2
  42. data/docs/Section.md +2 -2
  43. data/docs/SectionsApi.md +499 -0
  44. data/docs/SectionsCreated.md +2 -2
  45. data/docs/SectionsDeleted.md +2 -2
  46. data/docs/SectionsUpdated.md +2 -2
  47. data/docs/Student.md +3 -3
  48. data/docs/StudentsApi.md +463 -0
  49. data/docs/StudentsCreated.md +2 -2
  50. data/docs/StudentsDeleted.md +2 -2
  51. data/docs/StudentsUpdated.md +2 -2
  52. data/docs/Teacher.md +2 -2
  53. data/docs/TeachersApi.md +403 -0
  54. data/docs/TeachersCreated.md +2 -2
  55. data/docs/TeachersDeleted.md +2 -2
  56. data/docs/TeachersUpdated.md +2 -2
  57. data/docs/Term.md +2 -2
  58. data/docs/TermsApi.md +231 -0
  59. data/docs/TermsCreated.md +2 -2
  60. data/docs/TermsDeleted.md +2 -2
  61. data/docs/TermsUpdated.md +2 -2
  62. data/full-v2.yml +2541 -0
  63. data/lib/clever-ruby/api/contacts_api.rb +241 -0
  64. data/lib/clever-ruby/api/courses_api.rb +241 -0
  65. data/lib/clever-ruby/api/district_admins_api.rb +182 -0
  66. data/lib/clever-ruby/api/districts_api.rb +123 -0
  67. data/lib/clever-ruby/api/events_api.rb +3 -3
  68. data/lib/clever-ruby/api/school_admins_api.rb +241 -0
  69. data/lib/clever-ruby/api/schools_api.rb +359 -0
  70. data/lib/clever-ruby/api/sections_api.rb +500 -0
  71. data/lib/clever-ruby/api/students_api.rb +468 -0
  72. data/lib/clever-ruby/api/teachers_api.rb +409 -0
  73. data/lib/clever-ruby/api/terms_api.rb +241 -0
  74. data/lib/clever-ruby/api_client.rb +1 -0
  75. data/lib/clever-ruby/api_error.rb +3 -3
  76. data/lib/clever-ruby/configuration.rb +4 -4
  77. data/lib/clever-ruby/models/admin_name.rb +3 -3
  78. data/lib/clever-ruby/models/bad_request.rb +3 -3
  79. data/lib/clever-ruby/models/contact.rb +13 -13
  80. data/lib/clever-ruby/models/contact_object.rb +3 -3
  81. data/lib/clever-ruby/models/contact_response.rb +3 -3
  82. data/lib/clever-ruby/models/contacts_response.rb +3 -3
  83. data/lib/clever-ruby/models/course.rb +16 -16
  84. data/lib/clever-ruby/models/course_object.rb +3 -3
  85. data/lib/clever-ruby/models/course_response.rb +3 -3
  86. data/lib/clever-ruby/models/courses_response.rb +3 -3
  87. data/lib/clever-ruby/models/credentials.rb +3 -3
  88. data/lib/clever-ruby/models/district.rb +69 -69
  89. data/lib/clever-ruby/models/district_admin.rb +25 -25
  90. data/lib/clever-ruby/models/district_admin_object.rb +3 -3
  91. data/lib/clever-ruby/models/district_admin_response.rb +3 -3
  92. data/lib/clever-ruby/models/district_admins_response.rb +3 -3
  93. data/lib/clever-ruby/models/district_object.rb +3 -3
  94. data/lib/clever-ruby/models/district_response.rb +3 -3
  95. data/lib/clever-ruby/models/districts_response.rb +3 -3
  96. data/lib/clever-ruby/models/event.rb +16 -16
  97. data/lib/clever-ruby/models/event_response.rb +3 -3
  98. data/lib/clever-ruby/models/events_response.rb +3 -3
  99. data/lib/clever-ruby/models/internal_error.rb +3 -3
  100. data/lib/clever-ruby/models/link.rb +3 -3
  101. data/lib/clever-ruby/models/location.rb +25 -25
  102. data/lib/clever-ruby/models/name.rb +16 -16
  103. data/lib/clever-ruby/models/not_found.rb +3 -3
  104. data/lib/clever-ruby/models/principal.rb +16 -16
  105. data/lib/clever-ruby/models/school.rb +34 -34
  106. data/lib/clever-ruby/models/school_admin.rb +34 -34
  107. data/lib/clever-ruby/models/school_admin_object.rb +3 -3
  108. data/lib/clever-ruby/models/school_admin_response.rb +3 -3
  109. data/lib/clever-ruby/models/school_admins_response.rb +3 -3
  110. data/lib/clever-ruby/models/school_enrollment.rb +16 -16
  111. data/lib/clever-ruby/models/school_object.rb +3 -3
  112. data/lib/clever-ruby/models/school_response.rb +3 -3
  113. data/lib/clever-ruby/models/schools_response.rb +3 -3
  114. data/lib/clever-ruby/models/section.rb +25 -25
  115. data/lib/clever-ruby/models/section_object.rb +3 -3
  116. data/lib/clever-ruby/models/section_response.rb +3 -3
  117. data/lib/clever-ruby/models/sections_response.rb +3 -3
  118. data/lib/clever-ruby/models/student.rb +34 -34
  119. data/lib/clever-ruby/models/student_object.rb +3 -3
  120. data/lib/clever-ruby/models/student_response.rb +3 -3
  121. data/lib/clever-ruby/models/students_response.rb +3 -3
  122. data/lib/clever-ruby/models/teacher.rb +25 -25
  123. data/lib/clever-ruby/models/teacher_object.rb +3 -3
  124. data/lib/clever-ruby/models/teacher_response.rb +3 -3
  125. data/lib/clever-ruby/models/teachers_response.rb +3 -3
  126. data/lib/clever-ruby/models/term.rb +25 -25
  127. data/lib/clever-ruby/models/term_object.rb +3 -3
  128. data/lib/clever-ruby/models/term_response.rb +3 -3
  129. data/lib/clever-ruby/models/terms_response.rb +3 -3
  130. data/lib/clever-ruby/version.rb +4 -4
  131. data/lib/clever-ruby.rb +13 -4
  132. data/override/README-extension.md +4 -5
  133. data/override/api_client.rb +1 -0
  134. data/override/override.sh +4 -5
  135. data/spec/api/contacts_api_spec.rb +84 -0
  136. data/spec/api/courses_api_spec.rb +84 -0
  137. data/spec/api/district_admins_api_spec.rb +70 -0
  138. data/spec/api/districts_api_spec.rb +56 -0
  139. data/spec/api/events_api_spec.rb +60 -0
  140. data/spec/api/school_admins_api_spec.rb +84 -0
  141. data/spec/api/schools_api_spec.rb +112 -0
  142. data/spec/api/sections_api_spec.rb +142 -0
  143. data/spec/api/students_api_spec.rb +137 -0
  144. data/spec/api/teachers_api_spec.rb +123 -0
  145. data/spec/api/terms_api_spec.rb +84 -0
  146. data/spec/api_client_spec.rb +225 -0
  147. data/spec/spec_helper.rb +25 -18
  148. metadata +71 -33
  149. data/commonlit-clever-ruby-2.1.3.gem +0 -0
  150. data/docs/DataApi.md +0 -2852
  151. data/git_push.sh +0 -55
  152. data/lib/clever-ruby/api/data_api.rb +0 -2798
  153. data/spec/events.json +0 -227
  154. data/tags +0 -1681
data/full-v2.yml ADDED
@@ -0,0 +1,2541 @@
1
+ swagger: "2.0"
2
+ info:
3
+ title: Data API
4
+ description: Serves the Clever Data API
5
+ version: 2.1.0
6
+ schemes:
7
+ - https
8
+ produces:
9
+ - application/json
10
+ host: api.clever.com
11
+
12
+ x-samples-languages: ["curl", "node", "ruby", "python", "php", "java", "go"]
13
+
14
+ responses:
15
+ BadRequest:
16
+ description: Bad Request
17
+ schema:
18
+ $ref: "#/definitions/BadRequest"
19
+
20
+ InternalError:
21
+ description: Internal Error
22
+ schema:
23
+ $ref: "#/definitions/InternalError"
24
+
25
+ NotFound:
26
+ description: Entity Not Found
27
+ schema:
28
+ $ref: "#/definitions/NotFound"
29
+
30
+ security:
31
+ - oauth: []
32
+
33
+ paths:
34
+ /districts:
35
+ get:
36
+ tags: ["Districts"]
37
+ description: Returns a list of districts. In practice this will only return the one district associated with the bearer token
38
+ operationId: getDistricts
39
+ parameters:
40
+ - in: query
41
+ name: count
42
+ type: string
43
+ enum:
44
+ - ""
45
+ - "true"
46
+ - "false"
47
+ - "undefined"
48
+ responses:
49
+ "200":
50
+ description: OK Response
51
+ schema:
52
+ $ref: "#/definitions/DistrictsResponse"
53
+
54
+ /districts/{id}:
55
+ get:
56
+ tags: ["Districts"]
57
+ description: Returns a specific district
58
+ operationId: getDistrict
59
+ parameters:
60
+ - in: path
61
+ name: id
62
+ required: true
63
+ type: string
64
+ responses:
65
+ "200":
66
+ description: OK Response
67
+ schema:
68
+ $ref: "#/definitions/DistrictResponse"
69
+ "404":
70
+ $ref: "#/responses/NotFound"
71
+
72
+ /teachers:
73
+ get:
74
+ tags: ["Teachers"]
75
+ description: Returns a list of teachers
76
+ operationId: getTeachers
77
+ parameters:
78
+ - in: query
79
+ name: limit
80
+ type: integer
81
+ - in: query
82
+ name: starting_after
83
+ type: string
84
+ - in: query
85
+ name: ending_before
86
+ type: string
87
+ - in: query
88
+ name: count
89
+ type: string
90
+ enum:
91
+ - ""
92
+ - "true"
93
+ - "false"
94
+ - "undefined"
95
+ responses:
96
+ "200":
97
+ description: OK Response
98
+ schema:
99
+ $ref: "#/definitions/TeachersResponse"
100
+
101
+ /teachers/{id}:
102
+ get:
103
+ tags: ["Teachers"]
104
+ description: Returns a specific teacher
105
+ operationId: getTeacher
106
+ parameters:
107
+ - in: path
108
+ name: id
109
+ required: true
110
+ type: string
111
+ responses:
112
+ "200":
113
+ description: OK Response
114
+ schema:
115
+ $ref: "#/definitions/TeacherResponse"
116
+ "404":
117
+ $ref: "#/responses/NotFound"
118
+
119
+ /teachers/{id}/district:
120
+ get:
121
+ tags: ["Teachers"]
122
+ description: Returns the district for a teacher
123
+ operationId: getDistrictForTeacher
124
+ parameters:
125
+ - in: path
126
+ name: id
127
+ required: true
128
+ type: string
129
+ responses:
130
+ "200":
131
+ description: OK Response
132
+ schema:
133
+ $ref: "#/definitions/DistrictResponse"
134
+ "404":
135
+ $ref: "#/responses/NotFound"
136
+
137
+ /teachers/{id}/school:
138
+ get:
139
+ tags: ["Teachers"]
140
+ description: Retrieves school info for a teacher.
141
+ operationId: getSchoolForTeacher
142
+ parameters:
143
+ - in: path
144
+ name: id
145
+ required: true
146
+ type: string
147
+ responses:
148
+ "200":
149
+ description: OK Response
150
+ schema:
151
+ $ref: "#/definitions/SchoolResponse"
152
+ "404":
153
+ $ref: "#/responses/NotFound"
154
+
155
+ /teachers/{id}/sections:
156
+ get:
157
+ tags: ["Teachers"]
158
+ description: Returns the sections for a teacher
159
+ operationId: getSectionsForTeacher
160
+ parameters:
161
+ - in: path
162
+ name: id
163
+ required: true
164
+ type: string
165
+ - in: query
166
+ name: limit
167
+ type: integer
168
+ - in: query
169
+ name: starting_after
170
+ type: string
171
+ - in: query
172
+ name: ending_before
173
+ type: string
174
+ responses:
175
+ "200":
176
+ description: OK Response
177
+ schema:
178
+ $ref: "#/definitions/SectionsResponse"
179
+ "404":
180
+ $ref: "#/responses/NotFound"
181
+
182
+ /teachers/{id}/students:
183
+ get:
184
+ tags: ["Teachers"]
185
+ description: Returns the students for a teacher
186
+ operationId: getStudentsForTeacher
187
+ parameters:
188
+ - in: path
189
+ name: id
190
+ required: true
191
+ type: string
192
+ - in: query
193
+ name: limit
194
+ type: integer
195
+ - in: query
196
+ name: starting_after
197
+ type: string
198
+ - in: query
199
+ name: ending_before
200
+ type: string
201
+ responses:
202
+ "200":
203
+ description: OK Response
204
+ schema:
205
+ $ref: "#/definitions/StudentsResponse"
206
+ "404":
207
+ $ref: "#/responses/NotFound"
208
+
209
+ /teachers/{id}/schools:
210
+ get:
211
+ tags: ["Teachers"]
212
+ description: Returns the schools for a teacher
213
+ operationId: getSchoolsForTeacher
214
+ parameters:
215
+ - in: path
216
+ name: id
217
+ required: true
218
+ type: string
219
+ - in: query
220
+ name: limit
221
+ type: integer
222
+ - in: query
223
+ name: starting_after
224
+ type: string
225
+ - in: query
226
+ name: ending_before
227
+ type: string
228
+ responses:
229
+ "200":
230
+ description: OK Response
231
+ schema:
232
+ $ref: "#/definitions/SchoolsResponse"
233
+ "404":
234
+ $ref: "#/responses/NotFound"
235
+
236
+ /students:
237
+ get:
238
+ tags: ["Students"]
239
+ description: Returns a list of students
240
+ operationId: getStudents
241
+ parameters:
242
+ - in: query
243
+ name: limit
244
+ type: integer
245
+ - in: query
246
+ name: starting_after
247
+ type: string
248
+ - in: query
249
+ name: ending_before
250
+ type: string
251
+ - in: query
252
+ name: count
253
+ type: string
254
+ enum:
255
+ - ""
256
+ - "true"
257
+ - "false"
258
+ - "undefined"
259
+ responses:
260
+ "200":
261
+ description: OK Response
262
+ schema:
263
+ $ref: "#/definitions/StudentsResponse"
264
+
265
+ /students/{id}:
266
+ get:
267
+ tags: ["Students"]
268
+ description: Returns a specific student
269
+ operationId: getStudent
270
+ parameters:
271
+ - in: path
272
+ name: id
273
+ required: true
274
+ type: string
275
+ responses:
276
+ "200":
277
+ description: OK Response
278
+ schema:
279
+ $ref: "#/definitions/StudentResponse"
280
+ "404":
281
+ $ref: "#/responses/NotFound"
282
+
283
+ /students/{id}/contacts:
284
+ get:
285
+ tags: ["Students"]
286
+ description: Returns the contacts for a student
287
+ operationId: getContactsForStudent
288
+ parameters:
289
+ - in: path
290
+ name: id
291
+ required: true
292
+ type: string
293
+ - in: query
294
+ name: limit
295
+ type: integer
296
+ - in: query
297
+ name: starting_after
298
+ type: string
299
+ - in: query
300
+ name: ending_before
301
+ type: string
302
+ responses:
303
+ "200":
304
+ description: OK Response
305
+ schema:
306
+ $ref: "#/definitions/ContactsResponse"
307
+ "404":
308
+ $ref: "#/responses/NotFound"
309
+
310
+ /students/{id}/district:
311
+ get:
312
+ tags: ["Students"]
313
+ description: Returns the district for a student
314
+ operationId: getDistrictForStudent
315
+ parameters:
316
+ - in: path
317
+ name: id
318
+ required: true
319
+ type: string
320
+ responses:
321
+ "200":
322
+ description: OK Response
323
+ schema:
324
+ $ref: "#/definitions/DistrictResponse"
325
+ "404":
326
+ $ref: "#/responses/NotFound"
327
+
328
+ /students/{id}/school:
329
+ get:
330
+ tags: ["Students"]
331
+ description: Returns the primary school for a student
332
+ operationId: getSchoolForStudent
333
+ parameters:
334
+ - in: path
335
+ name: id
336
+ required: true
337
+ type: string
338
+ responses:
339
+ "200":
340
+ description: OK Response
341
+ schema:
342
+ $ref: "#/definitions/SchoolResponse"
343
+ "404":
344
+ $ref: "#/responses/NotFound"
345
+
346
+ /students/{id}/sections:
347
+ get:
348
+ tags: ["Students"]
349
+ description: Returns the sections for a student
350
+ operationId: getSectionsForStudent
351
+ parameters:
352
+ - in: path
353
+ name: id
354
+ required: true
355
+ type: string
356
+ - in: query
357
+ name: limit
358
+ type: integer
359
+ - in: query
360
+ name: starting_after
361
+ type: string
362
+ - in: query
363
+ name: ending_before
364
+ type: string
365
+ responses:
366
+ "200":
367
+ description: OK Response
368
+ schema:
369
+ $ref: "#/definitions/SectionsResponse"
370
+ "404":
371
+ $ref: "#/responses/NotFound"
372
+
373
+ /students/{id}/teachers:
374
+ get:
375
+ tags: ["Students"]
376
+ description: Returns the teachers for a student
377
+ operationId: getTeachersForStudent
378
+ parameters:
379
+ - in: path
380
+ name: id
381
+ required: true
382
+ type: string
383
+ - in: query
384
+ name: limit
385
+ type: integer
386
+ - in: query
387
+ name: starting_after
388
+ type: string
389
+ - in: query
390
+ name: ending_before
391
+ type: string
392
+ responses:
393
+ "200":
394
+ description: OK Response
395
+ schema:
396
+ $ref: "#/definitions/TeachersResponse"
397
+ "404":
398
+ $ref: "#/responses/NotFound"
399
+
400
+ /students/{id}/schools:
401
+ get:
402
+ tags: ["Students"]
403
+ description: Returns the schools for a student
404
+ operationId: getSchoolsForStudent
405
+ parameters:
406
+ - in: path
407
+ name: id
408
+ required: true
409
+ type: string
410
+ - in: query
411
+ name: limit
412
+ type: integer
413
+ - in: query
414
+ name: starting_after
415
+ type: string
416
+ - in: query
417
+ name: ending_before
418
+ type: string
419
+ responses:
420
+ "200":
421
+ description: OK Response
422
+ schema:
423
+ $ref: "#/definitions/SchoolsResponse"
424
+ "404":
425
+ $ref: "#/responses/NotFound"
426
+
427
+ /sections:
428
+ get:
429
+ tags: ["Sections"]
430
+ description: Returns a list of sections
431
+ operationId: getSections
432
+ parameters:
433
+ - in: query
434
+ name: limit
435
+ type: integer
436
+ - in: query
437
+ name: starting_after
438
+ type: string
439
+ - in: query
440
+ name: ending_before
441
+ type: string
442
+ - in: query
443
+ name: count
444
+ type: string
445
+ enum:
446
+ - ""
447
+ - "true"
448
+ - "false"
449
+ - "undefined"
450
+ responses:
451
+ "200":
452
+ description: OK Response
453
+ schema:
454
+ $ref: "#/definitions/SectionsResponse"
455
+
456
+ /sections/{id}:
457
+ get:
458
+ tags: ["Sections"]
459
+ description: Returns a specific section
460
+ operationId: getSection
461
+ parameters:
462
+ - in: path
463
+ name: id
464
+ required: true
465
+ type: string
466
+ responses:
467
+ "200":
468
+ description: OK Response
469
+ schema:
470
+ $ref: "#/definitions/SectionResponse"
471
+ "404":
472
+ $ref: "#/responses/NotFound"
473
+
474
+ /sections/{id}/district:
475
+ get:
476
+ tags: ["Sections"]
477
+ description: Returns the district for a section
478
+ operationId: getDistrictForSection
479
+ parameters:
480
+ - in: path
481
+ name: id
482
+ required: true
483
+ type: string
484
+ responses:
485
+ "200":
486
+ description: OK Response
487
+ schema:
488
+ $ref: "#/definitions/DistrictResponse"
489
+ "404":
490
+ $ref: "#/responses/NotFound"
491
+
492
+ /sections/{id}/school:
493
+ get:
494
+ tags: ["Sections"]
495
+ description: Returns the school for a section
496
+ operationId: getSchoolForSection
497
+ parameters:
498
+ - in: path
499
+ name: id
500
+ required: true
501
+ type: string
502
+ responses:
503
+ "200":
504
+ description: OK Response
505
+ schema:
506
+ $ref: "#/definitions/SchoolResponse"
507
+ "404":
508
+ $ref: "#/responses/NotFound"
509
+
510
+ /sections/{id}/students:
511
+ get:
512
+ tags: ["Sections"]
513
+ description: Returns the students for a section
514
+ operationId: getStudentsForSection
515
+ parameters:
516
+ - in: path
517
+ name: id
518
+ required: true
519
+ type: string
520
+ - in: query
521
+ name: limit
522
+ type: integer
523
+ - in: query
524
+ name: starting_after
525
+ type: string
526
+ - in: query
527
+ name: ending_before
528
+ type: string
529
+ responses:
530
+ "200":
531
+ description: OK Response
532
+ schema:
533
+ $ref: "#/definitions/StudentsResponse"
534
+ "404":
535
+ $ref: "#/responses/NotFound"
536
+
537
+ /sections/{id}/teacher:
538
+ get:
539
+ tags: ["Sections"]
540
+ description: Returns the primary teacher for a section
541
+ operationId: getTeacherForSection
542
+ parameters:
543
+ - in: path
544
+ name: id
545
+ required: true
546
+ type: string
547
+ responses:
548
+ "200":
549
+ description: OK Response
550
+ schema:
551
+ $ref: "#/definitions/TeacherResponse"
552
+ "404":
553
+ $ref: "#/responses/NotFound"
554
+
555
+ /sections/{id}/teachers:
556
+ get:
557
+ tags: ["Sections"]
558
+ description: Returns the teachers for a section
559
+ operationId: getTeachersForSection
560
+ parameters:
561
+ - in: path
562
+ name: id
563
+ required: true
564
+ type: string
565
+ - in: query
566
+ name: limit
567
+ type: integer
568
+ - in: query
569
+ name: starting_after
570
+ type: string
571
+ - in: query
572
+ name: ending_before
573
+ type: string
574
+ responses:
575
+ "200":
576
+ description: OK Response
577
+ schema:
578
+ $ref: "#/definitions/TeachersResponse"
579
+ "404":
580
+ $ref: "#/responses/NotFound"
581
+
582
+ /sections/{id}/course:
583
+ get:
584
+ tags: ["Sections"]
585
+ description: Returns the course for a section
586
+ operationId: getCourseForSection
587
+ parameters:
588
+ - in: path
589
+ name: id
590
+ required: true
591
+ type: string
592
+ responses:
593
+ "200":
594
+ description: OK Response
595
+ schema:
596
+ $ref: "#/definitions/CourseResponse"
597
+ "404":
598
+ $ref: "#/responses/NotFound"
599
+
600
+ /sections/{id}/term:
601
+ get:
602
+ tags: ["Sections"]
603
+ description: Returns the term for a section
604
+ operationId: getTermForSection
605
+ parameters:
606
+ - in: path
607
+ name: id
608
+ required: true
609
+ type: string
610
+ responses:
611
+ "200":
612
+ description: OK Response
613
+ schema:
614
+ $ref: "#/definitions/TermResponse"
615
+ "404":
616
+ $ref: "#/responses/NotFound"
617
+
618
+ /schools:
619
+ get:
620
+ tags: ["Schools"]
621
+ description: Returns a list of schools
622
+ operationId: getSchools
623
+ parameters:
624
+ - in: query
625
+ name: limit
626
+ type: integer
627
+ - in: query
628
+ name: starting_after
629
+ type: string
630
+ - in: query
631
+ name: ending_before
632
+ type: string
633
+ - in: query
634
+ name: count
635
+ type: string
636
+ enum:
637
+ - ""
638
+ - "true"
639
+ - "false"
640
+ - "undefined"
641
+ responses:
642
+ "200":
643
+ description: OK Response
644
+ schema:
645
+ $ref: "#/definitions/SchoolsResponse"
646
+
647
+ /schools/{id}:
648
+ get:
649
+ tags: ["Schools"]
650
+ description: Returns a specific school
651
+ operationId: getSchool
652
+ parameters:
653
+ - in: path
654
+ name: id
655
+ required: true
656
+ type: string
657
+ responses:
658
+ "200":
659
+ description: OK Response
660
+ schema:
661
+ $ref: "#/definitions/SchoolResponse"
662
+ "404":
663
+ $ref: "#/responses/NotFound"
664
+
665
+ /schools/{id}/district:
666
+ get:
667
+ tags: ["Schools"]
668
+ description: Returns the district for a school
669
+ operationId: getDistrictForSchool
670
+ parameters:
671
+ - in: path
672
+ name: id
673
+ required: true
674
+ type: string
675
+ responses:
676
+ "200":
677
+ description: OK Response
678
+ schema:
679
+ $ref: "#/definitions/DistrictResponse"
680
+ "404":
681
+ $ref: "#/responses/NotFound"
682
+
683
+ /schools/{id}/sections:
684
+ get:
685
+ tags: ["Schools"]
686
+ description: Returns the sections for a school
687
+ operationId: getSectionsForSchool
688
+ parameters:
689
+ - in: path
690
+ name: id
691
+ required: true
692
+ type: string
693
+ - in: query
694
+ name: limit
695
+ type: integer
696
+ - in: query
697
+ name: starting_after
698
+ type: string
699
+ - in: query
700
+ name: ending_before
701
+ type: string
702
+ responses:
703
+ "200":
704
+ description: OK Response
705
+ schema:
706
+ $ref: "#/definitions/SectionsResponse"
707
+ "404":
708
+ $ref: "#/responses/NotFound"
709
+
710
+ /schools/{id}/students:
711
+ get:
712
+ tags: ["Schools"]
713
+ description: Returns the students for a school
714
+ operationId: getStudentsForSchool
715
+ parameters:
716
+ - in: path
717
+ name: id
718
+ required: true
719
+ type: string
720
+ - in: query
721
+ name: limit
722
+ type: integer
723
+ - in: query
724
+ name: starting_after
725
+ type: string
726
+ - in: query
727
+ name: ending_before
728
+ type: string
729
+ responses:
730
+ "200":
731
+ description: OK Response
732
+ schema:
733
+ $ref: "#/definitions/StudentsResponse"
734
+ "404":
735
+ $ref: "#/responses/NotFound"
736
+
737
+ /schools/{id}/teachers:
738
+ get:
739
+ tags: ["Schools"]
740
+ description: Returns the teachers for a school
741
+ operationId: getTeachersForSchool
742
+ parameters:
743
+ - in: path
744
+ name: id
745
+ required: true
746
+ type: string
747
+ - in: query
748
+ name: limit
749
+ type: integer
750
+ - in: query
751
+ name: starting_after
752
+ type: string
753
+ - in: query
754
+ name: ending_before
755
+ type: string
756
+ responses:
757
+ "200":
758
+ description: OK Response
759
+ schema:
760
+ $ref: "#/definitions/TeachersResponse"
761
+ "404":
762
+ $ref: "#/responses/NotFound"
763
+
764
+ /contacts:
765
+ get:
766
+ tags: ["Contacts"]
767
+ description: Returns a list of student contacts
768
+ operationId: getContacts
769
+ parameters:
770
+ - in: query
771
+ name: limit
772
+ type: integer
773
+ - in: query
774
+ name: starting_after
775
+ type: string
776
+ - in: query
777
+ name: ending_before
778
+ type: string
779
+ - in: query
780
+ name: count
781
+ type: string
782
+ enum:
783
+ - ""
784
+ - "true"
785
+ - "false"
786
+ - "undefined"
787
+ responses:
788
+ "200":
789
+ description: OK Response
790
+ schema:
791
+ $ref: "#/definitions/ContactsResponse"
792
+
793
+ /contacts/{id}:
794
+ get:
795
+ tags: ["Contacts"]
796
+ description: Returns a specific student contact
797
+ operationId: getContact
798
+ parameters:
799
+ - in: path
800
+ name: id
801
+ required: true
802
+ type: string
803
+ responses:
804
+ "200":
805
+ description: OK Response
806
+ schema:
807
+ $ref: "#/definitions/ContactResponse"
808
+ "404":
809
+ $ref: "#/responses/NotFound"
810
+
811
+ /contacts/{id}/district:
812
+ get:
813
+ tags: ["Contacts"]
814
+ description: Returns the district for a student contact
815
+ operationId: getDistrictForContact
816
+ parameters:
817
+ - in: path
818
+ name: id
819
+ required: true
820
+ type: string
821
+ responses:
822
+ "200":
823
+ description: OK Response
824
+ schema:
825
+ $ref: "#/definitions/DistrictResponse"
826
+ "404":
827
+ $ref: "#/responses/NotFound"
828
+
829
+ /contacts/{id}/students:
830
+ get:
831
+ tags: ["Contacts"]
832
+ description: Returns the students for a student contact
833
+ operationId: getStudentsForContact
834
+ parameters:
835
+ - in: path
836
+ name: id
837
+ required: true
838
+ type: string
839
+ - in: query
840
+ name: limit
841
+ type: integer
842
+ - in: query
843
+ name: starting_after
844
+ type: string
845
+ - in: query
846
+ name: ending_before
847
+ type: string
848
+ responses:
849
+ "200":
850
+ description: OK Response
851
+ schema:
852
+ $ref: "#/definitions/StudentsResponse"
853
+
854
+ /district_admins:
855
+ get:
856
+ tags: ["District Admins"]
857
+ description: Returns a list of district admins
858
+ operationId: getDistrictAdmins
859
+ parameters:
860
+ - in: query
861
+ name: limit
862
+ type: integer
863
+ - in: query
864
+ name: starting_after
865
+ type: string
866
+ - in: query
867
+ name: ending_before
868
+ type: string
869
+ - in: query
870
+ name: count
871
+ type: string
872
+ enum:
873
+ - ""
874
+ - "true"
875
+ - "false"
876
+ - "undefined"
877
+ responses:
878
+ "200":
879
+ description: OK Response
880
+ schema:
881
+ $ref: "#/definitions/DistrictAdminsResponse"
882
+
883
+ /district_admins/{id}:
884
+ get:
885
+ tags: ["District Admins"]
886
+ description: Returns a specific district admin
887
+ operationId: getDistrictAdmin
888
+ parameters:
889
+ - in: path
890
+ name: id
891
+ required: true
892
+ type: string
893
+ responses:
894
+ "200":
895
+ description: OK Response
896
+ schema:
897
+ $ref: "#/definitions/DistrictAdminResponse"
898
+ "404":
899
+ $ref: "#/responses/NotFound"
900
+
901
+ /district_admins/{id}/district:
902
+ get:
903
+ tags: ["District Admins"]
904
+ description: Returns the district for a district admin
905
+ operationId: getDistrictForDistrictAdmin
906
+ parameters:
907
+ - in: path
908
+ name: id
909
+ required: true
910
+ type: string
911
+ responses:
912
+ "200":
913
+ description: OK Response
914
+ schema:
915
+ $ref: "#/definitions/DistrictResponse"
916
+ "404":
917
+ $ref: "#/responses/NotFound"
918
+
919
+ /school_admins:
920
+ get:
921
+ tags: ["School Admins"]
922
+ description: Returns a list of school admins
923
+ operationId: getSchoolAdmins
924
+ parameters:
925
+ - in: query
926
+ name: limit
927
+ type: integer
928
+ - in: query
929
+ name: starting_after
930
+ type: string
931
+ - in: query
932
+ name: ending_before
933
+ type: string
934
+ - in: query
935
+ name: count
936
+ type: string
937
+ enum:
938
+ - ""
939
+ - "true"
940
+ - "false"
941
+ - "undefined"
942
+ responses:
943
+ "200":
944
+ description: OK Response
945
+ schema:
946
+ $ref: "#/definitions/SchoolAdminsResponse"
947
+
948
+ /school_admins/{id}:
949
+ get:
950
+ tags: ["School Admins"]
951
+ description: Returns a specific school admin
952
+ operationId: getSchoolAdmin
953
+ parameters:
954
+ - in: path
955
+ name: id
956
+ required: true
957
+ type: string
958
+ responses:
959
+ "200":
960
+ description: OK Response
961
+ schema:
962
+ $ref: "#/definitions/SchoolAdminResponse"
963
+ "404":
964
+ $ref: "#/responses/NotFound"
965
+
966
+ /school_admins/{id}/district:
967
+ get:
968
+ tags: ["School Admins"]
969
+ description: Returns the district for a school admin
970
+ operationId: getDistrictForSchoolAdmin
971
+ parameters:
972
+ - in: path
973
+ name: id
974
+ required: true
975
+ type: string
976
+ responses:
977
+ "200":
978
+ description: OK Response
979
+ schema:
980
+ $ref: "#/definitions/DistrictResponse"
981
+ "404":
982
+ $ref: "#/responses/NotFound"
983
+
984
+ /school_admins/{id}/schools:
985
+ get:
986
+ tags: ["School Admins"]
987
+ description: Returns the schools for a school admin
988
+ operationId: getSchoolsForSchoolAdmin
989
+ parameters:
990
+ - in: path
991
+ name: id
992
+ required: true
993
+ type: string
994
+ - in: query
995
+ name: limit
996
+ type: integer
997
+ - in: query
998
+ name: starting_after
999
+ type: string
1000
+ - in: query
1001
+ name: ending_before
1002
+ type: string
1003
+ responses:
1004
+ "200":
1005
+ description: OK Response
1006
+ schema:
1007
+ $ref: "#/definitions/SchoolsResponse"
1008
+ "404":
1009
+ $ref: "#/responses/NotFound"
1010
+
1011
+ /terms:
1012
+ get:
1013
+ tags: ["Terms"]
1014
+ description: Returns a list of terms
1015
+ operationId: getTerms
1016
+ parameters:
1017
+ - in: query
1018
+ name: limit
1019
+ type: integer
1020
+ - in: query
1021
+ name: starting_after
1022
+ type: string
1023
+ - in: query
1024
+ name: ending_before
1025
+ type: string
1026
+ - in: query
1027
+ name: count
1028
+ type: string
1029
+ enum:
1030
+ - ""
1031
+ - "true"
1032
+ - "false"
1033
+ - "undefined"
1034
+ responses:
1035
+ "200":
1036
+ description: OK Response
1037
+ schema:
1038
+ $ref: "#/definitions/TermsResponse"
1039
+
1040
+ /terms/{id}:
1041
+ get:
1042
+ tags: ["Terms"]
1043
+ description: Returns a specific term
1044
+ operationId: getTerm
1045
+ parameters:
1046
+ - in: path
1047
+ name: id
1048
+ required: true
1049
+ type: string
1050
+ responses:
1051
+ "200":
1052
+ description: OK Response
1053
+ schema:
1054
+ $ref: "#/definitions/TermResponse"
1055
+ "404":
1056
+ $ref: "#/responses/NotFound"
1057
+
1058
+ /terms/{id}/sections:
1059
+ get:
1060
+ tags: ["Terms"]
1061
+ description: Returns the sections for a term
1062
+ operationId: getSectionsForTerm
1063
+ parameters:
1064
+ - in: path
1065
+ name: id
1066
+ required: true
1067
+ type: string
1068
+ - in: query
1069
+ name: limit
1070
+ type: integer
1071
+ - in: query
1072
+ name: starting_after
1073
+ type: string
1074
+ - in: query
1075
+ name: ending_before
1076
+ type: string
1077
+ responses:
1078
+ "200":
1079
+ description: OK Response
1080
+ schema:
1081
+ $ref: "#/definitions/SectionsResponse"
1082
+ "404":
1083
+ $ref: "#/responses/NotFound"
1084
+
1085
+ /terms/{id}/district:
1086
+ get:
1087
+ tags: ["Terms"]
1088
+ description: Returns the district for a term
1089
+ operationId: getDistrictForTerm
1090
+ parameters:
1091
+ - in: path
1092
+ name: id
1093
+ required: true
1094
+ type: string
1095
+ responses:
1096
+ "200":
1097
+ description: OK Response
1098
+ schema:
1099
+ $ref: "#/definitions/DistrictResponse"
1100
+ "404":
1101
+ $ref: "#/responses/NotFound"
1102
+
1103
+ /courses:
1104
+ get:
1105
+ tags: ["Courses"]
1106
+ description: Returns a list of courses
1107
+ operationId: getCourses
1108
+ parameters:
1109
+ - in: query
1110
+ name: limit
1111
+ type: integer
1112
+ - in: query
1113
+ name: starting_after
1114
+ type: string
1115
+ - in: query
1116
+ name: ending_before
1117
+ type: string
1118
+ - in: query
1119
+ name: count
1120
+ type: string
1121
+ enum:
1122
+ - ""
1123
+ - "true"
1124
+ - "false"
1125
+ - "undefined"
1126
+ responses:
1127
+ "200":
1128
+ description: OK Response
1129
+ schema:
1130
+ $ref: "#/definitions/CoursesResponse"
1131
+
1132
+ /courses/{id}:
1133
+ get:
1134
+ tags: ["Courses"]
1135
+ description: Returns a specific course
1136
+ operationId: getCourse
1137
+ parameters:
1138
+ - in: path
1139
+ name: id
1140
+ required: true
1141
+ type: string
1142
+ responses:
1143
+ "200":
1144
+ description: OK Response
1145
+ schema:
1146
+ $ref: "#/definitions/CourseResponse"
1147
+ "404":
1148
+ $ref: "#/responses/NotFound"
1149
+
1150
+ /courses/{id}/sections:
1151
+ get:
1152
+ tags: ["Courses"]
1153
+ description: Returns the sections for a Courses
1154
+ operationId: getSectionsForCourse
1155
+ parameters:
1156
+ - in: path
1157
+ name: id
1158
+ required: true
1159
+ type: string
1160
+ - in: query
1161
+ name: limit
1162
+ type: integer
1163
+ - in: query
1164
+ name: starting_after
1165
+ type: string
1166
+ - in: query
1167
+ name: ending_before
1168
+ type: string
1169
+ responses:
1170
+ "200":
1171
+ description: OK Response
1172
+ schema:
1173
+ $ref: "#/definitions/SectionsResponse"
1174
+ "404":
1175
+ $ref: "#/responses/NotFound"
1176
+
1177
+ /courses/{id}/district:
1178
+ get:
1179
+ tags: ["Courses"]
1180
+ description: Returns the district for a course
1181
+ operationId: getDistrictForCourse
1182
+ parameters:
1183
+ - in: path
1184
+ name: id
1185
+ required: true
1186
+ type: string
1187
+ responses:
1188
+ "200":
1189
+ description: OK Response
1190
+ schema:
1191
+ $ref: "#/definitions/DistrictResponse"
1192
+ "404":
1193
+ $ref: "#/responses/NotFound"
1194
+
1195
+ /events:
1196
+ get:
1197
+ tags: ["Events"]
1198
+ description: Returns a list of events
1199
+ operationId: getEvents
1200
+ parameters:
1201
+ - in: query
1202
+ name: limit
1203
+ type: integer
1204
+ - in: query
1205
+ name: starting_after
1206
+ type: string
1207
+ - in: query
1208
+ name: ending_before
1209
+ type: string
1210
+ - in: query
1211
+ name: school
1212
+ type: string
1213
+ - in: query
1214
+ name: record_type
1215
+ type: array
1216
+ collectionFormat: multi
1217
+ items:
1218
+ type: string
1219
+ responses:
1220
+ "200":
1221
+ description: OK Response
1222
+ schema:
1223
+ $ref: "#/definitions/EventsResponse"
1224
+ "404":
1225
+ $ref: "#/responses/NotFound"
1226
+
1227
+ /events/{id}:
1228
+ get:
1229
+ tags: ["Events"]
1230
+ description: Returns the specific event
1231
+ operationId: getEvent
1232
+ parameters:
1233
+ - in: path
1234
+ name: id
1235
+ required: true
1236
+ type: string
1237
+ responses:
1238
+ "200":
1239
+ description: OK Response
1240
+ schema:
1241
+ $ref: "#/definitions/EventResponse"
1242
+ "404":
1243
+ $ref: "#/responses/NotFound"
1244
+
1245
+ securityDefinitions:
1246
+ oauth:
1247
+ type: oauth2
1248
+ flow: accessCode
1249
+ authorizationUrl: https://clever.com/oauth/authorize
1250
+ tokenUrl: https://clever.com/oauth/tokens
1251
+
1252
+ definitions:
1253
+ NotFound:
1254
+ type: object
1255
+ properties:
1256
+ message:
1257
+ type: string
1258
+
1259
+ InternalError:
1260
+ type: object
1261
+ properties:
1262
+ message:
1263
+ type: string
1264
+
1265
+ Link:
1266
+ properties:
1267
+ rel:
1268
+ enum:
1269
+ - next
1270
+ - prev
1271
+ - self
1272
+ type: string
1273
+ uri:
1274
+ type: string
1275
+ type: object
1276
+
1277
+ BadRequest:
1278
+ type: object
1279
+ properties:
1280
+ message:
1281
+ type: string
1282
+
1283
+ StudentsResponse:
1284
+ type: object
1285
+ properties:
1286
+ data:
1287
+ type: array
1288
+ items:
1289
+ $ref: "#/definitions/StudentResponse"
1290
+ links:
1291
+ items:
1292
+ $ref: "#/definitions/Link"
1293
+ type: array
1294
+
1295
+ StudentResponse:
1296
+ type: object
1297
+ properties:
1298
+ data:
1299
+ $ref: "#/definitions/Student"
1300
+
1301
+ ContactsResponse:
1302
+ type: object
1303
+ properties:
1304
+ data:
1305
+ type: array
1306
+ items:
1307
+ $ref: "#/definitions/ContactResponse"
1308
+ links:
1309
+ items:
1310
+ $ref: "#/definitions/Link"
1311
+ type: array
1312
+
1313
+ ContactResponse:
1314
+ type: object
1315
+ properties:
1316
+ data:
1317
+ $ref: "#/definitions/Contact"
1318
+
1319
+ TeachersResponse:
1320
+ type: object
1321
+ properties:
1322
+ data:
1323
+ type: array
1324
+ items:
1325
+ $ref: "#/definitions/TeacherResponse"
1326
+ links:
1327
+ items:
1328
+ $ref: "#/definitions/Link"
1329
+ type: array
1330
+
1331
+ TeacherResponse:
1332
+ type: object
1333
+ properties:
1334
+ data:
1335
+ $ref: "#/definitions/Teacher"
1336
+
1337
+ SectionsResponse:
1338
+ type: object
1339
+ properties:
1340
+ data:
1341
+ type: array
1342
+ items:
1343
+ $ref: "#/definitions/SectionResponse"
1344
+ links:
1345
+ items:
1346
+ $ref: "#/definitions/Link"
1347
+ type: array
1348
+
1349
+ SectionResponse:
1350
+ type: object
1351
+ properties:
1352
+ data:
1353
+ $ref: "#/definitions/Section"
1354
+
1355
+ SchoolsResponse:
1356
+ type: object
1357
+ properties:
1358
+ data:
1359
+ type: array
1360
+ items:
1361
+ $ref: "#/definitions/SchoolResponse"
1362
+ links:
1363
+ items:
1364
+ $ref: "#/definitions/Link"
1365
+ type: array
1366
+
1367
+ SchoolResponse:
1368
+ type: object
1369
+ properties:
1370
+ data:
1371
+ $ref: "#/definitions/School"
1372
+
1373
+ SchoolAdminsResponse:
1374
+ type: object
1375
+ properties:
1376
+ data:
1377
+ type: array
1378
+ items:
1379
+ $ref: "#/definitions/SchoolAdminResponse"
1380
+ links:
1381
+ items:
1382
+ $ref: "#/definitions/Link"
1383
+ type: array
1384
+
1385
+ SchoolAdminResponse:
1386
+ type: object
1387
+ properties:
1388
+ data:
1389
+ $ref: "#/definitions/SchoolAdmin"
1390
+
1391
+ TermsResponse:
1392
+ type: object
1393
+ properties:
1394
+ data:
1395
+ type: array
1396
+ items:
1397
+ $ref: "#/definitions/TermResponse"
1398
+ links:
1399
+ items:
1400
+ $ref: "#/definitions/Link"
1401
+ type: array
1402
+
1403
+ TermResponse:
1404
+ type: object
1405
+ properties:
1406
+ data:
1407
+ $ref: "#/definitions/Term"
1408
+
1409
+ CoursesResponse:
1410
+ type: object
1411
+ properties:
1412
+ data:
1413
+ type: array
1414
+ items:
1415
+ $ref: "#/definitions/CourseResponse"
1416
+ links:
1417
+ items:
1418
+ $ref: "#/definitions/Link"
1419
+ type: array
1420
+
1421
+ CourseResponse:
1422
+ type: object
1423
+ properties:
1424
+ data:
1425
+ $ref: "#/definitions/Course"
1426
+
1427
+ DistrictsResponse:
1428
+ type: object
1429
+ properties:
1430
+ data:
1431
+ type: array
1432
+ items:
1433
+ $ref: "#/definitions/DistrictResponse"
1434
+ links:
1435
+ items:
1436
+ $ref: "#/definitions/Link"
1437
+ type: array
1438
+
1439
+ DistrictResponse:
1440
+ type: object
1441
+ properties:
1442
+ data:
1443
+ $ref: "#/definitions/District"
1444
+
1445
+ DistrictAdminsResponse:
1446
+ type: object
1447
+ properties:
1448
+ data:
1449
+ type: array
1450
+ items:
1451
+ $ref: "#/definitions/DistrictAdminResponse"
1452
+ links:
1453
+ items:
1454
+ $ref: "#/definitions/Link"
1455
+ type: array
1456
+
1457
+ DistrictAdminResponse:
1458
+ type: object
1459
+ properties:
1460
+ data:
1461
+ $ref: "#/definitions/DistrictAdmin"
1462
+
1463
+ Student:
1464
+ type: object
1465
+ properties:
1466
+ id:
1467
+ type: string
1468
+ x-validation: true
1469
+ created:
1470
+ type: string
1471
+ format: datetime
1472
+ x-validation: true
1473
+ credentials:
1474
+ $ref: "#/definitions/Credentials"
1475
+ district:
1476
+ type: string
1477
+ x-validation: true
1478
+ dob:
1479
+ type: string
1480
+ pattern: (?:[0-9]{1,2})/([0-9]{1,2})/([0-9]{4})
1481
+ x-nullable: true
1482
+ x-validation: true
1483
+ ell_status:
1484
+ type: string
1485
+ x-nullable: true
1486
+ x-validation: true
1487
+ enum:
1488
+ - "Y"
1489
+ - "N"
1490
+ - ""
1491
+ email:
1492
+ type: string
1493
+ x-nullable: true
1494
+ enrollments:
1495
+ type: array
1496
+ x-validation: true
1497
+ items:
1498
+ $ref: "#/definitions/SchoolEnrollment"
1499
+ gender:
1500
+ type: string
1501
+ x-nullable: true
1502
+ x-validation: true
1503
+ enum:
1504
+ - "M"
1505
+ - "F"
1506
+ - "X"
1507
+ - ""
1508
+ graduation_year:
1509
+ type: string
1510
+ x-nullable: true
1511
+ x-validation: true
1512
+ grade:
1513
+ type: string
1514
+ x-nullable: true
1515
+ x-validation: true
1516
+ enum:
1517
+ - "InfantToddler"
1518
+ - "Preschool"
1519
+ - "PreKindergarten"
1520
+ - "TransitionalKindergarten"
1521
+ - "Kindergarten"
1522
+ - "1"
1523
+ - "2"
1524
+ - "3"
1525
+ - "4"
1526
+ - "5"
1527
+ - "6"
1528
+ - "7"
1529
+ - "8"
1530
+ - "9"
1531
+ - "10"
1532
+ - "11"
1533
+ - "12"
1534
+ - "13"
1535
+ - "PostGraduate"
1536
+ - "Ungraded"
1537
+ - "Other"
1538
+ - ""
1539
+ hispanic_ethnicity:
1540
+ type: string
1541
+ x-nullable: true
1542
+ x-validation: true
1543
+ enum:
1544
+ - "Y"
1545
+ - "N"
1546
+ - ""
1547
+ home_language:
1548
+ type: string
1549
+ x-nullable: true
1550
+ x-validation: true
1551
+ enum:
1552
+ - English
1553
+ - Albanian
1554
+ - Amharic
1555
+ - Arabic
1556
+ - Bengali
1557
+ - Bosnian
1558
+ - Burmese
1559
+ - Cantonese
1560
+ - Chinese
1561
+ - Dutch
1562
+ - Farsi
1563
+ - French
1564
+ - German
1565
+ - Hebrew
1566
+ - Hindi
1567
+ - Hmong
1568
+ - Ilocano
1569
+ - Japanese
1570
+ - Javanese
1571
+ - Karen
1572
+ - Khmer
1573
+ - Korean
1574
+ - Laotian
1575
+ - Latvian
1576
+ - Malay
1577
+ - Mandarin
1578
+ - Nepali
1579
+ - Oromo
1580
+ - Polish
1581
+ - Portuguese
1582
+ - Punjabi
1583
+ - Romanian
1584
+ - Russian
1585
+ - Samoan
1586
+ - Serbian
1587
+ - Somali
1588
+ - Spanish
1589
+ - Swahili
1590
+ - Tagalog
1591
+ - Tamil
1592
+ - Telugu
1593
+ - Thai
1594
+ - Tigrinya
1595
+ - Turkish
1596
+ - Ukrainian
1597
+ - Urdu
1598
+ - Vietnamese
1599
+ - ""
1600
+ iep_status:
1601
+ type: string
1602
+ x-nullable: true
1603
+ last_modified:
1604
+ type: string
1605
+ format: datetime
1606
+ x-validation: true
1607
+ location:
1608
+ $ref: "#/definitions/Location"
1609
+ x-nullable: true
1610
+ name:
1611
+ $ref: "#/definitions/Name"
1612
+ race:
1613
+ type: string
1614
+ x-nullable: true
1615
+ x-validation: true
1616
+ enum:
1617
+ - "Caucasian"
1618
+ - "Asian"
1619
+ - "Black or African American"
1620
+ - "American Indian"
1621
+ - "Hawaiian or Other Pacific Islander"
1622
+ - "Two or More Races"
1623
+ - "Unknown"
1624
+ - ""
1625
+ school:
1626
+ type: string
1627
+ x-validation: true
1628
+ schools:
1629
+ type: array
1630
+ x-validation: true
1631
+ items:
1632
+ type: string
1633
+ sis_id:
1634
+ type: string
1635
+ state_id:
1636
+ type: string
1637
+ x-nullable: true
1638
+ student_number:
1639
+ type: string
1640
+ x-nullable: true
1641
+ unweighted_gpa:
1642
+ type: string
1643
+ x-nullable: true
1644
+ weighted_gpa:
1645
+ type: string
1646
+ x-nullable: true
1647
+ ext:
1648
+ type: object
1649
+
1650
+ SchoolEnrollment:
1651
+ type: object
1652
+ properties:
1653
+ school:
1654
+ type: string
1655
+ x-validation: true
1656
+ start_date:
1657
+ type: string
1658
+ format: datetime
1659
+ x-validation: true
1660
+ end_date:
1661
+ type: string
1662
+ format: datetime
1663
+ x-validation: true
1664
+
1665
+ Contact:
1666
+ type: object
1667
+ properties:
1668
+ id:
1669
+ type: string
1670
+ x-validation: true
1671
+ district:
1672
+ type: string
1673
+ x-validation: true
1674
+ email:
1675
+ type: string
1676
+ x-nullable: true
1677
+ name:
1678
+ type: string
1679
+ phone:
1680
+ type: string
1681
+ x-nullable: true
1682
+ phone_type:
1683
+ type: string
1684
+ x-nullable: true
1685
+ x-validation: true
1686
+ enum:
1687
+ - Cell
1688
+ - Home
1689
+ - Work
1690
+ - Other
1691
+ - ""
1692
+ relationship:
1693
+ type: string
1694
+ x-nullable: true
1695
+ x-validation: true
1696
+ enum:
1697
+ - "Parent"
1698
+ - "Grandparent"
1699
+ - "Self"
1700
+ - "Aunt/Uncle"
1701
+ - "Sibling"
1702
+ - "Other"
1703
+ - ""
1704
+ sis_id:
1705
+ type: string
1706
+ x-nullable: true
1707
+ students:
1708
+ type: array
1709
+ x-validation: true
1710
+ items:
1711
+ type: string
1712
+ type:
1713
+ type: string
1714
+ x-nullable: true
1715
+ x-validation: true
1716
+ enum:
1717
+ - "Parent/Guardian"
1718
+ - "Emergency"
1719
+ - "Primary"
1720
+ - "Secondary"
1721
+ - "Family"
1722
+ - "Other"
1723
+ - ""
1724
+
1725
+ Teacher:
1726
+ type: object
1727
+ properties:
1728
+ id:
1729
+ type: string
1730
+ x-validation: true
1731
+ created:
1732
+ type: string
1733
+ format: datetime
1734
+ x-validation: true
1735
+ credentials:
1736
+ $ref: "#/definitions/Credentials"
1737
+ x-nullable: true
1738
+ district:
1739
+ type: string
1740
+ x-validation: true
1741
+ email:
1742
+ type: string
1743
+ x-nullable: true
1744
+ last_modified:
1745
+ type: string
1746
+ format: datetime
1747
+ x-validation: true
1748
+ name:
1749
+ $ref: "#/definitions/Name"
1750
+ school:
1751
+ type: string
1752
+ x-validation: true
1753
+ schools:
1754
+ type: array
1755
+ x-validation: true
1756
+ items:
1757
+ type: string
1758
+ sis_id:
1759
+ type: string
1760
+ state_id:
1761
+ type: string
1762
+ x-nullable: true
1763
+ teacher_number:
1764
+ type: string
1765
+ x-nullable: true
1766
+ title:
1767
+ type: string
1768
+ x-nullable: true
1769
+ ext:
1770
+ type: object
1771
+
1772
+ Section:
1773
+ type: object
1774
+ properties:
1775
+ id:
1776
+ type: string
1777
+ x-validation: true
1778
+ course:
1779
+ type: string
1780
+ x-validation: true
1781
+ x-nullable: true
1782
+ created:
1783
+ type: string
1784
+ format: datetime
1785
+ x-validation: true
1786
+ district:
1787
+ type: string
1788
+ x-validation: true
1789
+ grade:
1790
+ type: string
1791
+ x-nullable: true
1792
+ x-validation: true
1793
+ enum:
1794
+ - "InfantToddler"
1795
+ - "Preschool"
1796
+ - "PreKindergarten"
1797
+ - "TransitionalKindergarten"
1798
+ - "Kindergarten"
1799
+ - "1"
1800
+ - "2"
1801
+ - "3"
1802
+ - "4"
1803
+ - "5"
1804
+ - "6"
1805
+ - "7"
1806
+ - "8"
1807
+ - "9"
1808
+ - "10"
1809
+ - "11"
1810
+ - "12"
1811
+ - "13"
1812
+ - "PostGraduate"
1813
+ - "Ungraded"
1814
+ - "Other"
1815
+ - ""
1816
+ last_modified:
1817
+ type: string
1818
+ format: datetime
1819
+ x-validation: true
1820
+ name:
1821
+ type: string
1822
+ period:
1823
+ type: string
1824
+ x-nullable: true
1825
+ school:
1826
+ type: string
1827
+ x-validation: true
1828
+ section_number:
1829
+ type: string
1830
+ x-nullable: true
1831
+ sis_id:
1832
+ type: string
1833
+ students:
1834
+ type: array
1835
+ x-validation: true
1836
+ items:
1837
+ type: string
1838
+ subject:
1839
+ type: string
1840
+ x-nullable: true
1841
+ x-validation: true
1842
+ enum:
1843
+ - "english/language arts"
1844
+ - "math"
1845
+ - "science"
1846
+ - "social studies"
1847
+ - "language"
1848
+ - "homeroom/advisory"
1849
+ - "interventions/online learning"
1850
+ - "technology and engineering"
1851
+ - "PE and health"
1852
+ - "arts and music"
1853
+ - "other"
1854
+ - ""
1855
+ teacher:
1856
+ type: string
1857
+ x-nullable: true
1858
+ x-validation: true
1859
+ teachers:
1860
+ type: array
1861
+ x-validation: true
1862
+ items:
1863
+ type: string
1864
+ term_id:
1865
+ type: string
1866
+ x-validation: true
1867
+ x-nullable: true
1868
+ ext:
1869
+ type: object
1870
+
1871
+ School:
1872
+ type: object
1873
+ properties:
1874
+ id:
1875
+ type: string
1876
+ x-validation: true
1877
+ created:
1878
+ type: string
1879
+ format: datetime
1880
+ x-validation: true
1881
+ district:
1882
+ type: string
1883
+ x-validation: true
1884
+ high_grade:
1885
+ type: string
1886
+ x-nullable: true
1887
+ x-validation: true
1888
+ enum:
1889
+ - "InfantToddler"
1890
+ - "Preschool"
1891
+ - "PreKindergarten"
1892
+ - "TransitionalKindergarten"
1893
+ - "Kindergarten"
1894
+ - "1"
1895
+ - "2"
1896
+ - "3"
1897
+ - "4"
1898
+ - "5"
1899
+ - "6"
1900
+ - "7"
1901
+ - "8"
1902
+ - "9"
1903
+ - "10"
1904
+ - "11"
1905
+ - "12"
1906
+ - "13"
1907
+ - "PostGraduate"
1908
+ - "Ungraded"
1909
+ - "Other"
1910
+ - ""
1911
+ last_modified:
1912
+ type: string
1913
+ format: datetime
1914
+ x-validation: true
1915
+ location:
1916
+ $ref: "#/definitions/Location"
1917
+ x-nullable: true
1918
+ low_grade:
1919
+ type: string
1920
+ x-nullable: true
1921
+ x-validation: true
1922
+ enum:
1923
+ - "InfantToddler"
1924
+ - "Preschool"
1925
+ - "PreKindergarten"
1926
+ - "TransitionalKindergarten"
1927
+ - "Kindergarten"
1928
+ - "1"
1929
+ - "2"
1930
+ - "3"
1931
+ - "4"
1932
+ - "5"
1933
+ - "6"
1934
+ - "7"
1935
+ - "8"
1936
+ - "9"
1937
+ - "10"
1938
+ - "11"
1939
+ - "12"
1940
+ - "13"
1941
+ - "PostGraduate"
1942
+ - "Ungraded"
1943
+ - "Other"
1944
+ - ""
1945
+ name:
1946
+ type: string
1947
+ nces_id:
1948
+ type: string
1949
+ x-nullable: true
1950
+ phone:
1951
+ type: string
1952
+ x-nullable: true
1953
+ principal:
1954
+ $ref: "#/definitions/Principal"
1955
+ school_number:
1956
+ type: string
1957
+ sis_id:
1958
+ type: string
1959
+ state_id:
1960
+ type: string
1961
+ x-nullable: true
1962
+ mdr_number:
1963
+ type: string
1964
+ x-nullable: true
1965
+ ext:
1966
+ type: object
1967
+
1968
+ SchoolAdmin:
1969
+ type: object
1970
+ properties:
1971
+ id:
1972
+ type: string
1973
+ x-validation: true
1974
+ credentials:
1975
+ $ref: "#/definitions/Credentials"
1976
+ district:
1977
+ type: string
1978
+ x-validation: true
1979
+ email:
1980
+ type: string
1981
+ name:
1982
+ $ref: "#/definitions/AdminName"
1983
+ schools:
1984
+ type: array
1985
+ x-validation: true
1986
+ items:
1987
+ type: string
1988
+ staff_id:
1989
+ type: string
1990
+ title:
1991
+ type: string
1992
+ x-nullable: true
1993
+ department:
1994
+ type: string
1995
+ x-nullable: true
1996
+ ext:
1997
+ type: object
1998
+
1999
+ District:
2000
+ type: object
2001
+ properties:
2002
+ id:
2003
+ type: string
2004
+ x-validation: true
2005
+ name:
2006
+ type: string
2007
+ mdr_number:
2008
+ type: string
2009
+ x-nullable: true
2010
+ nces_id:
2011
+ type: string
2012
+ x-nullable: true
2013
+ sis_type:
2014
+ type: string
2015
+ x-validation: true
2016
+ state:
2017
+ type: string
2018
+ x-nullable: true
2019
+ x-validation: true
2020
+ enum:
2021
+ - "running"
2022
+ - "pending"
2023
+ - "error"
2024
+ - "paused"
2025
+ - ""
2026
+ - "success"
2027
+ last_sync:
2028
+ type: string
2029
+ x-validation: true
2030
+ x-nullable: true
2031
+ format: datetime
2032
+ error:
2033
+ type: string
2034
+ pause_start:
2035
+ type: string
2036
+ x-validation: true
2037
+ x-nullable: true
2038
+ format: datetime
2039
+ pause_end:
2040
+ type: string
2041
+ x-validation: true
2042
+ x-nullable: true
2043
+ format: datetime
2044
+ launch_date:
2045
+ type: string
2046
+ x-validation: true
2047
+ format: datetime
2048
+ portal_url:
2049
+ type: string
2050
+ login_methods:
2051
+ type: array
2052
+ x-validation: true
2053
+ items:
2054
+ type: string
2055
+ district_contact:
2056
+ $ref: "#/definitions/DistrictAdmin"
2057
+ x-nullable: true
2058
+ x-validation: true
2059
+
2060
+ DistrictAdmin:
2061
+ type: object
2062
+ properties:
2063
+ id:
2064
+ type: string
2065
+ x-validation: true
2066
+ name:
2067
+ $ref: "#/definitions/AdminName"
2068
+ x-nullable: true
2069
+ email:
2070
+ type: string
2071
+ title:
2072
+ type: string
2073
+ x-nullable: true
2074
+ district:
2075
+ type: string
2076
+ x-validation: true
2077
+
2078
+ Name:
2079
+ type: object
2080
+ properties:
2081
+ first:
2082
+ type: string
2083
+ x-nullable: true
2084
+ middle:
2085
+ type: string
2086
+ x-nullable: true
2087
+ last:
2088
+ type: string
2089
+ x-nullable: true
2090
+
2091
+ AdminName:
2092
+ type: object
2093
+ properties:
2094
+ first:
2095
+ type: string
2096
+ x-nullable: true
2097
+ last:
2098
+ type: string
2099
+ x-nullable: true
2100
+
2101
+ Location:
2102
+ type: object
2103
+ properties:
2104
+ address:
2105
+ type: string
2106
+ x-nullable: true
2107
+ city:
2108
+ type: string
2109
+ x-nullable: true
2110
+ state:
2111
+ type: string
2112
+ x-nullable: true
2113
+ zip:
2114
+ type: string
2115
+ x-nullable: true
2116
+ lat:
2117
+ type: string
2118
+ x-nullable: true
2119
+ lon:
2120
+ type: string
2121
+ x-nullable: true
2122
+
2123
+ Term:
2124
+ type: object
2125
+ properties:
2126
+ id:
2127
+ type: string
2128
+ x-validation: true
2129
+ name:
2130
+ type: string
2131
+ x-nullable: true
2132
+ start_date:
2133
+ type: string
2134
+ format: datetime
2135
+ x-nullable: true
2136
+ x-validation: true
2137
+ end_date:
2138
+ type: string
2139
+ format: datetime
2140
+ x-nullable: true
2141
+ x-validation: true
2142
+ district:
2143
+ type: string
2144
+ x-validation: true
2145
+
2146
+ Course:
2147
+ type: object
2148
+ properties:
2149
+ id:
2150
+ type: string
2151
+ x-validation: true
2152
+ name:
2153
+ type: string
2154
+ x-nullable: true
2155
+ number:
2156
+ type: string
2157
+ x-nullable: true
2158
+ district:
2159
+ type: string
2160
+ x-validation: true
2161
+
2162
+ Credentials:
2163
+ type: object
2164
+ properties:
2165
+ district_username:
2166
+ type: string
2167
+
2168
+ Principal:
2169
+ type: object
2170
+ properties:
2171
+ name:
2172
+ type: string
2173
+ x-nullable: true
2174
+ email:
2175
+ type: string
2176
+ x-nullable: true
2177
+
2178
+ StudentObject:
2179
+ type: object
2180
+ properties:
2181
+ object:
2182
+ $ref: "#/definitions/Student"
2183
+
2184
+ TeacherObject:
2185
+ type: object
2186
+ properties:
2187
+ object:
2188
+ $ref: "#/definitions/Teacher"
2189
+
2190
+ SchoolAdminObject:
2191
+ type: object
2192
+ properties:
2193
+ object:
2194
+ $ref: "#/definitions/SchoolAdmin"
2195
+
2196
+ DistrictAdminObject:
2197
+ type: object
2198
+ properties:
2199
+ object:
2200
+ $ref: "#/definitions/DistrictAdmin"
2201
+
2202
+ SectionObject:
2203
+ type: object
2204
+ properties:
2205
+ object:
2206
+ $ref: "#/definitions/Section"
2207
+
2208
+ ContactObject:
2209
+ type: object
2210
+ properties:
2211
+ object:
2212
+ $ref: "#/definitions/Contact"
2213
+
2214
+ SchoolObject:
2215
+ type: object
2216
+ properties:
2217
+ object:
2218
+ $ref: "#/definitions/School"
2219
+
2220
+ DistrictObject:
2221
+ type: object
2222
+ properties:
2223
+ object:
2224
+ $ref: "#/definitions/District"
2225
+
2226
+ TermObject:
2227
+ type: object
2228
+ properties:
2229
+ object:
2230
+ $ref: "#/definitions/Term"
2231
+
2232
+ CourseObject:
2233
+ type: object
2234
+ properties:
2235
+ object:
2236
+ $ref: "#/definitions/Course"
2237
+
2238
+ EventsResponse:
2239
+ type: object
2240
+ properties:
2241
+ data:
2242
+ type: array
2243
+ items:
2244
+ $ref: "#/definitions/EventResponse"
2245
+ links:
2246
+ items:
2247
+ $ref: "#/definitions/Link"
2248
+ type: array
2249
+
2250
+ EventResponse:
2251
+ type: object
2252
+ properties:
2253
+ data:
2254
+ $ref: "#/definitions/Event"
2255
+
2256
+ Event:
2257
+ type: object
2258
+ discriminator: type
2259
+ properties:
2260
+ type:
2261
+ type: string
2262
+ x-validation: true
2263
+ id:
2264
+ type: string
2265
+ x-validation: true
2266
+ created:
2267
+ type: string
2268
+ x-validation: true
2269
+ format: datetime
2270
+ required:
2271
+ - type
2272
+
2273
+ students.updated:
2274
+ allOf:
2275
+ - $ref: "#/definitions/Event"
2276
+ - type: object
2277
+ properties:
2278
+ data:
2279
+ $ref: "#/definitions/StudentObject"
2280
+ previous_attributes:
2281
+ additionalProperties:
2282
+ type: object
2283
+
2284
+ students.created:
2285
+ allOf:
2286
+ - $ref: "#/definitions/Event"
2287
+ - type: object
2288
+ properties:
2289
+ data:
2290
+ $ref: "#/definitions/StudentObject"
2291
+
2292
+ students.deleted:
2293
+ allOf:
2294
+ - $ref: "#/definitions/Event"
2295
+ - type: object
2296
+ properties:
2297
+ data:
2298
+ $ref: "#/definitions/StudentObject"
2299
+
2300
+ teachers.updated:
2301
+ allOf:
2302
+ - $ref: "#/definitions/Event"
2303
+ - type: object
2304
+ properties:
2305
+ data:
2306
+ $ref: "#/definitions/TeacherObject"
2307
+ previous_attributes:
2308
+ additionalProperties:
2309
+ type: object
2310
+
2311
+ teachers.created:
2312
+ allOf:
2313
+ - $ref: "#/definitions/Event"
2314
+ - type: object
2315
+ properties:
2316
+ data:
2317
+ $ref: "#/definitions/TeacherObject"
2318
+
2319
+ teachers.deleted:
2320
+ allOf:
2321
+ - $ref: "#/definitions/Event"
2322
+ - type: object
2323
+ properties:
2324
+ data:
2325
+ $ref: "#/definitions/TeacherObject"
2326
+
2327
+ sections.updated:
2328
+ allOf:
2329
+ - $ref: "#/definitions/Event"
2330
+ - type: object
2331
+ properties:
2332
+ data:
2333
+ $ref: "#/definitions/SectionObject"
2334
+ previous_attributes:
2335
+ additionalProperties:
2336
+ type: object
2337
+
2338
+ sections.created:
2339
+ allOf:
2340
+ - $ref: "#/definitions/Event"
2341
+ - type: object
2342
+ properties:
2343
+ data:
2344
+ $ref: "#/definitions/SectionObject"
2345
+
2346
+ sections.deleted:
2347
+ allOf:
2348
+ - $ref: "#/definitions/Event"
2349
+ - type: object
2350
+ properties:
2351
+ data:
2352
+ $ref: "#/definitions/SectionObject"
2353
+
2354
+ schools.updated:
2355
+ allOf:
2356
+ - $ref: "#/definitions/Event"
2357
+ - type: object
2358
+ properties:
2359
+ data:
2360
+ $ref: "#/definitions/SchoolObject"
2361
+ previous_attributes:
2362
+ additionalProperties:
2363
+ type: object
2364
+
2365
+ schools.created:
2366
+ allOf:
2367
+ - $ref: "#/definitions/Event"
2368
+ - type: object
2369
+ properties:
2370
+ data:
2371
+ $ref: "#/definitions/SchoolObject"
2372
+
2373
+ schools.deleted:
2374
+ allOf:
2375
+ - $ref: "#/definitions/Event"
2376
+ - type: object
2377
+ properties:
2378
+ data:
2379
+ $ref: "#/definitions/SchoolObject"
2380
+
2381
+ schooladmins.updated:
2382
+ allOf:
2383
+ - $ref: "#/definitions/Event"
2384
+ - type: object
2385
+ properties:
2386
+ data:
2387
+ $ref: "#/definitions/SchoolAdminObject"
2388
+ previous_attributes:
2389
+ additionalProperties:
2390
+ type: object
2391
+
2392
+ schooladmins.created:
2393
+ allOf:
2394
+ - $ref: "#/definitions/Event"
2395
+ - type: object
2396
+ properties:
2397
+ data:
2398
+ $ref: "#/definitions/SchoolAdminObject"
2399
+
2400
+ schooladmins.deleted:
2401
+ allOf:
2402
+ - $ref: "#/definitions/Event"
2403
+ - type: object
2404
+ properties:
2405
+ data:
2406
+ $ref: "#/definitions/SchoolAdminObject"
2407
+
2408
+ contacts.updated:
2409
+ allOf:
2410
+ - $ref: "#/definitions/Event"
2411
+ - type: object
2412
+ properties:
2413
+ data:
2414
+ $ref: "#/definitions/ContactObject"
2415
+ previous_attributes:
2416
+ additionalProperties:
2417
+ type: object
2418
+
2419
+ contacts.created:
2420
+ allOf:
2421
+ - $ref: "#/definitions/Event"
2422
+ - type: object
2423
+ properties:
2424
+ data:
2425
+ $ref: "#/definitions/ContactObject"
2426
+
2427
+ contacts.deleted:
2428
+ allOf:
2429
+ - $ref: "#/definitions/Event"
2430
+ - type: object
2431
+ properties:
2432
+ data:
2433
+ $ref: "#/definitions/ContactObject"
2434
+
2435
+ districts.updated:
2436
+ allOf:
2437
+ - $ref: "#/definitions/Event"
2438
+ - type: object
2439
+ properties:
2440
+ data:
2441
+ $ref: "#/definitions/DistrictObject"
2442
+ previous_attributes:
2443
+ additionalProperties:
2444
+ type: object
2445
+
2446
+ districts.created:
2447
+ allOf:
2448
+ - $ref: "#/definitions/Event"
2449
+ - type: object
2450
+ properties:
2451
+ data:
2452
+ $ref: "#/definitions/DistrictObject"
2453
+
2454
+ districts.deleted:
2455
+ allOf:
2456
+ - $ref: "#/definitions/Event"
2457
+ - type: object
2458
+ properties:
2459
+ data:
2460
+ $ref: "#/definitions/DistrictObject"
2461
+
2462
+ terms.updated:
2463
+ allOf:
2464
+ - $ref: "#/definitions/Event"
2465
+ - type: object
2466
+ properties:
2467
+ data:
2468
+ $ref: "#/definitions/TermObject"
2469
+ previous_attributes:
2470
+ additionalProperties:
2471
+ type: object
2472
+
2473
+ terms.created:
2474
+ allOf:
2475
+ - $ref: "#/definitions/Event"
2476
+ - type: object
2477
+ properties:
2478
+ data:
2479
+ $ref: "#/definitions/TermObject"
2480
+
2481
+ terms.deleted:
2482
+ allOf:
2483
+ - $ref: "#/definitions/Event"
2484
+ - type: object
2485
+ properties:
2486
+ data:
2487
+ $ref: "#/definitions/TermObject"
2488
+
2489
+ courses.updated:
2490
+ allOf:
2491
+ - $ref: "#/definitions/Event"
2492
+ - type: object
2493
+ properties:
2494
+ data:
2495
+ $ref: "#/definitions/CourseObject"
2496
+ previous_attributes:
2497
+ additionalProperties:
2498
+ type: object
2499
+
2500
+ courses.created:
2501
+ allOf:
2502
+ - $ref: "#/definitions/Event"
2503
+ - type: object
2504
+ properties:
2505
+ data:
2506
+ $ref: "#/definitions/CourseObject"
2507
+
2508
+ courses.deleted:
2509
+ allOf:
2510
+ - $ref: "#/definitions/Event"
2511
+ - type: object
2512
+ properties:
2513
+ data:
2514
+ $ref: "#/definitions/CourseObject"
2515
+
2516
+ districtadmins.updated:
2517
+ allOf:
2518
+ - $ref: "#/definitions/Event"
2519
+ - type: object
2520
+ properties:
2521
+ data:
2522
+ $ref: "#/definitions/DistrictAdminObject"
2523
+ previous_attributes:
2524
+ additionalProperties:
2525
+ type: object
2526
+
2527
+ districtadmins.created:
2528
+ allOf:
2529
+ - $ref: "#/definitions/Event"
2530
+ - type: object
2531
+ properties:
2532
+ data:
2533
+ $ref: "#/definitions/DistrictAdminObject"
2534
+
2535
+ districtadmins.deleted:
2536
+ allOf:
2537
+ - $ref: "#/definitions/Event"
2538
+ - type: object
2539
+ properties:
2540
+ data:
2541
+ $ref: "#/definitions/DistrictAdminObject"