forked from instructure/pandarus
-
Notifications
You must be signed in to change notification settings - Fork 0
/
enrollments.json
1028 lines (1026 loc) · 45.7 KB
/
enrollments.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"apiVersion": "1.0",
"swaggerVersion": "1.2",
"basePath": "https://canvas.instructure.com/api",
"resourcePath": "/enrollments",
"produces": [
"application/json"
],
"apis": [
{
"path": "/v1/courses/{course_id}/enrollments",
"description": "Depending on the URL given, return a paginated list of either (1) all of\nthe enrollments in a course, (2) all of the enrollments in a section or (3)\nall of a user's enrollments. This includes student, teacher, TA, and\nobserver enrollments.\n\nIf a user has multiple enrollments in a context (e.g. as a teacher\nand a student or in multiple course sections), each enrollment will be\nlisted separately.\n\nnote: Currently, only a root level admin user can return other users' enrollments. A\nuser can, however, return his/her own enrollments.",
"operations": [
{
"method": "GET",
"summary": "List enrollments",
"notes": "Depending on the URL given, return a paginated list of either (1) all of\nthe enrollments in a course, (2) all of the enrollments in a section or (3)\nall of a user's enrollments. This includes student, teacher, TA, and\nobserver enrollments.\n\nIf a user has multiple enrollments in a context (e.g. as a teacher\nand a student or in multiple course sections), each enrollment will be\nlisted separately.\n\nnote: Currently, only a root level admin user can return other users' enrollments. A\nuser can, however, return his/her own enrollments.",
"nickname": "list_enrollments_courses",
"parameters": [
{
"paramType": "path",
"name": "course_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "query",
"name": "type",
"description": "A list of enrollment types to return. Accepted values are\n'StudentEnrollment', 'TeacherEnrollment', 'TaEnrollment',\n'DesignerEnrollment', and 'ObserverEnrollment.' If omitted, all enrollment\ntypes are returned. This argument is ignored if `role` is given.",
"type": "array",
"format": null,
"required": false,
"items": {
"type": "string"
}
},
{
"paramType": "query",
"name": "role",
"description": "A list of enrollment roles to return. Accepted values include course-level\nroles created by the {api:RoleOverridesController#add_role Add Role API}\nas well as the base enrollment types accepted by the `type` argument above.",
"type": "array",
"format": null,
"required": false,
"items": {
"type": "string"
}
},
{
"paramType": "query",
"name": "state",
"description": "Filter by enrollment state. If omitted, 'active' and 'invited' enrollments\nare returned. When querying a user's enrollments (either via user_id\nargument or via user enrollments endpoint), the following additional\nsynthetic states are supported: \"current_and_invited\"|\"current_and_future\"|\"current_and_concluded\"",
"type": "array",
"format": null,
"required": false,
"enum": [
"active",
"invited",
"creation_pending",
"deleted",
"rejected",
"completed",
"inactive"
],
"items": {
"type": "string"
}
},
{
"paramType": "query",
"name": "include",
"description": "Array of additional information to include on the enrollment or user records.\n\"avatar_url\" and \"group_ids\" will be returned on the user record.",
"type": "array",
"format": null,
"required": false,
"enum": [
"avatar_url",
"group_ids",
"locked",
"observed_users",
"can_be_removed"
],
"items": {
"type": "string"
}
},
{
"paramType": "query",
"name": "user_id",
"description": "Filter by user_id (only valid for course or section enrollment\nqueries). If set to the current user's id, this is a way to\ndetermine if the user has any enrollments in the course or section,\nindependent of whether the user has permission to view other people\non the roster.",
"type": "string",
"format": null,
"required": false
},
{
"paramType": "query",
"name": "grading_period_id",
"description": "Return grades for the given grading_period. If this parameter is not\nspecified, the returned grades will be for the whole course.",
"type": "integer",
"format": "int64",
"required": false
},
{
"paramType": "query",
"name": "sis_account_id",
"description": "Returns only enrollments for the specified SIS account ID(s). Does not\nlook into subaccounts. May pass in array or string.",
"type": "array",
"format": null,
"required": false,
"items": {
"type": "string"
}
},
{
"paramType": "query",
"name": "sis_course_id",
"description": "Returns only enrollments matching the specified SIS course ID(s).\nMay pass in array or string.",
"type": "array",
"format": null,
"required": false,
"items": {
"type": "string"
}
},
{
"paramType": "query",
"name": "sis_section_id",
"description": "Returns only section enrollments matching the specified SIS section ID(s).\nMay pass in array or string.",
"type": "array",
"format": null,
"required": false,
"items": {
"type": "string"
}
},
{
"paramType": "query",
"name": "sis_user_id",
"description": "Returns only enrollments for the specified SIS user ID(s). May pass in\narray or string.",
"type": "array",
"format": null,
"required": false,
"items": {
"type": "string"
}
}
],
"type": "array",
"items": {
"$ref": "Enrollment"
}
}
]
},
{
"path": "/v1/sections/{section_id}/enrollments",
"description": "Depending on the URL given, return a paginated list of either (1) all of\nthe enrollments in a course, (2) all of the enrollments in a section or (3)\nall of a user's enrollments. This includes student, teacher, TA, and\nobserver enrollments.\n\nIf a user has multiple enrollments in a context (e.g. as a teacher\nand a student or in multiple course sections), each enrollment will be\nlisted separately.\n\nnote: Currently, only a root level admin user can return other users' enrollments. A\nuser can, however, return his/her own enrollments.",
"operations": [
{
"method": "GET",
"summary": "List enrollments",
"notes": "Depending on the URL given, return a paginated list of either (1) all of\nthe enrollments in a course, (2) all of the enrollments in a section or (3)\nall of a user's enrollments. This includes student, teacher, TA, and\nobserver enrollments.\n\nIf a user has multiple enrollments in a context (e.g. as a teacher\nand a student or in multiple course sections), each enrollment will be\nlisted separately.\n\nnote: Currently, only a root level admin user can return other users' enrollments. A\nuser can, however, return his/her own enrollments.",
"nickname": "list_enrollments_sections",
"parameters": [
{
"paramType": "path",
"name": "section_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "query",
"name": "type",
"description": "A list of enrollment types to return. Accepted values are\n'StudentEnrollment', 'TeacherEnrollment', 'TaEnrollment',\n'DesignerEnrollment', and 'ObserverEnrollment.' If omitted, all enrollment\ntypes are returned. This argument is ignored if `role` is given.",
"type": "array",
"format": null,
"required": false,
"items": {
"type": "string"
}
},
{
"paramType": "query",
"name": "role",
"description": "A list of enrollment roles to return. Accepted values include course-level\nroles created by the {api:RoleOverridesController#add_role Add Role API}\nas well as the base enrollment types accepted by the `type` argument above.",
"type": "array",
"format": null,
"required": false,
"items": {
"type": "string"
}
},
{
"paramType": "query",
"name": "state",
"description": "Filter by enrollment state. If omitted, 'active' and 'invited' enrollments\nare returned. When querying a user's enrollments (either via user_id\nargument or via user enrollments endpoint), the following additional\nsynthetic states are supported: \"current_and_invited\"|\"current_and_future\"|\"current_and_concluded\"",
"type": "array",
"format": null,
"required": false,
"enum": [
"active",
"invited",
"creation_pending",
"deleted",
"rejected",
"completed",
"inactive"
],
"items": {
"type": "string"
}
},
{
"paramType": "query",
"name": "include",
"description": "Array of additional information to include on the enrollment or user records.\n\"avatar_url\" and \"group_ids\" will be returned on the user record.",
"type": "array",
"format": null,
"required": false,
"enum": [
"avatar_url",
"group_ids",
"locked",
"observed_users",
"can_be_removed"
],
"items": {
"type": "string"
}
},
{
"paramType": "query",
"name": "user_id",
"description": "Filter by user_id (only valid for course or section enrollment\nqueries). If set to the current user's id, this is a way to\ndetermine if the user has any enrollments in the course or section,\nindependent of whether the user has permission to view other people\non the roster.",
"type": "string",
"format": null,
"required": false
},
{
"paramType": "query",
"name": "grading_period_id",
"description": "Return grades for the given grading_period. If this parameter is not\nspecified, the returned grades will be for the whole course.",
"type": "integer",
"format": "int64",
"required": false
},
{
"paramType": "query",
"name": "sis_account_id",
"description": "Returns only enrollments for the specified SIS account ID(s). Does not\nlook into subaccounts. May pass in array or string.",
"type": "array",
"format": null,
"required": false,
"items": {
"type": "string"
}
},
{
"paramType": "query",
"name": "sis_course_id",
"description": "Returns only enrollments matching the specified SIS course ID(s).\nMay pass in array or string.",
"type": "array",
"format": null,
"required": false,
"items": {
"type": "string"
}
},
{
"paramType": "query",
"name": "sis_section_id",
"description": "Returns only section enrollments matching the specified SIS section ID(s).\nMay pass in array or string.",
"type": "array",
"format": null,
"required": false,
"items": {
"type": "string"
}
},
{
"paramType": "query",
"name": "sis_user_id",
"description": "Returns only enrollments for the specified SIS user ID(s). May pass in\narray or string.",
"type": "array",
"format": null,
"required": false,
"items": {
"type": "string"
}
}
],
"type": "array",
"items": {
"$ref": "Enrollment"
}
}
]
},
{
"path": "/v1/users/{user_id}/enrollments",
"description": "Depending on the URL given, return a paginated list of either (1) all of\nthe enrollments in a course, (2) all of the enrollments in a section or (3)\nall of a user's enrollments. This includes student, teacher, TA, and\nobserver enrollments.\n\nIf a user has multiple enrollments in a context (e.g. as a teacher\nand a student or in multiple course sections), each enrollment will be\nlisted separately.\n\nnote: Currently, only a root level admin user can return other users' enrollments. A\nuser can, however, return his/her own enrollments.",
"operations": [
{
"method": "GET",
"summary": "List enrollments",
"notes": "Depending on the URL given, return a paginated list of either (1) all of\nthe enrollments in a course, (2) all of the enrollments in a section or (3)\nall of a user's enrollments. This includes student, teacher, TA, and\nobserver enrollments.\n\nIf a user has multiple enrollments in a context (e.g. as a teacher\nand a student or in multiple course sections), each enrollment will be\nlisted separately.\n\nnote: Currently, only a root level admin user can return other users' enrollments. A\nuser can, however, return his/her own enrollments.",
"nickname": "list_enrollments_users",
"parameters": [
{
"paramType": "query",
"name": "type",
"description": "A list of enrollment types to return. Accepted values are\n'StudentEnrollment', 'TeacherEnrollment', 'TaEnrollment',\n'DesignerEnrollment', and 'ObserverEnrollment.' If omitted, all enrollment\ntypes are returned. This argument is ignored if `role` is given.",
"type": "array",
"format": null,
"required": false,
"items": {
"type": "string"
}
},
{
"paramType": "query",
"name": "role",
"description": "A list of enrollment roles to return. Accepted values include course-level\nroles created by the {api:RoleOverridesController#add_role Add Role API}\nas well as the base enrollment types accepted by the `type` argument above.",
"type": "array",
"format": null,
"required": false,
"items": {
"type": "string"
}
},
{
"paramType": "query",
"name": "state",
"description": "Filter by enrollment state. If omitted, 'active' and 'invited' enrollments\nare returned. When querying a user's enrollments (either via user_id\nargument or via user enrollments endpoint), the following additional\nsynthetic states are supported: \"current_and_invited\"|\"current_and_future\"|\"current_and_concluded\"",
"type": "array",
"format": null,
"required": false,
"enum": [
"active",
"invited",
"creation_pending",
"deleted",
"rejected",
"completed",
"inactive"
],
"items": {
"type": "string"
}
},
{
"paramType": "query",
"name": "include",
"description": "Array of additional information to include on the enrollment or user records.\n\"avatar_url\" and \"group_ids\" will be returned on the user record.",
"type": "array",
"format": null,
"required": false,
"enum": [
"avatar_url",
"group_ids",
"locked",
"observed_users",
"can_be_removed"
],
"items": {
"type": "string"
}
},
{
"paramType": "path",
"name": "user_id",
"description": "Filter by user_id (only valid for course or section enrollment\nqueries). If set to the current user's id, this is a way to\ndetermine if the user has any enrollments in the course or section,\nindependent of whether the user has permission to view other people\non the roster.",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "query",
"name": "grading_period_id",
"description": "Return grades for the given grading_period. If this parameter is not\nspecified, the returned grades will be for the whole course.",
"type": "integer",
"format": "int64",
"required": false
},
{
"paramType": "query",
"name": "sis_account_id",
"description": "Returns only enrollments for the specified SIS account ID(s). Does not\nlook into subaccounts. May pass in array or string.",
"type": "array",
"format": null,
"required": false,
"items": {
"type": "string"
}
},
{
"paramType": "query",
"name": "sis_course_id",
"description": "Returns only enrollments matching the specified SIS course ID(s).\nMay pass in array or string.",
"type": "array",
"format": null,
"required": false,
"items": {
"type": "string"
}
},
{
"paramType": "query",
"name": "sis_section_id",
"description": "Returns only section enrollments matching the specified SIS section ID(s).\nMay pass in array or string.",
"type": "array",
"format": null,
"required": false,
"items": {
"type": "string"
}
},
{
"paramType": "query",
"name": "sis_user_id",
"description": "Returns only enrollments for the specified SIS user ID(s). May pass in\narray or string.",
"type": "array",
"format": null,
"required": false,
"items": {
"type": "string"
}
}
],
"type": "array",
"items": {
"$ref": "Enrollment"
}
}
]
},
{
"path": "/v1/accounts/{account_id}/enrollments/{id}",
"description": "Get an Enrollment object by Enrollment ID",
"operations": [
{
"method": "GET",
"summary": "Enrollment by ID",
"notes": "Get an Enrollment object by Enrollment ID",
"nickname": "enrollment_by_id",
"parameters": [
{
"paramType": "path",
"name": "account_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "path",
"name": "id",
"description": "The ID of the enrollment object",
"type": "integer",
"format": "int64",
"required": true
}
],
"type": "Enrollment"
}
]
},
{
"path": "/v1/courses/{course_id}/enrollments",
"description": "Create a new user enrollment for a course or section.",
"operations": [
{
"method": "POST",
"summary": "Enroll a user",
"notes": "Create a new user enrollment for a course or section.",
"nickname": "enroll_user_courses",
"parameters": [
{
"paramType": "path",
"name": "course_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "form",
"name": "enrollment[user_id]",
"description": "The ID of the user to be enrolled in the course.",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "form",
"name": "enrollment[type]",
"description": "Enroll the user as a student, teacher, TA, observer, or designer. If no\nvalue is given, the type will be inferred by enrollment[role] if supplied,\notherwise 'StudentEnrollment' will be used.",
"type": "string",
"format": null,
"required": true,
"enum": [
"StudentEnrollment",
"TeacherEnrollment",
"TaEnrollment",
"ObserverEnrollment",
"DesignerEnrollment"
]
},
{
"paramType": "form",
"name": "enrollment[role]",
"description": "Assigns a custom course-level role to the user.",
"type": "Deprecated",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "enrollment[role_id]",
"description": "Assigns a custom course-level role to the user.",
"type": "integer",
"format": "int64",
"required": false
},
{
"paramType": "form",
"name": "enrollment[enrollment_state]",
"description": "If set to 'active,' student will be immediately enrolled in the course.\nOtherwise they will be required to accept a course invitation. Default is\n'invited.'.\n\nIf set to 'inactive', student will be listed in the course roster for\nteachers, but will not be able to participate in the course until\ntheir enrollment is activated.",
"type": "string",
"format": null,
"required": false,
"enum": [
"active",
"invited",
"inactive"
]
},
{
"paramType": "form",
"name": "enrollment[course_section_id]",
"description": "The ID of the course section to enroll the student in. If the\nsection-specific URL is used, this argument is redundant and will be\nignored.",
"type": "integer",
"format": "int64",
"required": false
},
{
"paramType": "form",
"name": "enrollment[limit_privileges_to_course_section]",
"description": "If set, the enrollment will only allow the user to see and interact with\nusers enrolled in the section given by course_section_id.\n* For teachers and TAs, this includes grading privileges.\n* Section-limited students will not see any users (including teachers\n and TAs) not enrolled in their sections.\n* Users may have other enrollments that grant privileges to\n multiple sections in the same course.",
"type": "boolean",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "enrollment[notify]",
"description": "If true, a notification will be sent to the enrolled user.\nNotifications are not sent by default.",
"type": "boolean",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "enrollment[self_enrollment_code]",
"description": "If the current user is not allowed to manage enrollments in this\ncourse, but the course allows self-enrollment, the user can self-\nenroll as a student in the default section by passing in a valid\ncode. When self-enrolling, the user_id must be 'self'. The\nenrollment_state will be set to 'active' and all other arguments\nwill be ignored.",
"type": "string",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "enrollment[self_enrolled]",
"description": "If true, marks the enrollment as a self-enrollment, which gives\nstudents the ability to drop the course if desired. Defaults to false.",
"type": "boolean",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "enrollment[associated_user_id]",
"description": "For an observer enrollment, the ID of a student to observe. The\ncaller must have +manage_students+ permission in the course.\nThis is a one-off operation; to automatically observe all a\nstudent's enrollments (for example, as a parent), please use\nthe {api:UserObserveesController#create User Observees API}.",
"type": "integer",
"format": "int64",
"required": false
}
],
"type": "Enrollment"
}
]
},
{
"path": "/v1/sections/{section_id}/enrollments",
"description": "Create a new user enrollment for a course or section.",
"operations": [
{
"method": "POST",
"summary": "Enroll a user",
"notes": "Create a new user enrollment for a course or section.",
"nickname": "enroll_user_sections",
"parameters": [
{
"paramType": "path",
"name": "section_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "form",
"name": "enrollment[user_id]",
"description": "The ID of the user to be enrolled in the course.",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "form",
"name": "enrollment[type]",
"description": "Enroll the user as a student, teacher, TA, observer, or designer. If no\nvalue is given, the type will be inferred by enrollment[role] if supplied,\notherwise 'StudentEnrollment' will be used.",
"type": "string",
"format": null,
"required": true,
"enum": [
"StudentEnrollment",
"TeacherEnrollment",
"TaEnrollment",
"ObserverEnrollment",
"DesignerEnrollment"
]
},
{
"paramType": "form",
"name": "enrollment[role]",
"description": "Assigns a custom course-level role to the user.",
"type": "Deprecated",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "enrollment[role_id]",
"description": "Assigns a custom course-level role to the user.",
"type": "integer",
"format": "int64",
"required": false
},
{
"paramType": "form",
"name": "enrollment[enrollment_state]",
"description": "If set to 'active,' student will be immediately enrolled in the course.\nOtherwise they will be required to accept a course invitation. Default is\n'invited.'.\n\nIf set to 'inactive', student will be listed in the course roster for\nteachers, but will not be able to participate in the course until\ntheir enrollment is activated.",
"type": "string",
"format": null,
"required": false,
"enum": [
"active",
"invited",
"inactive"
]
},
{
"paramType": "form",
"name": "enrollment[course_section_id]",
"description": "The ID of the course section to enroll the student in. If the\nsection-specific URL is used, this argument is redundant and will be\nignored.",
"type": "integer",
"format": "int64",
"required": false
},
{
"paramType": "form",
"name": "enrollment[limit_privileges_to_course_section]",
"description": "If set, the enrollment will only allow the user to see and interact with\nusers enrolled in the section given by course_section_id.\n* For teachers and TAs, this includes grading privileges.\n* Section-limited students will not see any users (including teachers\n and TAs) not enrolled in their sections.\n* Users may have other enrollments that grant privileges to\n multiple sections in the same course.",
"type": "boolean",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "enrollment[notify]",
"description": "If true, a notification will be sent to the enrolled user.\nNotifications are not sent by default.",
"type": "boolean",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "enrollment[self_enrollment_code]",
"description": "If the current user is not allowed to manage enrollments in this\ncourse, but the course allows self-enrollment, the user can self-\nenroll as a student in the default section by passing in a valid\ncode. When self-enrolling, the user_id must be 'self'. The\nenrollment_state will be set to 'active' and all other arguments\nwill be ignored.",
"type": "string",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "enrollment[self_enrolled]",
"description": "If true, marks the enrollment as a self-enrollment, which gives\nstudents the ability to drop the course if desired. Defaults to false.",
"type": "boolean",
"format": null,
"required": false
},
{
"paramType": "form",
"name": "enrollment[associated_user_id]",
"description": "For an observer enrollment, the ID of a student to observe. The\ncaller must have +manage_students+ permission in the course.\nThis is a one-off operation; to automatically observe all a\nstudent's enrollments (for example, as a parent), please use\nthe {api:UserObserveesController#create User Observees API}.",
"type": "integer",
"format": "int64",
"required": false
}
],
"type": "Enrollment"
}
]
},
{
"path": "/v1/courses/{course_id}/enrollments/{id}",
"description": "Conclude, deactivate, or delete an enrollment. If the +task+ argument isn't given, the enrollment\nwill be concluded.",
"operations": [
{
"method": "DELETE",
"summary": "Conclude, deactivate, or delete an enrollment",
"notes": "Conclude, deactivate, or delete an enrollment. If the +task+ argument isn't given, the enrollment\nwill be concluded.",
"nickname": "conclude_deactivate_or_delete_enrollment",
"parameters": [
{
"paramType": "path",
"name": "course_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "path",
"name": "id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "query",
"name": "task",
"description": "The action to take on the enrollment.\nWhen inactive, a user will still appear in the course roster to admins, but be unable to participate.\n(\"inactivate\" and \"deactivate\" are equivalent tasks)",
"type": "string",
"format": null,
"required": false,
"enum": [
"conclude",
"delete",
"inactivate",
"deactivate"
]
}
],
"type": "Enrollment"
}
]
},
{
"path": "/v1/courses/{course_id}/enrollments/{id}/reactivate",
"description": "Activates an inactive enrollment",
"operations": [
{
"method": "PUT",
"summary": "Re-activate an enrollment",
"notes": "Activates an inactive enrollment",
"nickname": "re_activate_enrollment",
"parameters": [
{
"paramType": "path",
"name": "course_id",
"description": "ID",
"type": "string",
"format": null,
"required": true
},
{
"paramType": "path",
"name": "id",
"description": "ID",
"type": "string",
"format": null,
"required": true
}
],
"type": "Enrollment"
}
]
}
],
"models": {
"Grade": {
"id": "Grade",
"description": "",
"required": [
],
"properties": {
"html_url": {
"description": "The URL to the Canvas web UI page for the user's grades, if this is a student enrollment.",
"example": "",
"type": "string"
},
"current_grade": {
"description": "The user's current grade in the class. Only included if user has permissions to view this grade.",
"example": "",
"type": "string"
},
"final_grade": {
"description": "The user's final grade for the class. Only included if user has permissions to view this grade.",
"example": "",
"type": "string"
},
"current_score": {
"description": "The user's current score in the class. Only included if user has permissions to view this score.",
"example": "",
"type": "string"
},
"final_score": {
"description": "The user's final score for the class. Only included if user has permissions to view this score.",
"example": "",
"type": "string"
}
}
},
"Enrollment": {
"id": "Enrollment",
"description": "",
"required": [
],
"properties": {
"id": {
"description": "The ID of the enrollment.",
"example": 1,
"type": "integer"
},
"course_id": {
"description": "The unique id of the course.",
"example": 1,
"type": "integer"
},
"sis_course_id": {
"description": "The SIS Course ID in which the enrollment is associated. Only displayed if present. This field is only included if the user has permission to view SIS information.",
"example": "SHEL93921",
"type": "string"
},
"course_integration_id": {
"description": "The Course Integration ID in which the enrollment is associated. This field is only included if the user has permission to view SIS information.",
"example": "SHEL93921",
"type": "string"
},
"course_section_id": {
"description": "The unique id of the user's section.",
"example": 1,
"type": "integer"
},
"section_integration_id": {
"description": "The Section Integration ID in which the enrollment is associated. This field is only included if the user has permission to view SIS information.",
"example": "SHEL93921",
"type": "string"
},
"sis_account_id": {
"description": "The SIS Account ID in which the enrollment is associated. Only displayed if present. This field is only included if the user has permission to view SIS information.",
"example": "SHEL93921",
"type": "string"
},
"sis_section_id": {
"description": "The SIS Section ID in which the enrollment is associated. Only displayed if present. This field is only included if the user has permission to view SIS information.",
"example": "SHEL93921",
"type": "string"
},
"sis_user_id": {
"description": "The SIS User ID in which the enrollment is associated. Only displayed if present. This field is only included if the user has permission to view SIS information.",
"example": "SHEL93921",
"type": "string"
},
"enrollment_state": {
"description": "The state of the user's enrollment in the course.",
"example": "active",
"type": "string"
},
"limit_privileges_to_course_section": {
"description": "User can only access his or her own course section.",
"example": true,
"type": "boolean"
},
"sis_import_id": {
"description": "The unique identifier for the SIS import. This field is only included if the user has permission to manage SIS information.",
"example": 83,
"type": "integer"
},
"root_account_id": {
"description": "The unique id of the user's account.",
"example": 1,
"type": "integer"
},
"type": {
"description": "The enrollment type. One of 'StudentEnrollment', 'TeacherEnrollment', 'TaEnrollment', 'DesignerEnrollment', 'ObserverEnrollment'.",
"example": "StudentEnrollment",
"type": "string"
},
"user_id": {
"description": "The unique id of the user.",
"example": 1,
"type": "integer"
},
"associated_user_id": {
"description": "The unique id of the associated user. Will be null unless type is ObserverEnrollment.",
"example": null,
"type": "integer"
},
"role": {
"description": "The enrollment role, for course-level permissions. This field will match `type` if the enrollment role has not been customized.",
"example": "StudentEnrollment",
"type": "string"
},
"role_id": {
"description": "The id of the enrollment role.",
"example": 1,
"type": "integer"
},
"created_at": {
"description": "The created time of the enrollment, in ISO8601 format.",
"example": "2012-04-18T23:08:51Z",
"type": "datetime"
},
"updated_at": {
"description": "The updated time of the enrollment, in ISO8601 format.",
"example": "2012-04-18T23:08:51Z",
"type": "datetime"
},
"start_at": {
"description": "The start time of the enrollment, in ISO8601 format.",
"example": "2012-04-18T23:08:51Z",
"type": "datetime"
},
"end_at": {
"description": "The end time of the enrollment, in ISO8601 format.",
"example": "2012-04-18T23:08:51Z",
"type": "datetime"
},
"last_activity_at": {
"description": "The last activity time of the user for the enrollment, in ISO8601 format.",
"example": "2012-04-18T23:08:51Z",
"type": "datetime"
},
"total_activity_time": {
"description": "The total activity time of the user for the enrollment, in seconds.",
"example": 260,
"type": "integer"
},
"html_url": {
"description": "The URL to the Canvas web UI page for this course enrollment.",
"example": "https://...",
"type": "string"
},
"grades": {
"description": "The URL to the Canvas web UI page containing the grades associated with this enrollment.",
"$ref": "Grade"
},
"computed_current_score": {
"description": "optional: The student's score in the course, ignoring ungraded assignments. (applies only to student enrollments, and only available in course endpoints)",
"example": 90.25,
"type": "number"
},
"computed_final_score": {
"description": "optional: The student's score in the course including ungraded assignments with a score of 0. (applies only to student enrollments, and only available in course endpoints)",
"example": 80.67,
"type": "number"
},
"computed_current_grade": {
"description": "optional: The letter grade equivalent of computed_current_score, if available. (applies only to student enrollments, and only available in course endpoints)",
"example": "A-",
"type": "string"
},
"computed_final_grade": {
"description": "optional: The letter grade equivalent of computed_final_score, if available. (applies only to student enrollments, and only available in course endpoints)",
"example": "B-",
"type": "string"
},
"has_grading_periods": {
"description": "optional: Indicates whether the course the enrollment belongs to has grading periods set up. (applies only to student enrollments, and only available in course endpoints)",
"example": true,
"type": "boolean"
},
"totals_for_all_grading_periods_option": {
"description": "optional: Indicates whether the course the enrollment belongs to has the Display Totals for 'All Grading Periods' feature enabled. (applies only to student enrollments, and only available in course endpoints)",
"example": true,
"type": "boolean"
},
"current_grading_period_title": {
"description": "optional: The name of the currently active grading period, if one exists. If the course the enrollment belongs to does not have grading periods, or if no currently active grading period exists, the value will be null. (applies only to student enrollments, and only available in course endpoints)",
"example": "Fall Grading Period",
"type": "string"
},
"current_grading_period_id": {