/
classroom-api.json
4113 lines (4113 loc) · 204 KB
/
classroom-api.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
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/classroom.announcements": {
"description": "View and manage announcements in Google Classroom"
},
"https://www.googleapis.com/auth/classroom.announcements.readonly": {
"description": "View announcements in Google Classroom"
},
"https://www.googleapis.com/auth/classroom.courses": {
"description": "See, edit, create, and permanently delete your Google Classroom classes"
},
"https://www.googleapis.com/auth/classroom.courses.readonly": {
"description": "View your Google Classroom classes"
},
"https://www.googleapis.com/auth/classroom.coursework.me": {
"description": "See, create and edit coursework items including assignments, questions, and grades"
},
"https://www.googleapis.com/auth/classroom.coursework.me.readonly": {
"description": "View your course work and grades in Google Classroom"
},
"https://www.googleapis.com/auth/classroom.coursework.students": {
"description": "Manage course work and grades for students in the Google Classroom classes you teach and view the course work and grades for classes you administer"
},
"https://www.googleapis.com/auth/classroom.coursework.students.readonly": {
"description": "View course work and grades for students in the Google Classroom classes you teach or administer"
},
"https://www.googleapis.com/auth/classroom.courseworkmaterials": {
"description": "See, edit, and create classwork materials in Google Classroom"
},
"https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly": {
"description": "See all classwork materials for your Google Classroom classes"
},
"https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly": {
"description": "View your Google Classroom guardians"
},
"https://www.googleapis.com/auth/classroom.guardianlinks.students": {
"description": "View and manage guardians for students in your Google Classroom classes"
},
"https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly": {
"description": "View guardians for students in your Google Classroom classes"
},
"https://www.googleapis.com/auth/classroom.profile.emails": {
"description": "View the email addresses of people in your classes"
},
"https://www.googleapis.com/auth/classroom.profile.photos": {
"description": "View the profile photos of people in your classes"
},
"https://www.googleapis.com/auth/classroom.push-notifications": {
"description": "Receive notifications about your Google Classroom data"
},
"https://www.googleapis.com/auth/classroom.rosters": {
"description": "Manage your Google Classroom class rosters"
},
"https://www.googleapis.com/auth/classroom.rosters.readonly": {
"description": "View your Google Classroom class rosters"
},
"https://www.googleapis.com/auth/classroom.student-submissions.me.readonly": {
"description": "View your course work and grades in Google Classroom"
},
"https://www.googleapis.com/auth/classroom.student-submissions.students.readonly": {
"description": "View course work and grades for students in the Google Classroom classes you teach or administer"
},
"https://www.googleapis.com/auth/classroom.topics": {
"description": "See, create, and edit topics in Google Classroom"
},
"https://www.googleapis.com/auth/classroom.topics.readonly": {
"description": "View topics in Google Classroom"
}
}
}
},
"basePath": "",
"baseUrl": "https://classroom.googleapis.com/",
"batchPath": "batch",
"description": "Manages classes, rosters, and invitations in Google Classroom.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/classroom/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "classroom:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://classroom.mtls.googleapis.com/",
"name": "classroom",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"courses": {
"methods": {
"create": {
"description": "Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. A non-admin requesting user can only create a course with themselves as the owner. Domain admins can create courses owned by any user within their domain. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.",
"flatPath": "v1/courses",
"httpMethod": "POST",
"id": "classroom.courses.create",
"parameterOrder": [],
"parameters": {},
"path": "v1/courses",
"request": {
"$ref": "Course"
},
"response": {
"$ref": "Course"
},
"scopes": [
"https://www.googleapis.com/auth/classroom.courses"
]
},
"delete": {
"description": "Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.",
"flatPath": "v1/courses/{id}",
"httpMethod": "DELETE",
"id": "classroom.courses.delete",
"parameterOrder": [
"id"
],
"parameters": {
"id": {
"description": "Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/courses/{id}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/classroom.courses"
]
},
"get": {
"description": "Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.",
"flatPath": "v1/courses/{id}",
"httpMethod": "GET",
"id": "classroom.courses.get",
"parameterOrder": [
"id"
],
"parameters": {
"id": {
"description": "Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/courses/{id}",
"response": {
"$ref": "Course"
},
"scopes": [
"https://www.googleapis.com/auth/classroom.courses",
"https://www.googleapis.com/auth/classroom.courses.readonly"
]
},
"list": {
"description": "Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.",
"flatPath": "v1/courses",
"httpMethod": "GET",
"id": "classroom.courses.list",
"parameterOrder": [],
"parameters": {
"courseStates": {
"description": "Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.",
"enum": [
"COURSE_STATE_UNSPECIFIED",
"ACTIVE",
"ARCHIVED",
"PROVISIONED",
"DECLINED",
"SUSPENDED"
],
"enumDescriptions": [
"No course state. No returned Course message will use this value.",
"The course is active.",
"The course has been archived. You cannot modify it except to change it to a different state.",
"The course has been created, but not yet activated. It is accessible by the primary teacher and domain administrators, who may modify it or change it to the `ACTIVE` or `DECLINED` states. A course may only be changed to `PROVISIONED` if it is in the `DECLINED` state.",
"The course has been created, but declined. It is accessible by the course owner and domain administrators, though it will not be displayed in the web UI. You cannot modify the course except to change it to the `PROVISIONED` state. A course may only be changed to `DECLINED` if it is in the `PROVISIONED` state.",
"The course has been suspended. You cannot modify the course, and only the user identified by the `owner_id` can view the course. A course may be placed in this state if it potentially violates the Terms of Service."
],
"location": "query",
"repeated": true,
"type": "string"
},
"pageSize": {
"description": "Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
"location": "query",
"type": "string"
},
"studentId": {
"description": "Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
"location": "query",
"type": "string"
},
"teacherId": {
"description": "Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
"location": "query",
"type": "string"
}
},
"path": "v1/courses",
"response": {
"$ref": "ListCoursesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/classroom.courses",
"https://www.googleapis.com/auth/classroom.courses.readonly"
]
},
"patch": {
"description": "Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable",
"flatPath": "v1/courses/{id}",
"httpMethod": "PATCH",
"id": "classroom.courses.patch",
"parameterOrder": [
"id"
],
"parameters": {
"id": {
"description": "Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.",
"location": "path",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` * `ownerId` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=,,...`",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/courses/{id}",
"request": {
"$ref": "Course"
},
"response": {
"$ref": "Course"
},
"scopes": [
"https://www.googleapis.com/auth/classroom.courses"
]
},
"update": {
"description": "Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable",
"flatPath": "v1/courses/{id}",
"httpMethod": "PUT",
"id": "classroom.courses.update",
"parameterOrder": [
"id"
],
"parameters": {
"id": {
"description": "Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/courses/{id}",
"request": {
"$ref": "Course"
},
"response": {
"$ref": "Course"
},
"scopes": [
"https://www.googleapis.com/auth/classroom.courses"
]
}
},
"resources": {
"aliases": {
"methods": {
"create": {
"description": "Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias).",
"flatPath": "v1/courses/{courseId}/aliases",
"httpMethod": "POST",
"id": "classroom.courses.aliases.create",
"parameterOrder": [
"courseId"
],
"parameters": {
"courseId": {
"description": "Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/courses/{courseId}/aliases",
"request": {
"$ref": "CourseAlias"
},
"response": {
"$ref": "CourseAlias"
},
"scopes": [
"https://www.googleapis.com/auth/classroom.courses"
]
},
"delete": {
"description": "Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to delete a domain-scoped alias).",
"flatPath": "v1/courses/{courseId}/aliases/{alias}",
"httpMethod": "DELETE",
"id": "classroom.courses.aliases.delete",
"parameterOrder": [
"courseId",
"alias"
],
"parameters": {
"alias": {
"description": "Alias to delete. This may not be the Classroom-assigned identifier.",
"location": "path",
"required": true,
"type": "string"
},
"courseId": {
"description": "Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/courses/{courseId}/aliases/{alias}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/classroom.courses"
]
},
"list": {
"description": "Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.",
"flatPath": "v1/courses/{courseId}/aliases",
"httpMethod": "GET",
"id": "classroom.courses.aliases.list",
"parameterOrder": [
"courseId"
],
"parameters": {
"courseId": {
"description": "The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
"location": "path",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
"location": "query",
"type": "string"
}
},
"path": "v1/courses/{courseId}/aliases",
"response": {
"$ref": "ListCourseAliasesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/classroom.courses",
"https://www.googleapis.com/auth/classroom.courses.readonly"
]
}
}
},
"announcements": {
"methods": {
"create": {
"description": "Creates an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create announcements in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible",
"flatPath": "v1/courses/{courseId}/announcements",
"httpMethod": "POST",
"id": "classroom.courses.announcements.create",
"parameterOrder": [
"courseId"
],
"parameters": {
"courseId": {
"description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/courses/{courseId}/announcements",
"request": {
"$ref": "Announcement"
},
"response": {
"$ref": "Announcement"
},
"scopes": [
"https://www.googleapis.com/auth/classroom.announcements"
]
},
"delete": {
"description": "Deletes an announcement. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding announcement item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.",
"flatPath": "v1/courses/{courseId}/announcements/{id}",
"httpMethod": "DELETE",
"id": "classroom.courses.announcements.delete",
"parameterOrder": [
"courseId",
"id"
],
"parameters": {
"courseId": {
"description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
"location": "path",
"required": true,
"type": "string"
},
"id": {
"description": "Identifier of the announcement to delete. This identifier is a Classroom-assigned identifier.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/courses/{courseId}/announcements/{id}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/classroom.announcements"
]
},
"get": {
"description": "Returns an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or announcement, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or announcement does not exist.",
"flatPath": "v1/courses/{courseId}/announcements/{id}",
"httpMethod": "GET",
"id": "classroom.courses.announcements.get",
"parameterOrder": [
"courseId",
"id"
],
"parameters": {
"courseId": {
"description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
"location": "path",
"required": true,
"type": "string"
},
"id": {
"description": "Identifier of the announcement.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/courses/{courseId}/announcements/{id}",
"response": {
"$ref": "Announcement"
},
"scopes": [
"https://www.googleapis.com/auth/classroom.announcements",
"https://www.googleapis.com/auth/classroom.announcements.readonly"
]
},
"list": {
"description": "Returns a list of announcements that the requester is permitted to view. Course students may only view `PUBLISHED` announcements. Course teachers and domain administrators may view all announcements. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.",
"flatPath": "v1/courses/{courseId}/announcements",
"httpMethod": "GET",
"id": "classroom.courses.announcements.list",
"parameterOrder": [
"courseId"
],
"parameters": {
"announcementStates": {
"description": "Restriction on the `state` of announcements returned. If this argument is left unspecified, the default value is `PUBLISHED`.",
"enum": [
"ANNOUNCEMENT_STATE_UNSPECIFIED",
"PUBLISHED",
"DRAFT",
"DELETED"
],
"enumDescriptions": [
"No state specified. This is never returned.",
"Status for announcement that has been published. This is the default state.",
"Status for an announcement that is not yet published. Announcement in this state is visible only to course teachers and domain administrators.",
"Status for announcement that was published but is now deleted. Announcement in this state is visible only to course teachers and domain administrators. Announcement in this state is deleted after some time."
],
"location": "query",
"repeated": true,
"type": "string"
},
"courseId": {
"description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
"location": "path",
"required": true,
"type": "string"
},
"orderBy": {
"description": "Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime`",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
"location": "query",
"type": "string"
}
},
"path": "v1/courses/{courseId}/announcements",
"response": {
"$ref": "ListAnnouncementsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/classroom.announcements",
"https://www.googleapis.com/auth/classroom.announcements.readonly"
]
},
"modifyAssignees": {
"description": "Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.",
"flatPath": "v1/courses/{courseId}/announcements/{id}:modifyAssignees",
"httpMethod": "POST",
"id": "classroom.courses.announcements.modifyAssignees",
"parameterOrder": [
"courseId",
"id"
],
"parameters": {
"courseId": {
"description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
"location": "path",
"required": true,
"type": "string"
},
"id": {
"description": "Identifier of the announcement.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/courses/{courseId}/announcements/{id}:modifyAssignees",
"request": {
"$ref": "ModifyAnnouncementAssigneesRequest"
},
"response": {
"$ref": "Announcement"
},
"scopes": [
"https://www.googleapis.com/auth/classroom.announcements"
]
},
"patch": {
"description": "Updates one or more fields of an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if the requested course or announcement does not exist",
"flatPath": "v1/courses/{courseId}/announcements/{id}",
"httpMethod": "PATCH",
"id": "classroom.courses.announcements.patch",
"parameterOrder": [
"courseId",
"id"
],
"parameters": {
"courseId": {
"description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
"location": "path",
"required": true,
"type": "string"
},
"id": {
"description": "Identifier of the announcement.",
"location": "path",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `text` * `state` * `scheduled_time`",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/courses/{courseId}/announcements/{id}",
"request": {
"$ref": "Announcement"
},
"response": {
"$ref": "Announcement"
},
"scopes": [
"https://www.googleapis.com/auth/classroom.announcements"
]
}
}
},
"courseWork": {
"methods": {
"create": {
"description": "Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible",
"flatPath": "v1/courses/{courseId}/courseWork",
"httpMethod": "POST",
"id": "classroom.courses.courseWork.create",
"parameterOrder": [
"courseId"
],
"parameters": {
"courseId": {
"description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/courses/{courseId}/courseWork",
"request": {
"$ref": "CourseWork"
},
"response": {
"$ref": "CourseWork"
},
"scopes": [
"https://www.googleapis.com/auth/classroom.coursework.students"
]
},
"delete": {
"description": "Deletes a course work. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.",
"flatPath": "v1/courses/{courseId}/courseWork/{id}",
"httpMethod": "DELETE",
"id": "classroom.courses.courseWork.delete",
"parameterOrder": [
"courseId",
"id"
],
"parameters": {
"courseId": {
"description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
"location": "path",
"required": true,
"type": "string"
},
"id": {
"description": "Identifier of the course work to delete. This identifier is a Classroom-assigned identifier.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/courses/{courseId}/courseWork/{id}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/classroom.coursework.students"
]
},
"get": {
"description": "Returns course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.",
"flatPath": "v1/courses/{courseId}/courseWork/{id}",
"httpMethod": "GET",
"id": "classroom.courses.courseWork.get",
"parameterOrder": [
"courseId",
"id"
],
"parameters": {
"courseId": {
"description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
"location": "path",
"required": true,
"type": "string"
},
"id": {
"description": "Identifier of the course work.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/courses/{courseId}/courseWork/{id}",
"response": {
"$ref": "CourseWork"
},
"scopes": [
"https://www.googleapis.com/auth/classroom.coursework.me",
"https://www.googleapis.com/auth/classroom.coursework.me.readonly",
"https://www.googleapis.com/auth/classroom.coursework.students",
"https://www.googleapis.com/auth/classroom.coursework.students.readonly"
]
},
"list": {
"description": "Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.",
"flatPath": "v1/courses/{courseId}/courseWork",
"httpMethod": "GET",
"id": "classroom.courses.courseWork.list",
"parameterOrder": [
"courseId"
],
"parameters": {
"courseId": {
"description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
"location": "path",
"required": true,
"type": "string"
},
"courseWorkStates": {
"description": "Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned.",
"enum": [
"COURSE_WORK_STATE_UNSPECIFIED",
"PUBLISHED",
"DRAFT",
"DELETED"
],
"enumDescriptions": [
"No state specified. This is never returned.",
"Status for work that has been published. This is the default state.",
"Status for work that is not yet published. Work in this state is visible only to course teachers and domain administrators.",
"Status for work that was published but is now deleted. Work in this state is visible only to course teachers and domain administrators. Work in this state is deleted after some time."
],
"location": "query",
"repeated": true,
"type": "string"
},
"orderBy": {
"description": "Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported fields are `updateTime` and `dueDate`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
"location": "query",
"type": "string"
}
},
"path": "v1/courses/{courseId}/courseWork",
"response": {
"$ref": "ListCourseWorkResponse"
},
"scopes": [
"https://www.googleapis.com/auth/classroom.coursework.me",
"https://www.googleapis.com/auth/classroom.coursework.me.readonly",
"https://www.googleapis.com/auth/classroom.coursework.students",
"https://www.googleapis.com/auth/classroom.coursework.students.readonly"
]
},
"modifyAssignees": {
"description": "Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.",
"flatPath": "v1/courses/{courseId}/courseWork/{id}:modifyAssignees",
"httpMethod": "POST",
"id": "classroom.courses.courseWork.modifyAssignees",
"parameterOrder": [
"courseId",
"id"
],
"parameters": {
"courseId": {
"description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
"location": "path",
"required": true,
"type": "string"
},
"id": {
"description": "Identifier of the coursework.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/courses/{courseId}/courseWork/{id}:modifyAssignees",
"request": {
"$ref": "ModifyCourseWorkAssigneesRequest"
},
"response": {
"$ref": "CourseWork"
},
"scopes": [
"https://www.googleapis.com/auth/classroom.coursework.students"
]
},
"patch": {
"description": "Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.",
"flatPath": "v1/courses/{courseId}/courseWork/{id}",
"httpMethod": "PATCH",
"id": "classroom.courses.courseWork.patch",
"parameterOrder": [
"courseId",
"id"
],
"parameters": {
"courseId": {
"description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
"location": "path",
"required": true,
"type": "string"
},
"id": {
"description": "Identifier of the course work.",
"location": "path",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id`",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/courses/{courseId}/courseWork/{id}",
"request": {
"$ref": "CourseWork"
},
"response": {
"$ref": "CourseWork"
},
"scopes": [
"https://www.googleapis.com/auth/classroom.coursework.students"
]
}
},
"resources": {
"studentSubmissions": {
"methods": {
"get": {
"description": "Returns a student submission. * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.",
"flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
"httpMethod": "GET",
"id": "classroom.courses.courseWork.studentSubmissions.get",
"parameterOrder": [
"courseId",
"courseWorkId",
"id"
],
"parameters": {
"courseId": {
"description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
"location": "path",
"required": true,
"type": "string"
},
"courseWorkId": {
"description": "Identifier of the course work.",
"location": "path",
"required": true,
"type": "string"
},
"id": {
"description": "Identifier of the student submission.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
"response": {
"$ref": "StudentSubmission"
},
"scopes": [
"https://www.googleapis.com/auth/classroom.coursework.me",
"https://www.googleapis.com/auth/classroom.coursework.me.readonly",
"https://www.googleapis.com/auth/classroom.coursework.students",
"https://www.googleapis.com/auth/classroom.coursework.students.readonly",
"https://www.googleapis.com/auth/classroom.student-submissions.me.readonly",
"https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"
]
},
"list": {
"description": "Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. `-` may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.",
"flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
"httpMethod": "GET",
"id": "classroom.courses.courseWork.studentSubmissions.list",
"parameterOrder": [
"courseId",
"courseWorkId"
],
"parameters": {
"courseId": {
"description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
"location": "path",
"required": true,
"type": "string"
},
"courseWorkId": {
"description": "Identifier of the student work to request. This may be set to the string literal `\"-\"` to request student work for all course work in the specified course.",
"location": "path",
"required": true,
"type": "string"
},
"late": {
"description": "Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of `late` value.",
"enum": [
"LATE_VALUES_UNSPECIFIED",
"LATE_ONLY",
"NOT_LATE_ONLY"
],
"enumDescriptions": [
"No restriction on submission late values specified.",
"Return StudentSubmissions where late is true.",
"Return StudentSubmissions where late is false."
],
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.",