OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/classroom.guardianlinks.student
s": { |
| 6 "description": "View and manage guardians for students in yo
ur Google Classroom classes" |
| 7 }, |
| 8 "https://www.googleapis.com/auth/classroom.student-submissions.m
e.readonly": { |
| 9 "description": "View your course work and grades in Google C
lassroom" |
| 10 }, |
| 11 "https://www.googleapis.com/auth/classroom.coursework.students":
{ |
| 12 "description": "Manage course work and grades for students i
n the Google Classroom classes you teach and view the course work and grades for
classes you administer" |
| 13 }, |
| 14 "https://www.googleapis.com/auth/classroom.coursework.students.r
eadonly": { |
| 15 "description": "View course work and grades for students in
the Google Classroom classes you teach or administer" |
| 16 }, |
| 17 "https://www.googleapis.com/auth/classroom.guardianlinks.me.read
only": { |
| 18 "description": "View your Google Classroom guardians" |
| 19 }, |
| 20 "https://www.googleapis.com/auth/classroom.coursework.me.readonl
y": { |
| 21 "description": "View your course work and grades in Google C
lassroom" |
| 22 }, |
5 "https://www.googleapis.com/auth/classroom.profile.emails": { | 23 "https://www.googleapis.com/auth/classroom.profile.emails": { |
6 "description": "View the email addresses of people in your c
lasses" | 24 "description": "View the email addresses of people in your c
lasses" |
7 }, | 25 }, |
8 "https://www.googleapis.com/auth/classroom.coursework.me": { | 26 "https://www.googleapis.com/auth/classroom.coursework.me": { |
9 "description": "Manage your course work and view your grades
in Google Classroom" | 27 "description": "Manage your course work and view your grades
in Google Classroom" |
10 }, | 28 }, |
11 "https://www.googleapis.com/auth/classroom.rosters": { | 29 "https://www.googleapis.com/auth/classroom.rosters": { |
12 "description": "Manage your Google Classroom class rosters" | 30 "description": "Manage your Google Classroom class rosters" |
13 }, | 31 }, |
14 "https://www.googleapis.com/auth/classroom.student-submissions.s
tudents.readonly": { | 32 "https://www.googleapis.com/auth/classroom.student-submissions.s
tudents.readonly": { |
15 "description": "View course work and grades for students in
the Google Classroom classes you teach or administer" | 33 "description": "View course work and grades for students in
the Google Classroom classes you teach or administer" |
16 }, | 34 }, |
17 "https://www.googleapis.com/auth/classroom.guardianlinks.student
s.readonly": { | 35 "https://www.googleapis.com/auth/classroom.guardianlinks.student
s.readonly": { |
18 "description": "View guardians for students in your Google C
lassroom classes" | 36 "description": "View guardians for students in your Google C
lassroom classes" |
19 }, | 37 }, |
20 "https://www.googleapis.com/auth/classroom.courses": { | 38 "https://www.googleapis.com/auth/classroom.courses": { |
21 "description": "Manage your Google Classroom classes" | 39 "description": "Manage your Google Classroom classes" |
22 }, | 40 }, |
23 "https://www.googleapis.com/auth/classroom.courses.readonly": { | 41 "https://www.googleapis.com/auth/classroom.courses.readonly": { |
24 "description": "View your Google Classroom classes" | 42 "description": "View your Google Classroom classes" |
25 }, | 43 }, |
26 "https://www.googleapis.com/auth/classroom.profile.photos": { | 44 "https://www.googleapis.com/auth/classroom.profile.photos": { |
27 "description": "View the profile photos of people in your cl
asses" | 45 "description": "View the profile photos of people in your cl
asses" |
28 }, | 46 }, |
29 "https://www.googleapis.com/auth/classroom.rosters.readonly": { | 47 "https://www.googleapis.com/auth/classroom.rosters.readonly": { |
30 "description": "View your Google Classroom class rosters" | 48 "description": "View your Google Classroom class rosters" |
31 }, | |
32 "https://www.googleapis.com/auth/classroom.guardianlinks.student
s": { | |
33 "description": "View and manage guardians for students in yo
ur Google Classroom classes" | |
34 }, | |
35 "https://www.googleapis.com/auth/classroom.student-submissions.m
e.readonly": { | |
36 "description": "View your course work and grades in Google C
lassroom" | |
37 }, | |
38 "https://www.googleapis.com/auth/classroom.guardianlinks.me.read
only": { | |
39 "description": "View your Google Classroom guardians" | |
40 }, | |
41 "https://www.googleapis.com/auth/classroom.coursework.students.r
eadonly": { | |
42 "description": "View course work and grades for students in
the Google Classroom classes you teach or administer" | |
43 }, | |
44 "https://www.googleapis.com/auth/classroom.coursework.students":
{ | |
45 "description": "Manage course work and grades for students i
n the Google Classroom classes you teach and view the course work and grades for
classes you administer" | |
46 }, | |
47 "https://www.googleapis.com/auth/classroom.coursework.me.readonl
y": { | |
48 "description": "View your course work and grades in Google C
lassroom" | |
49 } | 49 } |
50 } | 50 } |
51 } | 51 } |
52 }, | 52 }, |
53 "basePath": "", | 53 "basePath": "", |
54 "baseUrl": "https://classroom.googleapis.com/", | 54 "baseUrl": "https://classroom.googleapis.com/", |
55 "batchPath": "batch", | 55 "batchPath": "batch", |
56 "description": "Manages classes, rosters, and invitations in Google Classroo
m.", | 56 "description": "Manages classes, rosters, and invitations in Google Classroo
m.", |
57 "discoveryVersion": "v1", | 57 "discoveryVersion": "v1", |
58 "documentationLink": "https://developers.google.com/classroom/", | 58 "documentationLink": "https://developers.google.com/classroom/", |
59 "icons": { | 59 "icons": { |
60 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 60 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
61 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 61 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
62 }, | 62 }, |
63 "id": "classroom:v1", | 63 "id": "classroom:v1", |
64 "kind": "discovery#restDescription", | 64 "kind": "discovery#restDescription", |
65 "name": "classroom", | 65 "name": "classroom", |
66 "ownerDomain": "google.com", | 66 "ownerDomain": "google.com", |
67 "ownerName": "Google", | 67 "ownerName": "Google", |
68 "parameters": { | 68 "parameters": { |
69 "key": { | |
70 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | |
71 "location": "query", | |
72 "type": "string" | |
73 }, | |
74 "access_token": { | |
75 "description": "OAuth access token.", | |
76 "location": "query", | |
77 "type": "string" | |
78 }, | |
79 "quotaUser": { | |
80 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | |
81 "location": "query", | |
82 "type": "string" | |
83 }, | |
84 "pp": { | |
85 "default": "true", | |
86 "description": "Pretty-print response.", | |
87 "location": "query", | |
88 "type": "boolean" | |
89 }, | |
90 "oauth_token": { | |
91 "description": "OAuth 2.0 token for the current user.", | |
92 "location": "query", | |
93 "type": "string" | |
94 }, | |
95 "bearer_token": { | |
96 "description": "OAuth bearer token.", | |
97 "location": "query", | |
98 "type": "string" | |
99 }, | |
100 "upload_protocol": { | 69 "upload_protocol": { |
101 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 70 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
102 "location": "query", | 71 "location": "query", |
103 "type": "string" | 72 "type": "string" |
104 }, | 73 }, |
105 "prettyPrint": { | 74 "prettyPrint": { |
106 "default": "true", | 75 "default": "true", |
107 "description": "Returns response with indentations and line breaks."
, | 76 "description": "Returns response with indentations and line breaks."
, |
108 "location": "query", | 77 "location": "query", |
109 "type": "boolean" | 78 "type": "boolean" |
(...skipping 34 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
144 "media", | 113 "media", |
145 "proto" | 114 "proto" |
146 ], | 115 ], |
147 "enumDescriptions": [ | 116 "enumDescriptions": [ |
148 "Responses with Content-Type of application/json", | 117 "Responses with Content-Type of application/json", |
149 "Media download with context-dependent Content-Type", | 118 "Media download with context-dependent Content-Type", |
150 "Responses with Content-Type of application/x-protobuf" | 119 "Responses with Content-Type of application/x-protobuf" |
151 ], | 120 ], |
152 "location": "query", | 121 "location": "query", |
153 "type": "string" | 122 "type": "string" |
| 123 }, |
| 124 "access_token": { |
| 125 "description": "OAuth access token.", |
| 126 "location": "query", |
| 127 "type": "string" |
| 128 }, |
| 129 "key": { |
| 130 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 131 "location": "query", |
| 132 "type": "string" |
| 133 }, |
| 134 "quotaUser": { |
| 135 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
| 136 "location": "query", |
| 137 "type": "string" |
| 138 }, |
| 139 "pp": { |
| 140 "default": "true", |
| 141 "description": "Pretty-print response.", |
| 142 "location": "query", |
| 143 "type": "boolean" |
| 144 }, |
| 145 "oauth_token": { |
| 146 "description": "OAuth 2.0 token for the current user.", |
| 147 "location": "query", |
| 148 "type": "string" |
| 149 }, |
| 150 "bearer_token": { |
| 151 "description": "OAuth bearer token.", |
| 152 "location": "query", |
| 153 "type": "string" |
154 } | 154 } |
155 }, | 155 }, |
156 "protocol": "rest", | 156 "protocol": "rest", |
157 "resources": { | 157 "resources": { |
158 "invitations": { | 158 "invitations": { |
159 "methods": { | 159 "methods": { |
160 "get": { | 160 "get": { |
161 "description": "Returns an invitation.\n\nThis method return
s the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is
not permitted to view the\nrequested invitation or for access errors.\n* `NOT_FO
UND` if no invitation exists with the requested ID.", | 161 "description": "Returns an invitation.\n\nThis method return
s the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is
not permitted to view the\nrequested invitation or for access errors.\n* `NOT_FO
UND` if no invitation exists with the requested ID.", |
162 "httpMethod": "GET", | 162 "httpMethod": "GET", |
163 "id": "classroom.invitations.get", | 163 "id": "classroom.invitations.get", |
(...skipping 114 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
278 "$ref": "Empty" | 278 "$ref": "Empty" |
279 }, | 279 }, |
280 "scopes": [ | 280 "scopes": [ |
281 "https://www.googleapis.com/auth/classroom.rosters" | 281 "https://www.googleapis.com/auth/classroom.rosters" |
282 ] | 282 ] |
283 } | 283 } |
284 } | 284 } |
285 }, | 285 }, |
286 "courses": { | 286 "courses": { |
287 "methods": { | 287 "methods": { |
| 288 "delete": { |
| 289 "description": "Deletes a course.\n\nThis method returns the
following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not p
ermitted to delete the\nrequested course or for access errors.\n* `NOT_FOUND` if
no course exists with the requested ID.", |
| 290 "httpMethod": "DELETE", |
| 291 "id": "classroom.courses.delete", |
| 292 "parameterOrder": [ |
| 293 "id" |
| 294 ], |
| 295 "parameters": { |
| 296 "id": { |
| 297 "description": "Identifier of the course to delete.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", |
| 298 "location": "path", |
| 299 "required": true, |
| 300 "type": "string" |
| 301 } |
| 302 }, |
| 303 "path": "v1/courses/{id}", |
| 304 "response": { |
| 305 "$ref": "Empty" |
| 306 }, |
| 307 "scopes": [ |
| 308 "https://www.googleapis.com/auth/classroom.courses" |
| 309 ] |
| 310 }, |
| 311 "list": { |
| 312 "description": "Returns a list of courses that the requestin
g user is permitted to view,\nrestricted to those that match the request.\n\nThi
s method returns the following error codes:\n\n* `PERMISSION_DENIED` for access
errors.\n* `INVALID_ARGUMENT` if the query argument is malformed.\n* `NOT_FOUND`
if any users specified in the query arguments do not exist.", |
| 313 "httpMethod": "GET", |
| 314 "id": "classroom.courses.list", |
| 315 "parameterOrder": [], |
| 316 "parameters": { |
| 317 "studentId": { |
| 318 "description": "Restricts returned courses to those
having a student with the specified\nidentifier. The identifier can be one of th
e following:\n\n* the numeric identifier for the user\n* the email address of th
e user\n* the string literal `\"me\"`, indicating the requesting user", |
| 319 "location": "query", |
| 320 "type": "string" |
| 321 }, |
| 322 "pageToken": { |
| 323 "description": "nextPageToken\nvalue returned from a
previous\nlist call,\nindicating that the subsequent page of results should be
returned.\n\nThe list request must be\notherwise identical to the one that resul
ted in this token.", |
| 324 "location": "query", |
| 325 "type": "string" |
| 326 }, |
| 327 "pageSize": { |
| 328 "description": "Maximum number of items to return. Z
ero or unspecified indicates that the\nserver may assign a maximum.\n\nThe serve
r may return fewer than the specified number of results.", |
| 329 "format": "int32", |
| 330 "location": "query", |
| 331 "type": "integer" |
| 332 }, |
| 333 "teacherId": { |
| 334 "description": "Restricts returned courses to those
having a teacher with the specified\nidentifier. The identifier can be one of th
e following:\n\n* the numeric identifier for the user\n* the email address of th
e user\n* the string literal `\"me\"`, indicating the requesting user", |
| 335 "location": "query", |
| 336 "type": "string" |
| 337 }, |
| 338 "courseStates": { |
| 339 "description": "Restricts returned courses to those
in one of the specified states\nThe default value is ACTIVE, ARCHIVED, PROVISION
ED, DECLINED.", |
| 340 "enum": [ |
| 341 "COURSE_STATE_UNSPECIFIED", |
| 342 "ACTIVE", |
| 343 "ARCHIVED", |
| 344 "PROVISIONED", |
| 345 "DECLINED", |
| 346 "SUSPENDED" |
| 347 ], |
| 348 "location": "query", |
| 349 "repeated": true, |
| 350 "type": "string" |
| 351 } |
| 352 }, |
| 353 "path": "v1/courses", |
| 354 "response": { |
| 355 "$ref": "ListCoursesResponse" |
| 356 }, |
| 357 "scopes": [ |
| 358 "https://www.googleapis.com/auth/classroom.courses", |
| 359 "https://www.googleapis.com/auth/classroom.courses.reado
nly" |
| 360 ] |
| 361 }, |
| 362 "create": { |
| 363 "description": "Creates a course.\n\nThe user specified in `
ownerId` is the owner of the created course\nand added as a teacher.\n\nThis met
hod returns the following error codes:\n\n* `PERMISSION_DENIED` if the requestin
g user is not permitted to create\ncourses or for access errors.\n* `NOT_FOUND`
if the primary teacher is not a valid user.\n* `FAILED_PRECONDITION` if the cour
se owner's account is disabled or for\nthe following request errors:\n * User
GroupsMembershipLimitReached\n* `ALREADY_EXISTS` if an alias was specified in th
e `id` and\nalready exists.", |
| 364 "httpMethod": "POST", |
| 365 "id": "classroom.courses.create", |
| 366 "parameterOrder": [], |
| 367 "parameters": {}, |
| 368 "path": "v1/courses", |
| 369 "request": { |
| 370 "$ref": "Course" |
| 371 }, |
| 372 "response": { |
| 373 "$ref": "Course" |
| 374 }, |
| 375 "scopes": [ |
| 376 "https://www.googleapis.com/auth/classroom.courses" |
| 377 ] |
| 378 }, |
288 "get": { | 379 "get": { |
289 "description": "Returns a course.\n\nThis method returns the
following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not p
ermitted to access the\nrequested course or for access errors.\n* `NOT_FOUND` if
no course exists with the requested ID.", | 380 "description": "Returns a course.\n\nThis method returns the
following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not p
ermitted to access the\nrequested course or for access errors.\n* `NOT_FOUND` if
no course exists with the requested ID.", |
290 "httpMethod": "GET", | 381 "httpMethod": "GET", |
291 "id": "classroom.courses.get", | 382 "id": "classroom.courses.get", |
292 "parameterOrder": [ | 383 "parameterOrder": [ |
293 "id" | 384 "id" |
294 ], | 385 ], |
295 "parameters": { | 386 "parameters": { |
296 "id": { | 387 "id": { |
297 "description": "Identifier of the course to return.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", | 388 "description": "Identifier of the course to return.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", |
(...skipping 61 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
359 "path": "v1/courses/{id}", | 450 "path": "v1/courses/{id}", |
360 "request": { | 451 "request": { |
361 "$ref": "Course" | 452 "$ref": "Course" |
362 }, | 453 }, |
363 "response": { | 454 "response": { |
364 "$ref": "Course" | 455 "$ref": "Course" |
365 }, | 456 }, |
366 "scopes": [ | 457 "scopes": [ |
367 "https://www.googleapis.com/auth/classroom.courses" | 458 "https://www.googleapis.com/auth/classroom.courses" |
368 ] | 459 ] |
369 }, | |
370 "delete": { | |
371 "description": "Deletes a course.\n\nThis method returns the
following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not p
ermitted to delete the\nrequested course or for access errors.\n* `NOT_FOUND` if
no course exists with the requested ID.", | |
372 "httpMethod": "DELETE", | |
373 "id": "classroom.courses.delete", | |
374 "parameterOrder": [ | |
375 "id" | |
376 ], | |
377 "parameters": { | |
378 "id": { | |
379 "description": "Identifier of the course to delete.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", | |
380 "location": "path", | |
381 "required": true, | |
382 "type": "string" | |
383 } | |
384 }, | |
385 "path": "v1/courses/{id}", | |
386 "response": { | |
387 "$ref": "Empty" | |
388 }, | |
389 "scopes": [ | |
390 "https://www.googleapis.com/auth/classroom.courses" | |
391 ] | |
392 }, | |
393 "list": { | |
394 "description": "Returns a list of courses that the requestin
g user is permitted to view,\nrestricted to those that match the request.\n\nThi
s method returns the following error codes:\n\n* `PERMISSION_DENIED` for access
errors.\n* `INVALID_ARGUMENT` if the query argument is malformed.\n* `NOT_FOUND`
if any users specified in the query arguments do not exist.", | |
395 "httpMethod": "GET", | |
396 "id": "classroom.courses.list", | |
397 "parameterOrder": [], | |
398 "parameters": { | |
399 "teacherId": { | |
400 "description": "Restricts returned courses to those
having a teacher with the specified\nidentifier. The identifier can be one of th
e following:\n\n* the numeric identifier for the user\n* the email address of th
e user\n* the string literal `\"me\"`, indicating the requesting user", | |
401 "location": "query", | |
402 "type": "string" | |
403 }, | |
404 "courseStates": { | |
405 "description": "Restricts returned courses to those
in one of the specified states\nThe default value is ACTIVE, ARCHIVED, PROVISION
ED, DECLINED.", | |
406 "enum": [ | |
407 "COURSE_STATE_UNSPECIFIED", | |
408 "ACTIVE", | |
409 "ARCHIVED", | |
410 "PROVISIONED", | |
411 "DECLINED", | |
412 "SUSPENDED" | |
413 ], | |
414 "location": "query", | |
415 "repeated": true, | |
416 "type": "string" | |
417 }, | |
418 "studentId": { | |
419 "description": "Restricts returned courses to those
having a student with the specified\nidentifier. The identifier can be one of th
e following:\n\n* the numeric identifier for the user\n* the email address of th
e user\n* the string literal `\"me\"`, indicating the requesting user", | |
420 "location": "query", | |
421 "type": "string" | |
422 }, | |
423 "pageToken": { | |
424 "description": "nextPageToken\nvalue returned from a
previous\nlist call,\nindicating that the subsequent page of results should be
returned.\n\nThe list request must be\notherwise identical to the one that resul
ted in this token.", | |
425 "location": "query", | |
426 "type": "string" | |
427 }, | |
428 "pageSize": { | |
429 "description": "Maximum number of items to return. Z
ero or unspecified indicates that the\nserver may assign a maximum.\n\nThe serve
r may return fewer than the specified number of results.", | |
430 "format": "int32", | |
431 "location": "query", | |
432 "type": "integer" | |
433 } | |
434 }, | |
435 "path": "v1/courses", | |
436 "response": { | |
437 "$ref": "ListCoursesResponse" | |
438 }, | |
439 "scopes": [ | |
440 "https://www.googleapis.com/auth/classroom.courses", | |
441 "https://www.googleapis.com/auth/classroom.courses.reado
nly" | |
442 ] | |
443 }, | |
444 "create": { | |
445 "description": "Creates a course.\n\nThe user specified in `
ownerId` is the owner of the created course\nand added as a teacher.\n\nThis met
hod returns the following error codes:\n\n* `PERMISSION_DENIED` if the requestin
g user is not permitted to create\ncourses or for access errors.\n* `NOT_FOUND`
if the primary teacher is not a valid user.\n* `FAILED_PRECONDITION` if the cour
se owner's account is disabled or for\nthe following request errors:\n * User
GroupsMembershipLimitReached\n* `ALREADY_EXISTS` if an alias was specified in th
e `id` and\nalready exists.", | |
446 "httpMethod": "POST", | |
447 "id": "classroom.courses.create", | |
448 "parameterOrder": [], | |
449 "parameters": {}, | |
450 "path": "v1/courses", | |
451 "request": { | |
452 "$ref": "Course" | |
453 }, | |
454 "response": { | |
455 "$ref": "Course" | |
456 }, | |
457 "scopes": [ | |
458 "https://www.googleapis.com/auth/classroom.courses" | |
459 ] | |
460 } | 460 } |
461 }, | 461 }, |
462 "resources": { | 462 "resources": { |
463 "aliases": { | 463 "teachers": { |
464 "methods": { | 464 "methods": { |
465 "delete": { | 465 "get": { |
466 "description": "Deletes an alias of a course.\n\nThi
s method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requ
esting user is not permitted to remove the\nalias or for access errors.\n* `NOT_
FOUND` if the alias does not exist.\n* `FAILED_PRECONDITION` if the alias reques
ted does not make sense for the\n requesting user or course (for example, if a
user not in a domain\n attempts to delete a domain-scoped alias).", | 466 "description": "Returns a teacher of a course.\n\nTh
is method returns the following error codes:\n\n* `PERMISSION_DENIED` if the req
uesting user is not permitted to view\nteachers of this course or for access err
ors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\
ncourse does not exist.", |
467 "httpMethod": "DELETE", | 467 "httpMethod": "GET", |
468 "id": "classroom.courses.aliases.delete", | 468 "id": "classroom.courses.teachers.get", |
469 "parameterOrder": [ | 469 "parameterOrder": [ |
470 "courseId", | 470 "courseId", |
471 "alias" | 471 "userId" |
472 ], | 472 ], |
473 "parameters": { | 473 "parameters": { |
474 "courseId": { | 474 "courseId": { |
475 "description": "Identifier of the course who
se alias should be deleted.\nThis identifier can be either the Classroom-assigne
d identifier or an\nalias.", | 475 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
476 "location": "path", | 476 "location": "path", |
477 "required": true, | 477 "required": true, |
478 "type": "string" | 478 "type": "string" |
479 }, | 479 }, |
480 "alias": { | 480 "userId": { |
481 "description": "Alias to delete.\nThis may n
ot be the Classroom-assigned identifier.", | 481 "description": "Identifier of the teacher to
return. The identifier can be one of the\nfollowing:\n\n* the numeric identifie
r for the user\n* the email address of the user\n* the string literal `\"me\"`,
indicating the requesting user", |
482 "location": "path", | 482 "location": "path", |
483 "required": true, | 483 "required": true, |
484 "type": "string" | 484 "type": "string" |
485 } | 485 } |
486 }, | 486 }, |
487 "path": "v1/courses/{courseId}/aliases/{alias}", | 487 "path": "v1/courses/{courseId}/teachers/{userId}", |
| 488 "response": { |
| 489 "$ref": "Teacher" |
| 490 }, |
| 491 "scopes": [ |
| 492 "https://www.googleapis.com/auth/classroom.profi
le.emails", |
| 493 "https://www.googleapis.com/auth/classroom.profi
le.photos", |
| 494 "https://www.googleapis.com/auth/classroom.roste
rs", |
| 495 "https://www.googleapis.com/auth/classroom.roste
rs.readonly" |
| 496 ] |
| 497 }, |
| 498 "list": { |
| 499 "description": "Returns a list of teachers of this c
ourse that the requester\nis permitted to view.\n\nThis method returns the follo
wing error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_
DENIED` for access errors.", |
| 500 "httpMethod": "GET", |
| 501 "id": "classroom.courses.teachers.list", |
| 502 "parameterOrder": [ |
| 503 "courseId" |
| 504 ], |
| 505 "parameters": { |
| 506 "pageToken": { |
| 507 "description": "nextPageToken\nvalue returne
d from a previous\nlist call, indicating that\nthe subsequent page of results sh
ould be returned.\n\nThe list request must be\notherwise identical to the one th
at resulted in this token.", |
| 508 "location": "query", |
| 509 "type": "string" |
| 510 }, |
| 511 "pageSize": { |
| 512 "description": "Maximum number of items to r
eturn. Zero means no maximum.\n\nThe server may return fewer than the specified
number of results.", |
| 513 "format": "int32", |
| 514 "location": "query", |
| 515 "type": "integer" |
| 516 }, |
| 517 "courseId": { |
| 518 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
| 519 "location": "path", |
| 520 "required": true, |
| 521 "type": "string" |
| 522 } |
| 523 }, |
| 524 "path": "v1/courses/{courseId}/teachers", |
| 525 "response": { |
| 526 "$ref": "ListTeachersResponse" |
| 527 }, |
| 528 "scopes": [ |
| 529 "https://www.googleapis.com/auth/classroom.profi
le.emails", |
| 530 "https://www.googleapis.com/auth/classroom.profi
le.photos", |
| 531 "https://www.googleapis.com/auth/classroom.roste
rs", |
| 532 "https://www.googleapis.com/auth/classroom.roste
rs.readonly" |
| 533 ] |
| 534 }, |
| 535 "create": { |
| 536 "description": "Creates a teacher of a course.\n\nTh
is method returns the following error codes:\n\n* `PERMISSION_DENIED` if the req
uesting user is not permitted to create\nteachers in this course or for access
errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRE
CONDITION` if the requested user's account is disabled,\nfor the following reque
st errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * Cou
rseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXIST
S` if the user is already a teacher or student in the\ncourse.", |
| 537 "httpMethod": "POST", |
| 538 "id": "classroom.courses.teachers.create", |
| 539 "parameterOrder": [ |
| 540 "courseId" |
| 541 ], |
| 542 "parameters": { |
| 543 "courseId": { |
| 544 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
| 545 "location": "path", |
| 546 "required": true, |
| 547 "type": "string" |
| 548 } |
| 549 }, |
| 550 "path": "v1/courses/{courseId}/teachers", |
| 551 "request": { |
| 552 "$ref": "Teacher" |
| 553 }, |
| 554 "response": { |
| 555 "$ref": "Teacher" |
| 556 }, |
| 557 "scopes": [ |
| 558 "https://www.googleapis.com/auth/classroom.profi
le.emails", |
| 559 "https://www.googleapis.com/auth/classroom.profi
le.photos", |
| 560 "https://www.googleapis.com/auth/classroom.roste
rs" |
| 561 ] |
| 562 }, |
| 563 "delete": { |
| 564 "description": "Deletes a teacher of a course.\n\nTh
is method returns the following error codes:\n\n* `PERMISSION_DENIED` if the req
uesting user is not permitted to delete\nteachers of this course or for access e
rrors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if th
e\ncourse does not exist.\n* `FAILED_PRECONDITION` if the requested ID belongs t
o the primary teacher\nof this course.", |
| 565 "httpMethod": "DELETE", |
| 566 "id": "classroom.courses.teachers.delete", |
| 567 "parameterOrder": [ |
| 568 "courseId", |
| 569 "userId" |
| 570 ], |
| 571 "parameters": { |
| 572 "userId": { |
| 573 "description": "Identifier of the teacher to
delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifie
r for the user\n* the email address of the user\n* the string literal `\"me\"`,
indicating the requesting user", |
| 574 "location": "path", |
| 575 "required": true, |
| 576 "type": "string" |
| 577 }, |
| 578 "courseId": { |
| 579 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
| 580 "location": "path", |
| 581 "required": true, |
| 582 "type": "string" |
| 583 } |
| 584 }, |
| 585 "path": "v1/courses/{courseId}/teachers/{userId}", |
488 "response": { | 586 "response": { |
489 "$ref": "Empty" | 587 "$ref": "Empty" |
490 }, | 588 }, |
491 "scopes": [ | 589 "scopes": [ |
492 "https://www.googleapis.com/auth/classroom.cours
es" | 590 "https://www.googleapis.com/auth/classroom.roste
rs" |
493 ] | 591 ] |
494 }, | 592 } |
| 593 } |
| 594 }, |
| 595 "aliases": { |
| 596 "methods": { |
495 "list": { | 597 "list": { |
496 "description": "Returns a list of aliases for a cour
se.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` i
f the requesting user is not permitted to access the\ncourse or for access error
s.\n* `NOT_FOUND` if the course does not exist.", | 598 "description": "Returns a list of aliases for a cour
se.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` i
f the requesting user is not permitted to access the\ncourse or for access error
s.\n* `NOT_FOUND` if the course does not exist.", |
497 "httpMethod": "GET", | 599 "httpMethod": "GET", |
498 "id": "classroom.courses.aliases.list", | 600 "id": "classroom.courses.aliases.list", |
499 "parameterOrder": [ | 601 "parameterOrder": [ |
500 "courseId" | 602 "courseId" |
501 ], | 603 ], |
502 "parameters": { | 604 "parameters": { |
503 "pageToken": { | 605 "pageToken": { |
504 "description": "nextPageToken\nvalue returne
d from a previous\nlist call,\nindicating that the subsequent page of results sh
ould be returned.\n\nThe list request\nmust be otherwise identical to the one th
at resulted in this token.", | 606 "description": "nextPageToken\nvalue returne
d from a previous\nlist call,\nindicating that the subsequent page of results sh
ould be returned.\n\nThe list request\nmust be otherwise identical to the one th
at resulted in this token.", |
(...skipping 40 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
545 "path": "v1/courses/{courseId}/aliases", | 647 "path": "v1/courses/{courseId}/aliases", |
546 "request": { | 648 "request": { |
547 "$ref": "CourseAlias" | 649 "$ref": "CourseAlias" |
548 }, | 650 }, |
549 "response": { | 651 "response": { |
550 "$ref": "CourseAlias" | 652 "$ref": "CourseAlias" |
551 }, | 653 }, |
552 "scopes": [ | 654 "scopes": [ |
553 "https://www.googleapis.com/auth/classroom.cours
es" | 655 "https://www.googleapis.com/auth/classroom.cours
es" |
554 ] | 656 ] |
| 657 }, |
| 658 "delete": { |
| 659 "description": "Deletes an alias of a course.\n\nThi
s method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requ
esting user is not permitted to remove the\nalias or for access errors.\n* `NOT_
FOUND` if the alias does not exist.\n* `FAILED_PRECONDITION` if the alias reques
ted does not make sense for the\n requesting user or course (for example, if a
user not in a domain\n attempts to delete a domain-scoped alias).", |
| 660 "httpMethod": "DELETE", |
| 661 "id": "classroom.courses.aliases.delete", |
| 662 "parameterOrder": [ |
| 663 "courseId", |
| 664 "alias" |
| 665 ], |
| 666 "parameters": { |
| 667 "alias": { |
| 668 "description": "Alias to delete.\nThis may n
ot be the Classroom-assigned identifier.", |
| 669 "location": "path", |
| 670 "required": true, |
| 671 "type": "string" |
| 672 }, |
| 673 "courseId": { |
| 674 "description": "Identifier of the course who
se alias should be deleted.\nThis identifier can be either the Classroom-assigne
d identifier or an\nalias.", |
| 675 "location": "path", |
| 676 "required": true, |
| 677 "type": "string" |
| 678 } |
| 679 }, |
| 680 "path": "v1/courses/{courseId}/aliases/{alias}", |
| 681 "response": { |
| 682 "$ref": "Empty" |
| 683 }, |
| 684 "scopes": [ |
| 685 "https://www.googleapis.com/auth/classroom.cours
es" |
| 686 ] |
555 } | 687 } |
556 } | 688 } |
557 }, | 689 }, |
558 "students": { | 690 "students": { |
559 "methods": { | 691 "methods": { |
560 "delete": { | 692 "delete": { |
561 "description": "Deletes a student of a course.\n\nTh
is method returns the following error codes:\n\n* `PERMISSION_DENIED` if the req
uesting user is not permitted to delete\nstudents of this course or for access e
rrors.\n* `NOT_FOUND` if no student of this course has the requested ID or if th
e\ncourse does not exist.", | 693 "description": "Deletes a student of a course.\n\nTh
is method returns the following error codes:\n\n* `PERMISSION_DENIED` if the req
uesting user is not permitted to delete\nstudents of this course or for access e
rrors.\n* `NOT_FOUND` if no student of this course has the requested ID or if th
e\ncourse does not exist.", |
562 "httpMethod": "DELETE", | 694 "httpMethod": "DELETE", |
563 "id": "classroom.courses.students.delete", | 695 "id": "classroom.courses.students.delete", |
564 "parameterOrder": [ | 696 "parameterOrder": [ |
565 "courseId", | 697 "courseId", |
566 "userId" | 698 "userId" |
567 ], | 699 ], |
568 "parameters": { | 700 "parameters": { |
| 701 "userId": { |
| 702 "description": "Identifier of the student to
delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifie
r for the user\n* the email address of the user\n* the string literal `\"me\"`,
indicating the requesting user", |
| 703 "location": "path", |
| 704 "required": true, |
| 705 "type": "string" |
| 706 }, |
569 "courseId": { | 707 "courseId": { |
570 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | 708 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
571 "location": "path", | 709 "location": "path", |
572 "required": true, | 710 "required": true, |
573 "type": "string" | 711 "type": "string" |
574 }, | |
575 "userId": { | |
576 "description": "Identifier of the student to
delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifie
r for the user\n* the email address of the user\n* the string literal `\"me\"`,
indicating the requesting user", | |
577 "location": "path", | |
578 "required": true, | |
579 "type": "string" | |
580 } | 712 } |
581 }, | 713 }, |
582 "path": "v1/courses/{courseId}/students/{userId}", | 714 "path": "v1/courses/{courseId}/students/{userId}", |
583 "response": { | 715 "response": { |
584 "$ref": "Empty" | 716 "$ref": "Empty" |
585 }, | 717 }, |
586 "scopes": [ | 718 "scopes": [ |
587 "https://www.googleapis.com/auth/classroom.roste
rs" | 719 "https://www.googleapis.com/auth/classroom.roste
rs" |
588 ] | 720 ] |
589 }, | 721 }, |
(...skipping 136 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
726 }, | 858 }, |
727 "patch": { | 859 "patch": { |
728 "description": "Updates one or more fields of a cour
se work.\n\nSee google.classroom.v1.CourseWork for details\nof which fields may
be updated and who may change them.\n\nThis request must be made by the Develope
r Console project of the\n[OAuth client ID](https://support.google.com/cloud/ans
wer/6158849) used to\ncreate the corresponding course work item.\n\nThis method
returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting de
veloper project did not create\nthe corresponding course work, if the user is no
t permitted to make the\nrequested modification to the student submission, or fo
r\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `FAILED_
PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FO
UND` if the requested course, course work, or student submission\ndoes not exist
.", | 860 "description": "Updates one or more fields of a cour
se work.\n\nSee google.classroom.v1.CourseWork for details\nof which fields may
be updated and who may change them.\n\nThis request must be made by the Develope
r Console project of the\n[OAuth client ID](https://support.google.com/cloud/ans
wer/6158849) used to\ncreate the corresponding course work item.\n\nThis method
returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting de
veloper project did not create\nthe corresponding course work, if the user is no
t permitted to make the\nrequested modification to the student submission, or fo
r\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `FAILED_
PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FO
UND` if the requested course, course work, or student submission\ndoes not exist
.", |
729 "httpMethod": "PATCH", | 861 "httpMethod": "PATCH", |
730 "id": "classroom.courses.courseWork.patch", | 862 "id": "classroom.courses.courseWork.patch", |
731 "parameterOrder": [ | 863 "parameterOrder": [ |
732 "courseId", | 864 "courseId", |
733 "id" | 865 "id" |
734 ], | 866 ], |
735 "parameters": { | 867 "parameters": { |
736 "updateMask": { | |
737 "description": "Mask that identifies which f
ields on the course work to update.\nThis field is required to do an update. The
update fails if invalid\nfields are specified. If a field supports empty values
, it can be cleared\nby specifying it in the update mask and not in the CourseWo
rk object. If a\nfield that does not support empty values is included in the upd
ate mask and\nnot set in the CourseWork object, an `INVALID_ARGUMENT` error will
be\nreturned.\n\nThe following fields may be specified by teachers:\n* `title`\
n* `description`\n* `state`\n* `due_date`\n* `due_time`\n* `max_points`\n* `subm
ission_modification_mode`", | |
738 "format": "google-fieldmask", | |
739 "location": "query", | |
740 "type": "string" | |
741 }, | |
742 "courseId": { | 868 "courseId": { |
743 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | 869 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
744 "location": "path", | 870 "location": "path", |
745 "required": true, | 871 "required": true, |
746 "type": "string" | 872 "type": "string" |
747 }, | 873 }, |
748 "id": { | 874 "id": { |
749 "description": "Identifier of the course wor
k.", | 875 "description": "Identifier of the course wor
k.", |
750 "location": "path", | 876 "location": "path", |
751 "required": true, | 877 "required": true, |
752 "type": "string" | 878 "type": "string" |
| 879 }, |
| 880 "updateMask": { |
| 881 "description": "Mask that identifies which f
ields on the course work to update.\nThis field is required to do an update. The
update fails if invalid\nfields are specified. If a field supports empty values
, it can be cleared\nby specifying it in the update mask and not in the CourseWo
rk object. If a\nfield that does not support empty values is included in the upd
ate mask and\nnot set in the CourseWork object, an `INVALID_ARGUMENT` error will
be\nreturned.\n\nThe following fields may be specified by teachers:\n* `title`\
n* `description`\n* `state`\n* `due_date`\n* `due_time`\n* `max_points`\n* `subm
ission_modification_mode`", |
| 882 "format": "google-fieldmask", |
| 883 "location": "query", |
| 884 "type": "string" |
753 } | 885 } |
754 }, | 886 }, |
755 "path": "v1/courses/{courseId}/courseWork/{id}", | 887 "path": "v1/courses/{courseId}/courseWork/{id}", |
756 "request": { | 888 "request": { |
757 "$ref": "CourseWork" | 889 "$ref": "CourseWork" |
758 }, | 890 }, |
759 "response": { | 891 "response": { |
760 "$ref": "CourseWork" | 892 "$ref": "CourseWork" |
761 }, | 893 }, |
762 "scopes": [ | 894 "scopes": [ |
(...skipping 110 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
873 "$ref": "CourseWork" | 1005 "$ref": "CourseWork" |
874 }, | 1006 }, |
875 "scopes": [ | 1007 "scopes": [ |
876 "https://www.googleapis.com/auth/classroom.cours
ework.students" | 1008 "https://www.googleapis.com/auth/classroom.cours
ework.students" |
877 ] | 1009 ] |
878 } | 1010 } |
879 }, | 1011 }, |
880 "resources": { | 1012 "resources": { |
881 "studentSubmissions": { | 1013 "studentSubmissions": { |
882 "methods": { | 1014 "methods": { |
883 "get": { | 1015 "turnIn": { |
884 "description": "Returns a student submission
.\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the
\nrequested course, course work, or student submission or for\naccess errors.\n*
`INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested
course, course work, or student submission\ndoes not exist.", | 1016 "description": "Turns in a student submissio
n.\n\nTurning in a student submission transfers ownership of attached Drive\nfil
es to the teacher and may also update the submission state.\n\nThis may only be
called by the student that owns the specified student\nsubmission.\n\nThis reque
st must be made by the Developer Console project of the\n[OAuth client ID](https
://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding co
urse work item.\n\nThis method returns the following error codes:\n\n* `PERMISSI
ON_DENIED` if the requesting user is not permitted to access the\nrequested cour
se or course work, turn in the requested student submission,\nor for access erro
rs.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the req
uested course, course work, or student submission\ndoes not exist.", |
885 "httpMethod": "GET", | 1017 "httpMethod": "POST", |
886 "id": "classroom.courses.courseWork.studentS
ubmissions.get", | 1018 "id": "classroom.courses.courseWork.studentS
ubmissions.turnIn", |
887 "parameterOrder": [ | 1019 "parameterOrder": [ |
888 "courseId", | 1020 "courseId", |
889 "courseWorkId", | 1021 "courseWorkId", |
890 "id" | 1022 "id" |
891 ], | 1023 ], |
892 "parameters": { | 1024 "parameters": { |
893 "courseWorkId": { | 1025 "courseWorkId": { |
894 "description": "Identifier of the co
urse work.", | 1026 "description": "Identifier of the co
urse work.", |
895 "location": "path", | 1027 "location": "path", |
896 "required": true, | 1028 "required": true, |
897 "type": "string" | 1029 "type": "string" |
898 }, | 1030 }, |
899 "courseId": { | 1031 "courseId": { |
900 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", | 1032 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", |
901 "location": "path", | 1033 "location": "path", |
902 "required": true, | 1034 "required": true, |
903 "type": "string" | 1035 "type": "string" |
904 }, | 1036 }, |
905 "id": { | 1037 "id": { |
906 "description": "Identifier of the st
udent submission.", | 1038 "description": "Identifier of the st
udent submission.", |
907 "location": "path", | 1039 "location": "path", |
908 "required": true, | 1040 "required": true, |
909 "type": "string" | 1041 "type": "string" |
910 } | 1042 } |
911 }, | 1043 }, |
912 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}", | 1044 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}:turnIn", |
| 1045 "request": { |
| 1046 "$ref": "TurnInStudentSubmissionRequest" |
| 1047 }, |
913 "response": { | 1048 "response": { |
914 "$ref": "StudentSubmission" | 1049 "$ref": "Empty" |
915 }, | 1050 }, |
916 "scopes": [ | 1051 "scopes": [ |
917 "https://www.googleapis.com/auth/classro
om.coursework.me", | 1052 "https://www.googleapis.com/auth/classro
om.coursework.me" |
918 "https://www.googleapis.com/auth/classro
om.coursework.me.readonly", | |
919 "https://www.googleapis.com/auth/classro
om.coursework.students", | |
920 "https://www.googleapis.com/auth/classro
om.coursework.students.readonly", | |
921 "https://www.googleapis.com/auth/classro
om.student-submissions.me.readonly", | |
922 "https://www.googleapis.com/auth/classro
om.student-submissions.students.readonly" | |
923 ] | 1053 ] |
924 }, | 1054 }, |
925 "patch": { | 1055 "modifyAttachments": { |
926 "description": "Updates one or more fields o
f a student submission.\n\nSee google.classroom.v1.StudentSubmission for details
\nof which fields may be updated and who may change them.\n\nThis request must b
e made by the Developer Console project of the\n[OAuth client ID](https://suppor
t.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work
item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED
` if the requesting developer project did not create\nthe corresponding course w
ork, if the user is not permitted to make the\nrequested modification to the stu
dent submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is
malformed.\n* `NOT_FOUND` if the requested course, course work, or student submi
ssion\ndoes not exist.", | 1056 "description": "Modifies attachments of stud
ent submission.\n\nAttachments may only be added to student submissions belongin
g to course\nwork objects with a `workType` of `ASSIGNMENT`.\n\nThis request mus
t be made by the Developer Console project of the\n[OAuth client ID](https://sup
port.google.com/cloud/answer/6158849) used to\ncreate the corresponding course w
ork item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DEN
IED` if the requesting user is not permitted to access the\nrequested course or
course work, if the user is not permitted to modify\nattachments on the requeste
d student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the reques
t is malformed.\n* `NOT_FOUND` if the requested course, course work, or student
submission\ndoes not exist.", |
927 "httpMethod": "PATCH", | 1057 "httpMethod": "POST", |
928 "id": "classroom.courses.courseWork.studentS
ubmissions.patch", | 1058 "id": "classroom.courses.courseWork.studentS
ubmissions.modifyAttachments", |
929 "parameterOrder": [ | 1059 "parameterOrder": [ |
930 "courseId", | 1060 "courseId", |
931 "courseWorkId", | 1061 "courseWorkId", |
932 "id" | 1062 "id" |
933 ], | 1063 ], |
934 "parameters": { | 1064 "parameters": { |
935 "courseWorkId": { | 1065 "courseWorkId": { |
936 "description": "Identifier of the co
urse work.", | 1066 "description": "Identifier of the co
urse work.", |
937 "location": "path", | 1067 "location": "path", |
938 "required": true, | 1068 "required": true, |
939 "type": "string" | 1069 "type": "string" |
940 }, | 1070 }, |
941 "courseId": { | 1071 "courseId": { |
942 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", | 1072 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", |
943 "location": "path", | 1073 "location": "path", |
944 "required": true, | 1074 "required": true, |
945 "type": "string" | 1075 "type": "string" |
946 }, | 1076 }, |
947 "id": { | 1077 "id": { |
948 "description": "Identifier of the st
udent submission.", | 1078 "description": "Identifier of the st
udent submission.", |
949 "location": "path", | 1079 "location": "path", |
950 "required": true, | 1080 "required": true, |
951 "type": "string" | 1081 "type": "string" |
952 }, | |
953 "updateMask": { | |
954 "description": "Mask that identifies
which fields on the student submission to update.\nThis field is required to do
an update. The update fails if invalid\nfields are specified.\n\nThe following
fields may be specified by teachers:\n* `draft_grade`\n* `assigned_grade`", | |
955 "format": "google-fieldmask", | |
956 "location": "query", | |
957 "type": "string" | |
958 } | 1082 } |
959 }, | 1083 }, |
960 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}", | 1084 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}:modifyAttachments", |
961 "request": { | 1085 "request": { |
962 "$ref": "StudentSubmission" | 1086 "$ref": "ModifyAttachmentsRequest" |
963 }, | 1087 }, |
964 "response": { | 1088 "response": { |
965 "$ref": "StudentSubmission" | 1089 "$ref": "StudentSubmission" |
966 }, | 1090 }, |
967 "scopes": [ | 1091 "scopes": [ |
968 "https://www.googleapis.com/auth/classro
om.coursework.me", | 1092 "https://www.googleapis.com/auth/classro
om.coursework.me", |
969 "https://www.googleapis.com/auth/classro
om.coursework.students" | 1093 "https://www.googleapis.com/auth/classro
om.coursework.students" |
970 ] | 1094 ] |
971 }, | 1095 }, |
972 "return": { | 1096 "list": { |
973 "description": "Returns a student submission
.\n\nReturning a student submission transfers ownership of attached Drive\nfiles
to the student and may also update the submission state.\nUnlike the Classroom
application, returning a student submission does not\nset assignedGrade to the d
raftGrade value.\n\nOnly a teacher of the course that contains the requested stu
dent submission\nmay call this method.\n\nThis request must be made by the Devel
oper Console project of the\n[OAuth client ID](https://support.google.com/cloud/
answer/6158849) used to\ncreate the corresponding course work item.\n\nThis meth
od returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting
user is not permitted to access the\nrequested course or course work, return th
e requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if
the request is malformed.\n* `NOT_FOUND` if the requested course, course work, o
r student submission\ndoes not exist.", | 1097 "description": "Returns a list of student su
bmissions that the requester is permitted to\nview, factoring in the OAuth scope
s of the request.\n`-` may be specified as the `course_work_id` to include stude
nt\nsubmissions for multiple course work items.\n\nCourse students may only view
their own work. Course teachers\nand domain administrators may view all student
submissions.\n\nThis method returns the following error codes:\n\n* `PERMISSION
_DENIED` if the requesting user is not permitted to access the\nrequested course
or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is m
alformed.\n* `NOT_FOUND` if the requested course does not exist.", |
974 "httpMethod": "POST", | 1098 "httpMethod": "GET", |
975 "id": "classroom.courses.courseWork.studentS
ubmissions.return", | 1099 "id": "classroom.courses.courseWork.studentS
ubmissions.list", |
976 "parameterOrder": [ | 1100 "parameterOrder": [ |
977 "courseId", | 1101 "courseId", |
978 "courseWorkId", | 1102 "courseWorkId" |
979 "id" | |
980 ], | 1103 ], |
981 "parameters": { | 1104 "parameters": { |
982 "courseWorkId": { | 1105 "courseWorkId": { |
983 "description": "Identifier of the co
urse work.", | 1106 "description": "Identifer of the stu
dent work to request.\nThis may be set to the string literal `\"-\"` to request
student work for\nall course work in the specified course.", |
984 "location": "path", | 1107 "location": "path", |
985 "required": true, | 1108 "required": true, |
986 "type": "string" | 1109 "type": "string" |
987 }, | 1110 }, |
988 "courseId": { | 1111 "courseId": { |
989 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", | 1112 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", |
990 "location": "path", | 1113 "location": "path", |
991 "required": true, | 1114 "required": true, |
992 "type": "string" | 1115 "type": "string" |
993 }, | 1116 }, |
994 "id": { | 1117 "late": { |
995 "description": "Identifier of the st
udent submission.", | 1118 "description": "Requested lateness v
alue. If specified, returned student submissions are\nrestricted by the requeste
d value.\nIf unspecified, submissions are returned regardless of `late` value.", |
996 "location": "path", | 1119 "enum": [ |
997 "required": true, | 1120 "LATE_VALUES_UNSPECIFIED", |
| 1121 "LATE_ONLY", |
| 1122 "NOT_LATE_ONLY" |
| 1123 ], |
| 1124 "location": "query", |
| 1125 "type": "string" |
| 1126 }, |
| 1127 "pageToken": { |
| 1128 "description": "nextPageToken\nvalue
returned from a previous\nlist call,\nindicating that the subsequent page of re
sults should be returned.\n\nThe list request\nmust be otherwise identical to th
e one that resulted in this token.", |
| 1129 "location": "query", |
| 1130 "type": "string" |
| 1131 }, |
| 1132 "pageSize": { |
| 1133 "description": "Maximum number of it
ems to return. Zero or unspecified indicates that the\nserver may assign a maxim
um.\n\nThe server may return fewer than the specified number of results.", |
| 1134 "format": "int32", |
| 1135 "location": "query", |
| 1136 "type": "integer" |
| 1137 }, |
| 1138 "states": { |
| 1139 "description": "Requested submission
states. If specified, returned student submissions\nmatch one of the specified
submission states.", |
| 1140 "enum": [ |
| 1141 "SUBMISSION_STATE_UNSPECIFIED", |
| 1142 "NEW", |
| 1143 "CREATED", |
| 1144 "TURNED_IN", |
| 1145 "RETURNED", |
| 1146 "RECLAIMED_BY_STUDENT" |
| 1147 ], |
| 1148 "location": "query", |
| 1149 "repeated": true, |
| 1150 "type": "string" |
| 1151 }, |
| 1152 "userId": { |
| 1153 "description": "Optional argument to
restrict returned student work to those owned by the\nstudent with the specifie
d identifier. The identifier can be one of the\nfollowing:\n\n* the numeric iden
tifier for the user\n* the email address of the user\n* the string literal `\"me
\"`, indicating the requesting user", |
| 1154 "location": "query", |
998 "type": "string" | 1155 "type": "string" |
999 } | 1156 } |
1000 }, | 1157 }, |
1001 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}:return", | 1158 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions", |
1002 "request": { | |
1003 "$ref": "ReturnStudentSubmissionRequest" | |
1004 }, | |
1005 "response": { | 1159 "response": { |
1006 "$ref": "Empty" | 1160 "$ref": "ListStudentSubmissionsResponse" |
1007 }, | 1161 }, |
1008 "scopes": [ | 1162 "scopes": [ |
1009 "https://www.googleapis.com/auth/classro
om.coursework.students" | 1163 "https://www.googleapis.com/auth/classro
om.coursework.me", |
| 1164 "https://www.googleapis.com/auth/classro
om.coursework.me.readonly", |
| 1165 "https://www.googleapis.com/auth/classro
om.coursework.students", |
| 1166 "https://www.googleapis.com/auth/classro
om.coursework.students.readonly", |
| 1167 "https://www.googleapis.com/auth/classro
om.student-submissions.me.readonly", |
| 1168 "https://www.googleapis.com/auth/classro
om.student-submissions.students.readonly" |
1010 ] | 1169 ] |
1011 }, | 1170 }, |
1012 "reclaim": { | 1171 "patch": { |
1013 "description": "Reclaims a student submissio
n on behalf of the student that owns it.\n\nReclaiming a student submission tran
sfers ownership of attached Drive\nfiles to the student and update the submissio
n state.\n\nOnly the student that owns the requested student submission may call
this\nmethod, and only for a student submission that has been turned in.\n\nThi
s request must be made by the Developer Console project of the\n[OAuth client ID
](https://support.google.com/cloud/answer/6158849) used to\ncreate the correspon
ding course work item.\n\nThis method returns the following error codes:\n\n* `P
ERMISSION_DENIED` if the requesting user is not permitted to access the\nrequest
ed course or course work, unsubmit the requested student submission,\nor for acc
ess errors.\n* `FAILED_PRECONDITION` if the student submission has not been turn
ed in.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the
requested course, course work, or student submission\ndoes not exist.", | 1172 "description": "Updates one or more fields o
f a student submission.\n\nSee google.classroom.v1.StudentSubmission for details
\nof which fields may be updated and who may change them.\n\nThis request must b
e made by the Developer Console project of the\n[OAuth client ID](https://suppor
t.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work
item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED
` if the requesting developer project did not create\nthe corresponding course w
ork, if the user is not permitted to make the\nrequested modification to the stu
dent submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is
malformed.\n* `NOT_FOUND` if the requested course, course work, or student submi
ssion\ndoes not exist.", |
1014 "httpMethod": "POST", | 1173 "httpMethod": "PATCH", |
1015 "id": "classroom.courses.courseWork.studentS
ubmissions.reclaim", | 1174 "id": "classroom.courses.courseWork.studentS
ubmissions.patch", |
1016 "parameterOrder": [ | 1175 "parameterOrder": [ |
1017 "courseId", | 1176 "courseId", |
1018 "courseWorkId", | 1177 "courseWorkId", |
1019 "id" | 1178 "id" |
1020 ], | 1179 ], |
1021 "parameters": { | 1180 "parameters": { |
1022 "courseWorkId": { | 1181 "courseWorkId": { |
1023 "description": "Identifier of the co
urse work.", | 1182 "description": "Identifier of the co
urse work.", |
1024 "location": "path", | 1183 "location": "path", |
1025 "required": true, | 1184 "required": true, |
1026 "type": "string" | 1185 "type": "string" |
1027 }, | 1186 }, |
1028 "courseId": { | 1187 "courseId": { |
1029 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", | 1188 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", |
1030 "location": "path", | 1189 "location": "path", |
1031 "required": true, | 1190 "required": true, |
1032 "type": "string" | 1191 "type": "string" |
1033 }, | 1192 }, |
1034 "id": { | 1193 "id": { |
1035 "description": "Identifier of the st
udent submission.", | 1194 "description": "Identifier of the st
udent submission.", |
1036 "location": "path", | 1195 "location": "path", |
1037 "required": true, | 1196 "required": true, |
1038 "type": "string" | 1197 "type": "string" |
| 1198 }, |
| 1199 "updateMask": { |
| 1200 "description": "Mask that identifies
which fields on the student submission to update.\nThis field is required to do
an update. The update fails if invalid\nfields are specified.\n\nThe following
fields may be specified by teachers:\n* `draft_grade`\n* `assigned_grade`", |
| 1201 "format": "google-fieldmask", |
| 1202 "location": "query", |
| 1203 "type": "string" |
1039 } | 1204 } |
1040 }, | 1205 }, |
1041 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}:reclaim", | 1206 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}", |
1042 "request": { | 1207 "request": { |
1043 "$ref": "ReclaimStudentSubmissionRequest
" | 1208 "$ref": "StudentSubmission" |
1044 }, | 1209 }, |
1045 "response": { | 1210 "response": { |
1046 "$ref": "Empty" | 1211 "$ref": "StudentSubmission" |
1047 }, | 1212 }, |
1048 "scopes": [ | 1213 "scopes": [ |
1049 "https://www.googleapis.com/auth/classro
om.coursework.me" | 1214 "https://www.googleapis.com/auth/classro
om.coursework.me", |
| 1215 "https://www.googleapis.com/auth/classro
om.coursework.students" |
1050 ] | 1216 ] |
1051 }, | 1217 }, |
1052 "turnIn": { | 1218 "get": { |
1053 "description": "Turns in a student submissio
n.\n\nTurning in a student submission transfers ownership of attached Drive\nfil
es to the teacher and may also update the submission state.\n\nThis may only be
called by the student that owns the specified student\nsubmission.\n\nThis reque
st must be made by the Developer Console project of the\n[OAuth client ID](https
://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding co
urse work item.\n\nThis method returns the following error codes:\n\n* `PERMISSI
ON_DENIED` if the requesting user is not permitted to access the\nrequested cour
se or course work, turn in the requested student submission,\nor for access erro
rs.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the req
uested course, course work, or student submission\ndoes not exist.", | 1219 "description": "Returns a student submission
.\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the
\nrequested course, course work, or student submission or for\naccess errors.\n*
`INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested
course, course work, or student submission\ndoes not exist.", |
1054 "httpMethod": "POST", | 1220 "httpMethod": "GET", |
1055 "id": "classroom.courses.courseWork.studentS
ubmissions.turnIn", | 1221 "id": "classroom.courses.courseWork.studentS
ubmissions.get", |
1056 "parameterOrder": [ | 1222 "parameterOrder": [ |
1057 "courseId", | 1223 "courseId", |
1058 "courseWorkId", | 1224 "courseWorkId", |
1059 "id" | 1225 "id" |
1060 ], | 1226 ], |
1061 "parameters": { | 1227 "parameters": { |
| 1228 "courseWorkId": { |
| 1229 "description": "Identifier of the co
urse work.", |
| 1230 "location": "path", |
| 1231 "required": true, |
| 1232 "type": "string" |
| 1233 }, |
1062 "courseId": { | 1234 "courseId": { |
1063 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", | 1235 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", |
1064 "location": "path", | 1236 "location": "path", |
1065 "required": true, | 1237 "required": true, |
1066 "type": "string" | 1238 "type": "string" |
1067 }, | 1239 }, |
1068 "id": { | 1240 "id": { |
1069 "description": "Identifier of the st
udent submission.", | 1241 "description": "Identifier of the st
udent submission.", |
1070 "location": "path", | 1242 "location": "path", |
1071 "required": true, | 1243 "required": true, |
1072 "type": "string" | 1244 "type": "string" |
1073 }, | 1245 } |
| 1246 }, |
| 1247 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}", |
| 1248 "response": { |
| 1249 "$ref": "StudentSubmission" |
| 1250 }, |
| 1251 "scopes": [ |
| 1252 "https://www.googleapis.com/auth/classro
om.coursework.me", |
| 1253 "https://www.googleapis.com/auth/classro
om.coursework.me.readonly", |
| 1254 "https://www.googleapis.com/auth/classro
om.coursework.students", |
| 1255 "https://www.googleapis.com/auth/classro
om.coursework.students.readonly", |
| 1256 "https://www.googleapis.com/auth/classro
om.student-submissions.me.readonly", |
| 1257 "https://www.googleapis.com/auth/classro
om.student-submissions.students.readonly" |
| 1258 ] |
| 1259 }, |
| 1260 "return": { |
| 1261 "description": "Returns a student submission
.\n\nReturning a student submission transfers ownership of attached Drive\nfiles
to the student and may also update the submission state.\nUnlike the Classroom
application, returning a student submission does not\nset assignedGrade to the d
raftGrade value.\n\nOnly a teacher of the course that contains the requested stu
dent submission\nmay call this method.\n\nThis request must be made by the Devel
oper Console project of the\n[OAuth client ID](https://support.google.com/cloud/
answer/6158849) used to\ncreate the corresponding course work item.\n\nThis meth
od returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting
user is not permitted to access the\nrequested course or course work, return th
e requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if
the request is malformed.\n* `NOT_FOUND` if the requested course, course work, o
r student submission\ndoes not exist.", |
| 1262 "httpMethod": "POST", |
| 1263 "id": "classroom.courses.courseWork.studentS
ubmissions.return", |
| 1264 "parameterOrder": [ |
| 1265 "courseId", |
| 1266 "courseWorkId", |
| 1267 "id" |
| 1268 ], |
| 1269 "parameters": { |
1074 "courseWorkId": { | 1270 "courseWorkId": { |
1075 "description": "Identifier of the co
urse work.", | 1271 "description": "Identifier of the co
urse work.", |
1076 "location": "path", | 1272 "location": "path", |
1077 "required": true, | 1273 "required": true, |
1078 "type": "string" | 1274 "type": "string" |
1079 } | |
1080 }, | |
1081 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}:turnIn", | |
1082 "request": { | |
1083 "$ref": "TurnInStudentSubmissionRequest" | |
1084 }, | |
1085 "response": { | |
1086 "$ref": "Empty" | |
1087 }, | |
1088 "scopes": [ | |
1089 "https://www.googleapis.com/auth/classro
om.coursework.me" | |
1090 ] | |
1091 }, | |
1092 "list": { | |
1093 "description": "Returns a list of student su
bmissions that the requester is permitted to\nview, factoring in the OAuth scope
s of the request.\n`-` may be specified as the `course_work_id` to include stude
nt\nsubmissions for multiple course work items.\n\nCourse students may only view
their own work. Course teachers\nand domain administrators may view all student
submissions.\n\nThis method returns the following error codes:\n\n* `PERMISSION
_DENIED` if the requesting user is not permitted to access the\nrequested course
or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is m
alformed.\n* `NOT_FOUND` if the requested course does not exist.", | |
1094 "httpMethod": "GET", | |
1095 "id": "classroom.courses.courseWork.studentS
ubmissions.list", | |
1096 "parameterOrder": [ | |
1097 "courseId", | |
1098 "courseWorkId" | |
1099 ], | |
1100 "parameters": { | |
1101 "pageSize": { | |
1102 "description": "Maximum number of it
ems to return. Zero or unspecified indicates that the\nserver may assign a maxim
um.\n\nThe server may return fewer than the specified number of results.", | |
1103 "format": "int32", | |
1104 "location": "query", | |
1105 "type": "integer" | |
1106 }, | |
1107 "states": { | |
1108 "description": "Requested submission
states. If specified, returned student submissions\nmatch one of the specified
submission states.", | |
1109 "enum": [ | |
1110 "SUBMISSION_STATE_UNSPECIFIED", | |
1111 "NEW", | |
1112 "CREATED", | |
1113 "TURNED_IN", | |
1114 "RETURNED", | |
1115 "RECLAIMED_BY_STUDENT" | |
1116 ], | |
1117 "location": "query", | |
1118 "repeated": true, | |
1119 "type": "string" | |
1120 }, | |
1121 "userId": { | |
1122 "description": "Optional argument to
restrict returned student work to those owned by the\nstudent with the specifie
d identifier. The identifier can be one of the\nfollowing:\n\n* the numeric iden
tifier for the user\n* the email address of the user\n* the string literal `\"me
\"`, indicating the requesting user", | |
1123 "location": "query", | |
1124 "type": "string" | |
1125 }, | |
1126 "courseWorkId": { | |
1127 "description": "Identifer of the stu
dent work to request.\nThis may be set to the string literal `\"-\"` to request
student work for\nall course work in the specified course.", | |
1128 "location": "path", | |
1129 "required": true, | |
1130 "type": "string" | |
1131 }, | 1275 }, |
1132 "courseId": { | 1276 "courseId": { |
1133 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", | 1277 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", |
1134 "location": "path", | 1278 "location": "path", |
1135 "required": true, | 1279 "required": true, |
1136 "type": "string" | 1280 "type": "string" |
1137 }, | 1281 }, |
1138 "late": { | 1282 "id": { |
1139 "description": "Requested lateness v
alue. If specified, returned student submissions are\nrestricted by the requeste
d value.\nIf unspecified, submissions are returned regardless of `late` value.", | 1283 "description": "Identifier of the st
udent submission.", |
1140 "enum": [ | 1284 "location": "path", |
1141 "LATE_VALUES_UNSPECIFIED", | 1285 "required": true, |
1142 "LATE_ONLY", | |
1143 "NOT_LATE_ONLY" | |
1144 ], | |
1145 "location": "query", | |
1146 "type": "string" | |
1147 }, | |
1148 "pageToken": { | |
1149 "description": "nextPageToken\nvalue
returned from a previous\nlist call,\nindicating that the subsequent page of re
sults should be returned.\n\nThe list request\nmust be otherwise identical to th
e one that resulted in this token.", | |
1150 "location": "query", | |
1151 "type": "string" | 1286 "type": "string" |
1152 } | 1287 } |
1153 }, | 1288 }, |
1154 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions", | 1289 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}:return", |
| 1290 "request": { |
| 1291 "$ref": "ReturnStudentSubmissionRequest" |
| 1292 }, |
1155 "response": { | 1293 "response": { |
1156 "$ref": "ListStudentSubmissionsResponse" | 1294 "$ref": "Empty" |
1157 }, | 1295 }, |
1158 "scopes": [ | 1296 "scopes": [ |
1159 "https://www.googleapis.com/auth/classro
om.coursework.me", | 1297 "https://www.googleapis.com/auth/classro
om.coursework.students" |
1160 "https://www.googleapis.com/auth/classro
om.coursework.me.readonly", | |
1161 "https://www.googleapis.com/auth/classro
om.coursework.students", | |
1162 "https://www.googleapis.com/auth/classro
om.coursework.students.readonly", | |
1163 "https://www.googleapis.com/auth/classro
om.student-submissions.me.readonly", | |
1164 "https://www.googleapis.com/auth/classro
om.student-submissions.students.readonly" | |
1165 ] | 1298 ] |
1166 }, | 1299 }, |
1167 "modifyAttachments": { | 1300 "reclaim": { |
1168 "description": "Modifies attachments of stud
ent submission.\n\nAttachments may only be added to student submissions belongin
g to course\nwork objects with a `workType` of `ASSIGNMENT`.\n\nThis request mus
t be made by the Developer Console project of the\n[OAuth client ID](https://sup
port.google.com/cloud/answer/6158849) used to\ncreate the corresponding course w
ork item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DEN
IED` if the requesting user is not permitted to access the\nrequested course or
course work, if the user is not permitted to modify\nattachments on the requeste
d student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the reques
t is malformed.\n* `NOT_FOUND` if the requested course, course work, or student
submission\ndoes not exist.", | 1301 "description": "Reclaims a student submissio
n on behalf of the student that owns it.\n\nReclaiming a student submission tran
sfers ownership of attached Drive\nfiles to the student and update the submissio
n state.\n\nOnly the student that owns the requested student submission may call
this\nmethod, and only for a student submission that has been turned in.\n\nThi
s request must be made by the Developer Console project of the\n[OAuth client ID
](https://support.google.com/cloud/answer/6158849) used to\ncreate the correspon
ding course work item.\n\nThis method returns the following error codes:\n\n* `P
ERMISSION_DENIED` if the requesting user is not permitted to access the\nrequest
ed course or course work, unsubmit the requested student submission,\nor for acc
ess errors.\n* `FAILED_PRECONDITION` if the student submission has not been turn
ed in.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the
requested course, course work, or student submission\ndoes not exist.", |
1169 "httpMethod": "POST", | 1302 "httpMethod": "POST", |
1170 "id": "classroom.courses.courseWork.studentS
ubmissions.modifyAttachments", | 1303 "id": "classroom.courses.courseWork.studentS
ubmissions.reclaim", |
1171 "parameterOrder": [ | 1304 "parameterOrder": [ |
1172 "courseId", | 1305 "courseId", |
1173 "courseWorkId", | 1306 "courseWorkId", |
1174 "id" | 1307 "id" |
1175 ], | 1308 ], |
1176 "parameters": { | 1309 "parameters": { |
1177 "courseWorkId": { | 1310 "courseWorkId": { |
1178 "description": "Identifier of the co
urse work.", | 1311 "description": "Identifier of the co
urse work.", |
1179 "location": "path", | 1312 "location": "path", |
1180 "required": true, | 1313 "required": true, |
1181 "type": "string" | 1314 "type": "string" |
1182 }, | 1315 }, |
1183 "courseId": { | 1316 "courseId": { |
1184 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", | 1317 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", |
1185 "location": "path", | 1318 "location": "path", |
1186 "required": true, | 1319 "required": true, |
1187 "type": "string" | 1320 "type": "string" |
1188 }, | 1321 }, |
1189 "id": { | 1322 "id": { |
1190 "description": "Identifier of the st
udent submission.", | 1323 "description": "Identifier of the st
udent submission.", |
1191 "location": "path", | 1324 "location": "path", |
1192 "required": true, | 1325 "required": true, |
1193 "type": "string" | 1326 "type": "string" |
1194 } | 1327 } |
1195 }, | 1328 }, |
1196 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}:modifyAttachments", | 1329 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}:reclaim", |
1197 "request": { | 1330 "request": { |
1198 "$ref": "ModifyAttachmentsRequest" | 1331 "$ref": "ReclaimStudentSubmissionRequest
" |
1199 }, | 1332 }, |
1200 "response": { | 1333 "response": { |
1201 "$ref": "StudentSubmission" | 1334 "$ref": "Empty" |
1202 }, | 1335 }, |
1203 "scopes": [ | 1336 "scopes": [ |
1204 "https://www.googleapis.com/auth/classro
om.coursework.me", | 1337 "https://www.googleapis.com/auth/classro
om.coursework.me" |
1205 "https://www.googleapis.com/auth/classro
om.coursework.students" | |
1206 ] | 1338 ] |
1207 } | 1339 } |
1208 } | 1340 } |
1209 } | 1341 } |
1210 } | 1342 } |
1211 }, | |
1212 "teachers": { | |
1213 "methods": { | |
1214 "create": { | |
1215 "description": "Creates a teacher of a course.\n\nTh
is method returns the following error codes:\n\n* `PERMISSION_DENIED` if the req
uesting user is not permitted to create\nteachers in this course or for access
errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRE
CONDITION` if the requested user's account is disabled,\nfor the following reque
st errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * Cou
rseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXIST
S` if the user is already a teacher or student in the\ncourse.", | |
1216 "httpMethod": "POST", | |
1217 "id": "classroom.courses.teachers.create", | |
1218 "parameterOrder": [ | |
1219 "courseId" | |
1220 ], | |
1221 "parameters": { | |
1222 "courseId": { | |
1223 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | |
1224 "location": "path", | |
1225 "required": true, | |
1226 "type": "string" | |
1227 } | |
1228 }, | |
1229 "path": "v1/courses/{courseId}/teachers", | |
1230 "request": { | |
1231 "$ref": "Teacher" | |
1232 }, | |
1233 "response": { | |
1234 "$ref": "Teacher" | |
1235 }, | |
1236 "scopes": [ | |
1237 "https://www.googleapis.com/auth/classroom.profi
le.emails", | |
1238 "https://www.googleapis.com/auth/classroom.profi
le.photos", | |
1239 "https://www.googleapis.com/auth/classroom.roste
rs" | |
1240 ] | |
1241 }, | |
1242 "delete": { | |
1243 "description": "Deletes a teacher of a course.\n\nTh
is method returns the following error codes:\n\n* `PERMISSION_DENIED` if the req
uesting user is not permitted to delete\nteachers of this course or for access e
rrors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if th
e\ncourse does not exist.\n* `FAILED_PRECONDITION` if the requested ID belongs t
o the primary teacher\nof this course.", | |
1244 "httpMethod": "DELETE", | |
1245 "id": "classroom.courses.teachers.delete", | |
1246 "parameterOrder": [ | |
1247 "courseId", | |
1248 "userId" | |
1249 ], | |
1250 "parameters": { | |
1251 "courseId": { | |
1252 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | |
1253 "location": "path", | |
1254 "required": true, | |
1255 "type": "string" | |
1256 }, | |
1257 "userId": { | |
1258 "description": "Identifier of the teacher to
delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifie
r for the user\n* the email address of the user\n* the string literal `\"me\"`,
indicating the requesting user", | |
1259 "location": "path", | |
1260 "required": true, | |
1261 "type": "string" | |
1262 } | |
1263 }, | |
1264 "path": "v1/courses/{courseId}/teachers/{userId}", | |
1265 "response": { | |
1266 "$ref": "Empty" | |
1267 }, | |
1268 "scopes": [ | |
1269 "https://www.googleapis.com/auth/classroom.roste
rs" | |
1270 ] | |
1271 }, | |
1272 "get": { | |
1273 "description": "Returns a teacher of a course.\n\nTh
is method returns the following error codes:\n\n* `PERMISSION_DENIED` if the req
uesting user is not permitted to view\nteachers of this course or for access err
ors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\
ncourse does not exist.", | |
1274 "httpMethod": "GET", | |
1275 "id": "classroom.courses.teachers.get", | |
1276 "parameterOrder": [ | |
1277 "courseId", | |
1278 "userId" | |
1279 ], | |
1280 "parameters": { | |
1281 "courseId": { | |
1282 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | |
1283 "location": "path", | |
1284 "required": true, | |
1285 "type": "string" | |
1286 }, | |
1287 "userId": { | |
1288 "description": "Identifier of the teacher to
return. The identifier can be one of the\nfollowing:\n\n* the numeric identifie
r for the user\n* the email address of the user\n* the string literal `\"me\"`,
indicating the requesting user", | |
1289 "location": "path", | |
1290 "required": true, | |
1291 "type": "string" | |
1292 } | |
1293 }, | |
1294 "path": "v1/courses/{courseId}/teachers/{userId}", | |
1295 "response": { | |
1296 "$ref": "Teacher" | |
1297 }, | |
1298 "scopes": [ | |
1299 "https://www.googleapis.com/auth/classroom.profi
le.emails", | |
1300 "https://www.googleapis.com/auth/classroom.profi
le.photos", | |
1301 "https://www.googleapis.com/auth/classroom.roste
rs", | |
1302 "https://www.googleapis.com/auth/classroom.roste
rs.readonly" | |
1303 ] | |
1304 }, | |
1305 "list": { | |
1306 "description": "Returns a list of teachers of this c
ourse that the requester\nis permitted to view.\n\nThis method returns the follo
wing error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_
DENIED` for access errors.", | |
1307 "httpMethod": "GET", | |
1308 "id": "classroom.courses.teachers.list", | |
1309 "parameterOrder": [ | |
1310 "courseId" | |
1311 ], | |
1312 "parameters": { | |
1313 "courseId": { | |
1314 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | |
1315 "location": "path", | |
1316 "required": true, | |
1317 "type": "string" | |
1318 }, | |
1319 "pageToken": { | |
1320 "description": "nextPageToken\nvalue returne
d from a previous\nlist call, indicating that\nthe subsequent page of results sh
ould be returned.\n\nThe list request must be\notherwise identical to the one th
at resulted in this token.", | |
1321 "location": "query", | |
1322 "type": "string" | |
1323 }, | |
1324 "pageSize": { | |
1325 "description": "Maximum number of items to r
eturn. Zero means no maximum.\n\nThe server may return fewer than the specified
number of results.", | |
1326 "format": "int32", | |
1327 "location": "query", | |
1328 "type": "integer" | |
1329 } | |
1330 }, | |
1331 "path": "v1/courses/{courseId}/teachers", | |
1332 "response": { | |
1333 "$ref": "ListTeachersResponse" | |
1334 }, | |
1335 "scopes": [ | |
1336 "https://www.googleapis.com/auth/classroom.profi
le.emails", | |
1337 "https://www.googleapis.com/auth/classroom.profi
le.photos", | |
1338 "https://www.googleapis.com/auth/classroom.roste
rs", | |
1339 "https://www.googleapis.com/auth/classroom.roste
rs.readonly" | |
1340 ] | |
1341 } | |
1342 } | |
1343 } | 1343 } |
1344 } | 1344 } |
1345 }, | 1345 }, |
1346 "userProfiles": { | 1346 "userProfiles": { |
1347 "methods": { | 1347 "methods": { |
1348 "get": { | 1348 "get": { |
1349 "description": "Returns a user profile.\n\nThis method retur
ns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is
not permitted to access\nthis user profile, if no profile exists with the reque
sted ID, or for\naccess errors.", | 1349 "description": "Returns a user profile.\n\nThis method retur
ns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is
not permitted to access\nthis user profile, if no profile exists with the reque
sted ID, or for\naccess errors.", |
1350 "httpMethod": "GET", | 1350 "httpMethod": "GET", |
1351 "id": "classroom.userProfiles.get", | 1351 "id": "classroom.userProfiles.get", |
1352 "parameterOrder": [ | 1352 "parameterOrder": [ |
(...skipping 23 matching lines...) Expand all Loading... |
1376 "guardianInvitations": { | 1376 "guardianInvitations": { |
1377 "methods": { | 1377 "methods": { |
1378 "list": { | 1378 "list": { |
1379 "description": "Returns a list of guardian invitatio
ns that the requesting user is\npermitted to view, filtered by the parameters pr
ovided.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIE
D` if a `student_id` is specified, and the requesting\n user is not permitted t
o view guardian invitations for that student, if\n `\"-\"` is specified as the
`student_id` and the user is not a domain\n administrator, if guardians are not
enabled for the domain in question,\n or for other access errors.\n* `INVALID_
ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized
(it is not an email address, nor a `student_id` from the\n API, nor the litera
l string `me`). May also be returned if an invalid\n `page_token` or `state` is
provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\
n recognized, but Classroom has no record of that student.", | 1379 "description": "Returns a list of guardian invitatio
ns that the requesting user is\npermitted to view, filtered by the parameters pr
ovided.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIE
D` if a `student_id` is specified, and the requesting\n user is not permitted t
o view guardian invitations for that student, if\n `\"-\"` is specified as the
`student_id` and the user is not a domain\n administrator, if guardians are not
enabled for the domain in question,\n or for other access errors.\n* `INVALID_
ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized
(it is not an email address, nor a `student_id` from the\n API, nor the litera
l string `me`). May also be returned if an invalid\n `page_token` or `state` is
provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\
n recognized, but Classroom has no record of that student.", |
1380 "httpMethod": "GET", | 1380 "httpMethod": "GET", |
1381 "id": "classroom.userProfiles.guardianInvitations.li
st", | 1381 "id": "classroom.userProfiles.guardianInvitations.li
st", |
1382 "parameterOrder": [ | 1382 "parameterOrder": [ |
1383 "studentId" | 1383 "studentId" |
1384 ], | 1384 ], |
1385 "parameters": { | 1385 "parameters": { |
| 1386 "studentId": { |
| 1387 "description": "The ID of the student whose
guardian invitations are to be returned.\nThe identifier can be one of the follo
wing:\n\n* the numeric identifier for the user\n* the email address of the user\
n* the string literal `\"me\"`, indicating the requesting user\n* the string lit
eral `\"-\"`, indicating that results should be returned for\n all students tha
t the requesting user is permitted to view guardian\n invitations.", |
| 1388 "location": "path", |
| 1389 "required": true, |
| 1390 "type": "string" |
| 1391 }, |
| 1392 "pageToken": { |
| 1393 "description": "nextPageToken\nvalue returne
d from a previous\nlist call,\nindicating that the subsequent page of results sh
ould be returned.\n\nThe list request\nmust be otherwise identical to the one th
at resulted in this token.", |
| 1394 "location": "query", |
| 1395 "type": "string" |
| 1396 }, |
1386 "invitedEmailAddress": { | 1397 "invitedEmailAddress": { |
1387 "description": "If specified, only results w
ith the specified `invited_email_address`\nwill be returned.", | 1398 "description": "If specified, only results w
ith the specified `invited_email_address`\nwill be returned.", |
1388 "location": "query", | 1399 "location": "query", |
1389 "type": "string" | 1400 "type": "string" |
1390 }, | 1401 }, |
1391 "states": { | 1402 "states": { |
1392 "description": "If specified, only results w
ith the specified `state` values will be\nreturned. Otherwise, results with a `s
tate` of `PENDING` will be returned.", | 1403 "description": "If specified, only results w
ith the specified `state` values will be\nreturned. Otherwise, results with a `s
tate` of `PENDING` will be returned.", |
1393 "enum": [ | 1404 "enum": [ |
1394 "GUARDIAN_INVITATION_STATE_UNSPECIFIED", | 1405 "GUARDIAN_INVITATION_STATE_UNSPECIFIED", |
1395 "PENDING", | 1406 "PENDING", |
1396 "COMPLETE" | 1407 "COMPLETE" |
1397 ], | 1408 ], |
1398 "location": "query", | 1409 "location": "query", |
1399 "repeated": true, | 1410 "repeated": true, |
1400 "type": "string" | 1411 "type": "string" |
1401 }, | 1412 }, |
1402 "pageSize": { | 1413 "pageSize": { |
1403 "description": "Maximum number of items to r
eturn. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nT
he server may return fewer than the specified number of results.", | 1414 "description": "Maximum number of items to r
eturn. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nT
he server may return fewer than the specified number of results.", |
1404 "format": "int32", | 1415 "format": "int32", |
1405 "location": "query", | 1416 "location": "query", |
1406 "type": "integer" | 1417 "type": "integer" |
1407 }, | |
1408 "studentId": { | |
1409 "description": "The ID of the student whose
guardian invitations are to be returned.\nThe identifier can be one of the follo
wing:\n\n* the numeric identifier for the user\n* the email address of the user\
n* the string literal `\"me\"`, indicating the requesting user\n* the string lit
eral `\"-\"`, indicating that results should be returned for\n all students tha
t the requesting user is permitted to view guardian\n invitations.", | |
1410 "location": "path", | |
1411 "required": true, | |
1412 "type": "string" | |
1413 }, | |
1414 "pageToken": { | |
1415 "description": "nextPageToken\nvalue returne
d from a previous\nlist call,\nindicating that the subsequent page of results sh
ould be returned.\n\nThe list request\nmust be otherwise identical to the one th
at resulted in this token.", | |
1416 "location": "query", | |
1417 "type": "string" | |
1418 } | 1418 } |
1419 }, | 1419 }, |
1420 "path": "v1/userProfiles/{studentId}/guardianInvitat
ions", | 1420 "path": "v1/userProfiles/{studentId}/guardianInvitat
ions", |
1421 "response": { | 1421 "response": { |
1422 "$ref": "ListGuardianInvitationsResponse" | 1422 "$ref": "ListGuardianInvitationsResponse" |
1423 }, | 1423 }, |
1424 "scopes": [ | 1424 "scopes": [ |
1425 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students", | 1425 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students", |
1426 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students.readonly" | 1426 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students.readonly" |
1427 ] | 1427 ] |
1428 }, | 1428 }, |
1429 "get": { | 1429 "get": { |
1430 "description": "Returns a specific guardian invitati
on.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` i
f the requesting user is not permitted to view\n guardian invitations for the s
tudent identified by the `student_id`, if\n guardians are not enabled for the d
omain in question, or for other\n access errors.\n* `INVALID_ARGUMENT` if a `st
udent_id` is specified, but its format cannot\n be recognized (it is not an ema
il address, nor a `student_id` from the\n API, nor the literal string `me`).\n*
`NOT_FOUND` if Classroom cannot find any record of the given student or\n `inv
itation_id`. May also be returned if the student exists, but the\n requesting u
ser does not have access to see that student.", | 1430 "description": "Returns a specific guardian invitati
on.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` i
f the requesting user is not permitted to view\n guardian invitations for the s
tudent identified by the `student_id`, if\n guardians are not enabled for the d
omain in question, or for other\n access errors.\n* `INVALID_ARGUMENT` if a `st
udent_id` is specified, but its format cannot\n be recognized (it is not an ema
il address, nor a `student_id` from the\n API, nor the literal string `me`).\n*
`NOT_FOUND` if Classroom cannot find any record of the given student or\n `inv
itation_id`. May also be returned if the student exists, but the\n requesting u
ser does not have access to see that student.", |
1431 "httpMethod": "GET", | 1431 "httpMethod": "GET", |
1432 "id": "classroom.userProfiles.guardianInvitations.ge
t", | 1432 "id": "classroom.userProfiles.guardianInvitations.ge
t", |
1433 "parameterOrder": [ | 1433 "parameterOrder": [ |
1434 "studentId", | 1434 "studentId", |
1435 "invitationId" | 1435 "invitationId" |
1436 ], | 1436 ], |
1437 "parameters": { | 1437 "parameters": { |
| 1438 "invitationId": { |
| 1439 "description": "The `id` field of the `Guard
ianInvitation` being requested.", |
| 1440 "location": "path", |
| 1441 "required": true, |
| 1442 "type": "string" |
| 1443 }, |
1438 "studentId": { | 1444 "studentId": { |
1439 "description": "The ID of the student whose
guardian invitation is being requested.", | 1445 "description": "The ID of the student whose
guardian invitation is being requested.", |
1440 "location": "path", | 1446 "location": "path", |
1441 "required": true, | 1447 "required": true, |
1442 "type": "string" | 1448 "type": "string" |
1443 }, | |
1444 "invitationId": { | |
1445 "description": "The `id` field of the `Guard
ianInvitation` being requested.", | |
1446 "location": "path", | |
1447 "required": true, | |
1448 "type": "string" | |
1449 } | 1449 } |
1450 }, | 1450 }, |
1451 "path": "v1/userProfiles/{studentId}/guardianInvitat
ions/{invitationId}", | 1451 "path": "v1/userProfiles/{studentId}/guardianInvitat
ions/{invitationId}", |
1452 "response": { | 1452 "response": { |
1453 "$ref": "GuardianInvitation" | 1453 "$ref": "GuardianInvitation" |
1454 }, | 1454 }, |
1455 "scopes": [ | 1455 "scopes": [ |
1456 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students", | 1456 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students", |
1457 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students.readonly" | 1457 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students.readonly" |
1458 ] | 1458 ] |
(...skipping 168 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1627 "https://www.googleapis.com/auth/classroom.guard
ianlinks.me.readonly", | 1627 "https://www.googleapis.com/auth/classroom.guard
ianlinks.me.readonly", |
1628 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students", | 1628 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students", |
1629 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students.readonly" | 1629 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students.readonly" |
1630 ] | 1630 ] |
1631 } | 1631 } |
1632 } | 1632 } |
1633 } | 1633 } |
1634 } | 1634 } |
1635 } | 1635 } |
1636 }, | 1636 }, |
1637 "revision": "20170520", | 1637 "revision": "20170606", |
1638 "rootUrl": "https://classroom.googleapis.com/", | 1638 "rootUrl": "https://classroom.googleapis.com/", |
1639 "schemas": { | 1639 "schemas": { |
| 1640 "TurnInStudentSubmissionRequest": { |
| 1641 "description": "Request to turn in a student submission.", |
| 1642 "id": "TurnInStudentSubmissionRequest", |
| 1643 "properties": {}, |
| 1644 "type": "object" |
| 1645 }, |
| 1646 "ListStudentSubmissionsResponse": { |
| 1647 "description": "Response when listing student submissions.", |
| 1648 "id": "ListStudentSubmissionsResponse", |
| 1649 "properties": { |
| 1650 "nextPageToken": { |
| 1651 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
| 1652 "type": "string" |
| 1653 }, |
| 1654 "studentSubmissions": { |
| 1655 "description": "Student work that matches the request.", |
| 1656 "items": { |
| 1657 "$ref": "StudentSubmission" |
| 1658 }, |
| 1659 "type": "array" |
| 1660 } |
| 1661 }, |
| 1662 "type": "object" |
| 1663 }, |
| 1664 "StudentSubmission": { |
| 1665 "description": "Student submission for course work.\n\nStudentSubmis
sion items are generated when a CourseWork item is created.\n\nStudentSubmission
s that have never been accessed (i.e. with `state` = NEW)\nmay not have a creati
on time or update time.", |
| 1666 "id": "StudentSubmission", |
| 1667 "properties": { |
| 1668 "creationTime": { |
| 1669 "description": "Creation time of this submission.\nThis may
be unset if the student has not accessed this item.\n\nRead-only.", |
| 1670 "format": "google-datetime", |
| 1671 "type": "string" |
| 1672 }, |
| 1673 "state": { |
| 1674 "description": "State of this submission.\n\nRead-only.", |
| 1675 "enum": [ |
| 1676 "SUBMISSION_STATE_UNSPECIFIED", |
| 1677 "NEW", |
| 1678 "CREATED", |
| 1679 "TURNED_IN", |
| 1680 "RETURNED", |
| 1681 "RECLAIMED_BY_STUDENT" |
| 1682 ], |
| 1683 "enumDescriptions": [ |
| 1684 "No state specified. This should never be returned.", |
| 1685 "The student has never accessed this submission. Attachm
ents are not\nreturned and timestamps is not set.", |
| 1686 "Has been created.", |
| 1687 "Has been turned in to the teacher.", |
| 1688 "Has been returned to the student.", |
| 1689 "Student chose to \"unsubmit\" the assignment." |
| 1690 ], |
| 1691 "type": "string" |
| 1692 }, |
| 1693 "userId": { |
| 1694 "description": "Identifier for the student that owns this su
bmission.\n\nRead-only.", |
| 1695 "type": "string" |
| 1696 }, |
| 1697 "courseWorkId": { |
| 1698 "description": "Identifier for the course work this correspo
nds to.\n\nRead-only.", |
| 1699 "type": "string" |
| 1700 }, |
| 1701 "courseId": { |
| 1702 "description": "Identifier of the course.\n\nRead-only.", |
| 1703 "type": "string" |
| 1704 }, |
| 1705 "id": { |
| 1706 "description": "Classroom-assigned Identifier for the studen
t submission.\nThis is unique among submissions for the relevant course work.\n\
nRead-only.", |
| 1707 "type": "string" |
| 1708 }, |
| 1709 "assignedGrade": { |
| 1710 "description": "Optional grade. If unset, no grade was set.\
nThis must be a non-negative integer value.\n\nThis may be modified only by cour
se teachers.", |
| 1711 "format": "double", |
| 1712 "type": "number" |
| 1713 }, |
| 1714 "multipleChoiceSubmission": { |
| 1715 "$ref": "MultipleChoiceSubmission", |
| 1716 "description": "Submission content when course_work_type is
MULTIPLE_CHOICE_QUESTION." |
| 1717 }, |
| 1718 "assignmentSubmission": { |
| 1719 "$ref": "AssignmentSubmission", |
| 1720 "description": "Submission content when course_work_type is
ASSIGNMENT ." |
| 1721 }, |
| 1722 "associatedWithDeveloper": { |
| 1723 "description": "Whether this student submission is associate
d with the Developer Console\nproject making the request.\n\nSee google.classroo
m.Work.CreateCourseWork for more\ndetails.\n\nRead-only.", |
| 1724 "type": "boolean" |
| 1725 }, |
| 1726 "shortAnswerSubmission": { |
| 1727 "$ref": "ShortAnswerSubmission", |
| 1728 "description": "Submission content when course_work_type is
SHORT_ANSWER_QUESTION." |
| 1729 }, |
| 1730 "updateTime": { |
| 1731 "description": "Last update time of this submission.\nThis m
ay be unset if the student has not accessed this item.\n\nRead-only.", |
| 1732 "format": "google-datetime", |
| 1733 "type": "string" |
| 1734 }, |
| 1735 "alternateLink": { |
| 1736 "description": "Absolute link to the submission in the Class
room web UI.\n\nRead-only.", |
| 1737 "type": "string" |
| 1738 }, |
| 1739 "late": { |
| 1740 "description": "Whether this submission is late.\n\nRead-onl
y.", |
| 1741 "type": "boolean" |
| 1742 }, |
| 1743 "draftGrade": { |
| 1744 "description": "Optional pending grade. If unset, no grade w
as set.\nThis must be a non-negative integer value.\n\nThis is only visible to a
nd modifiable by course teachers.", |
| 1745 "format": "double", |
| 1746 "type": "number" |
| 1747 }, |
| 1748 "courseWorkType": { |
| 1749 "description": "Type of course work this submission is for.\
n\nRead-only.", |
| 1750 "enum": [ |
| 1751 "COURSE_WORK_TYPE_UNSPECIFIED", |
| 1752 "ASSIGNMENT", |
| 1753 "SHORT_ANSWER_QUESTION", |
| 1754 "MULTIPLE_CHOICE_QUESTION" |
| 1755 ], |
| 1756 "enumDescriptions": [ |
| 1757 "No work type specified. This is never returned.", |
| 1758 "An assignment.", |
| 1759 "A short answer question.", |
| 1760 "A multiple-choice question." |
| 1761 ], |
| 1762 "type": "string" |
| 1763 } |
| 1764 }, |
| 1765 "type": "object" |
| 1766 }, |
| 1767 "ModifyAttachmentsRequest": { |
| 1768 "description": "Request to modify the attachments of a student submi
ssion.", |
| 1769 "id": "ModifyAttachmentsRequest", |
| 1770 "properties": { |
| 1771 "addAttachments": { |
| 1772 "description": "Attachments to add.\nA student submission ma
y not have more than 20 attachments.\n\nForm attachments are not supported.", |
| 1773 "items": { |
| 1774 "$ref": "Attachment" |
| 1775 }, |
| 1776 "type": "array" |
| 1777 } |
| 1778 }, |
| 1779 "type": "object" |
| 1780 }, |
| 1781 "ListCourseWorkResponse": { |
| 1782 "description": "Response when listing course work.", |
| 1783 "id": "ListCourseWorkResponse", |
| 1784 "properties": { |
| 1785 "nextPageToken": { |
| 1786 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
| 1787 "type": "string" |
| 1788 }, |
| 1789 "courseWork": { |
| 1790 "description": "Course work items that match the request.", |
| 1791 "items": { |
| 1792 "$ref": "CourseWork" |
| 1793 }, |
| 1794 "type": "array" |
| 1795 } |
| 1796 }, |
| 1797 "type": "object" |
| 1798 }, |
| 1799 "YouTubeVideo": { |
| 1800 "description": "YouTube video item.", |
| 1801 "id": "YouTubeVideo", |
| 1802 "properties": { |
| 1803 "title": { |
| 1804 "description": "Title of the YouTube video.\n\nRead-only.", |
| 1805 "type": "string" |
| 1806 }, |
| 1807 "alternateLink": { |
| 1808 "description": "URL that can be used to view the YouTube vid
eo.\n\nRead-only.", |
| 1809 "type": "string" |
| 1810 }, |
| 1811 "thumbnailUrl": { |
| 1812 "description": "URL of a thumbnail image of the YouTube vide
o.\n\nRead-only.", |
| 1813 "type": "string" |
| 1814 }, |
| 1815 "id": { |
| 1816 "description": "YouTube API resource ID.", |
| 1817 "type": "string" |
| 1818 } |
| 1819 }, |
| 1820 "type": "object" |
| 1821 }, |
| 1822 "ListInvitationsResponse": { |
| 1823 "description": "Response when listing invitations.", |
| 1824 "id": "ListInvitationsResponse", |
| 1825 "properties": { |
| 1826 "nextPageToken": { |
| 1827 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
| 1828 "type": "string" |
| 1829 }, |
| 1830 "invitations": { |
| 1831 "description": "Invitations that match the list request.", |
| 1832 "items": { |
| 1833 "$ref": "Invitation" |
| 1834 }, |
| 1835 "type": "array" |
| 1836 } |
| 1837 }, |
| 1838 "type": "object" |
| 1839 }, |
| 1840 "GuardianInvitation": { |
| 1841 "description": "An invitation to become the guardian of a specified
user, sent to a specified\nemail address.", |
| 1842 "id": "GuardianInvitation", |
| 1843 "properties": { |
| 1844 "invitedEmailAddress": { |
| 1845 "description": "Email address that the invitation was sent t
o.\nThis field is only visible to domain administrators.", |
| 1846 "type": "string" |
| 1847 }, |
| 1848 "creationTime": { |
| 1849 "description": "The time that this invitation was created.\n
\nRead-only.", |
| 1850 "format": "google-datetime", |
| 1851 "type": "string" |
| 1852 }, |
| 1853 "invitationId": { |
| 1854 "description": "Unique identifier for this invitation.\n\nRe
ad-only.", |
| 1855 "type": "string" |
| 1856 }, |
| 1857 "studentId": { |
| 1858 "description": "ID of the student (in standard format)", |
| 1859 "type": "string" |
| 1860 }, |
| 1861 "state": { |
| 1862 "description": "The state that this invitation is in.", |
| 1863 "enum": [ |
| 1864 "GUARDIAN_INVITATION_STATE_UNSPECIFIED", |
| 1865 "PENDING", |
| 1866 "COMPLETE" |
| 1867 ], |
| 1868 "enumDescriptions": [ |
| 1869 "Should never be returned.", |
| 1870 "The invitation is active and awaiting a response.", |
| 1871 "The invitation is no longer active. It may have been ac
cepted, declined,\nwithdrawn or it may have expired." |
| 1872 ], |
| 1873 "type": "string" |
| 1874 } |
| 1875 }, |
| 1876 "type": "object" |
| 1877 }, |
| 1878 "Attachment": { |
| 1879 "description": "Attachment added to student assignment work.\n\nWhen
creating attachments, setting the `form` field is not supported.", |
| 1880 "id": "Attachment", |
| 1881 "properties": { |
| 1882 "driveFile": { |
| 1883 "$ref": "DriveFile", |
| 1884 "description": "Google Drive file attachment." |
| 1885 }, |
| 1886 "youTubeVideo": { |
| 1887 "$ref": "YouTubeVideo", |
| 1888 "description": "Youtube video attachment." |
| 1889 }, |
| 1890 "form": { |
| 1891 "$ref": "Form", |
| 1892 "description": "Google Forms attachment." |
| 1893 }, |
| 1894 "link": { |
| 1895 "$ref": "Link", |
| 1896 "description": "Link attachment." |
| 1897 } |
| 1898 }, |
| 1899 "type": "object" |
| 1900 }, |
| 1901 "CourseMaterialSet": { |
| 1902 "description": "A set of materials that appears on the \"About\" pag
e of the course.\nThese materials might include a syllabus, schedule, or other b
ackground\ninformation relating to the course as a whole.", |
| 1903 "id": "CourseMaterialSet", |
| 1904 "properties": { |
| 1905 "title": { |
| 1906 "description": "Title for this set.", |
| 1907 "type": "string" |
| 1908 }, |
| 1909 "materials": { |
| 1910 "description": "Materials attached to this set.", |
| 1911 "items": { |
| 1912 "$ref": "CourseMaterial" |
| 1913 }, |
| 1914 "type": "array" |
| 1915 } |
| 1916 }, |
| 1917 "type": "object" |
| 1918 }, |
| 1919 "TimeOfDay": { |
| 1920 "description": "Represents a time of day. The date and time zone are
either not significant\nor are specified elsewhere. An API may choose to allow
leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp
`.", |
| 1921 "id": "TimeOfDay", |
| 1922 "properties": { |
| 1923 "nanos": { |
| 1924 "description": "Fractions of seconds in nanoseconds. Must be
from 0 to 999,999,999.", |
| 1925 "format": "int32", |
| 1926 "type": "integer" |
| 1927 }, |
| 1928 "seconds": { |
| 1929 "description": "Seconds of minutes of the time. Must normall
y be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.", |
| 1930 "format": "int32", |
| 1931 "type": "integer" |
| 1932 }, |
| 1933 "minutes": { |
| 1934 "description": "Minutes of hour of day. Must be from 0 to 59
.", |
| 1935 "format": "int32", |
| 1936 "type": "integer" |
| 1937 }, |
| 1938 "hours": { |
| 1939 "description": "Hours of day in 24 hour format. Should be fr
om 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios lik
e business closing time.", |
| 1940 "format": "int32", |
| 1941 "type": "integer" |
| 1942 } |
| 1943 }, |
| 1944 "type": "object" |
| 1945 }, |
| 1946 "ListCoursesResponse": { |
| 1947 "description": "Response when listing courses.", |
| 1948 "id": "ListCoursesResponse", |
| 1949 "properties": { |
| 1950 "nextPageToken": { |
| 1951 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
| 1952 "type": "string" |
| 1953 }, |
| 1954 "courses": { |
| 1955 "description": "Courses that match the list request.", |
| 1956 "items": { |
| 1957 "$ref": "Course" |
| 1958 }, |
| 1959 "type": "array" |
| 1960 } |
| 1961 }, |
| 1962 "type": "object" |
| 1963 }, |
| 1964 "Form": { |
| 1965 "description": "Google Forms item.", |
| 1966 "id": "Form", |
| 1967 "properties": { |
| 1968 "thumbnailUrl": { |
| 1969 "description": "URL of a thumbnail image of the Form.\n\nRea
d-only.", |
| 1970 "type": "string" |
| 1971 }, |
| 1972 "responseUrl": { |
| 1973 "description": "URL of the form responses document.\nOnly se
t if respsonses have been recorded and only when the\nrequesting user is an edit
or of the form.\n\nRead-only.", |
| 1974 "type": "string" |
| 1975 }, |
| 1976 "formUrl": { |
| 1977 "description": "URL of the form.", |
| 1978 "type": "string" |
| 1979 }, |
| 1980 "title": { |
| 1981 "description": "Title of the Form.\n\nRead-only.", |
| 1982 "type": "string" |
| 1983 } |
| 1984 }, |
| 1985 "type": "object" |
| 1986 }, |
| 1987 "ListTeachersResponse": { |
| 1988 "description": "Response when listing teachers.", |
| 1989 "id": "ListTeachersResponse", |
| 1990 "properties": { |
| 1991 "teachers": { |
| 1992 "description": "Teachers who match the list request.", |
| 1993 "items": { |
| 1994 "$ref": "Teacher" |
| 1995 }, |
| 1996 "type": "array" |
| 1997 }, |
| 1998 "nextPageToken": { |
| 1999 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
| 2000 "type": "string" |
| 2001 } |
| 2002 }, |
| 2003 "type": "object" |
| 2004 }, |
| 2005 "Link": { |
| 2006 "description": "URL item.", |
| 2007 "id": "Link", |
| 2008 "properties": { |
| 2009 "title": { |
| 2010 "description": "Title of the target of the URL.\n\nRead-only
.", |
| 2011 "type": "string" |
| 2012 }, |
| 2013 "thumbnailUrl": { |
| 2014 "description": "URL of a thumbnail image of the target URL.\
n\nRead-only.", |
| 2015 "type": "string" |
| 2016 }, |
| 2017 "url": { |
| 2018 "description": "URL to link to.\nThis must be a valid UTF-8
string containing between 1 and 2024 characters.", |
| 2019 "type": "string" |
| 2020 } |
| 2021 }, |
| 2022 "type": "object" |
| 2023 }, |
| 2024 "ListGuardiansResponse": { |
| 2025 "description": "Response when listing guardians.", |
| 2026 "id": "ListGuardiansResponse", |
| 2027 "properties": { |
| 2028 "guardians": { |
| 2029 "description": "Guardians on this page of results that met t
he criteria specified in\nthe request.", |
| 2030 "items": { |
| 2031 "$ref": "Guardian" |
| 2032 }, |
| 2033 "type": "array" |
| 2034 }, |
| 2035 "nextPageToken": { |
| 2036 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
| 2037 "type": "string" |
| 2038 } |
| 2039 }, |
| 2040 "type": "object" |
| 2041 }, |
| 2042 "ListGuardianInvitationsResponse": { |
| 2043 "description": "Response when listing guardian invitations.", |
| 2044 "id": "ListGuardianInvitationsResponse", |
| 2045 "properties": { |
| 2046 "guardianInvitations": { |
| 2047 "description": "Guardian invitations that matched the list r
equest.", |
| 2048 "items": { |
| 2049 "$ref": "GuardianInvitation" |
| 2050 }, |
| 2051 "type": "array" |
| 2052 }, |
| 2053 "nextPageToken": { |
| 2054 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
| 2055 "type": "string" |
| 2056 } |
| 2057 }, |
| 2058 "type": "object" |
| 2059 }, |
| 2060 "ListCourseAliasesResponse": { |
| 2061 "description": "Response when listing course aliases.", |
| 2062 "id": "ListCourseAliasesResponse", |
| 2063 "properties": { |
| 2064 "aliases": { |
| 2065 "description": "The course aliases.", |
| 2066 "items": { |
| 2067 "$ref": "CourseAlias" |
| 2068 }, |
| 2069 "type": "array" |
| 2070 }, |
| 2071 "nextPageToken": { |
| 2072 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
| 2073 "type": "string" |
| 2074 } |
| 2075 }, |
| 2076 "type": "object" |
| 2077 }, |
| 2078 "CourseAlias": { |
| 2079 "description": "Alternative identifier for a course.\n\nAn alias uni
quely identifies a course. It must be unique within one of the\nfollowing scopes
:\n\n* domain: A domain-scoped alias is visible to all users within the alias\nc
reator's domain and can be created only by a domain admin. A domain-scoped\nalia
s is often used when a course has an identifier external to Classroom.\n\n* proj
ect: A project-scoped alias is visible to any request from an\napplication using
the Developer Console project ID that created the alias\nand can be created by
any project. A project-scoped alias is often used when\nan application has alter
native identifiers. A random value can also be used\nto avoid duplicate courses
in the event of transmission failures, as retrying\na request will return `ALREA
DY_EXISTS` if a previous one has succeeded.", |
| 2080 "id": "CourseAlias", |
| 2081 "properties": { |
| 2082 "alias": { |
| 2083 "description": "Alias string. The format of the string indic
ates the desired alias scoping.\n\n* `d:<name>` indicates a domain-scoped alias.
\n Example: `d:math_101`\n* `p:<name>` indicates a project-scoped alias.\n Exa
mple: `p:abc123`\n\nThis field has a maximum length of 256 characters.", |
| 2084 "type": "string" |
| 2085 } |
| 2086 }, |
| 2087 "type": "object" |
| 2088 }, |
| 2089 "Date": { |
| 2090 "description": "Represents a whole calendar date, e.g. date of birth
. The time of day and\ntime zone are either specified elsewhere or are not signi
ficant. The date\nis relative to the Proleptic Gregorian Calendar. The day may b
e 0 to\nrepresent a year and month where the day is not significant, e.g. credit
card\nexpiration date. The year may be 0 to represent a month and day independe
nt\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand
`google.protobuf.Timestamp`.", |
| 2091 "id": "Date", |
| 2092 "properties": { |
| 2093 "year": { |
| 2094 "description": "Year of date. Must be from 1 to 9999, or 0 i
f specifying a date without\na year.", |
| 2095 "format": "int32", |
| 2096 "type": "integer" |
| 2097 }, |
| 2098 "day": { |
| 2099 "description": "Day of month. Must be from 1 to 31 and valid
for the year and month, or 0\nif specifying a year/month where the day is not s
ignificant.", |
| 2100 "format": "int32", |
| 2101 "type": "integer" |
| 2102 }, |
| 2103 "month": { |
| 2104 "description": "Month of year. Must be from 1 to 12.", |
| 2105 "format": "int32", |
| 2106 "type": "integer" |
| 2107 } |
| 2108 }, |
| 2109 "type": "object" |
| 2110 }, |
| 2111 "MultipleChoiceSubmission": { |
| 2112 "description": "Student work for a multiple-choice question.", |
| 2113 "id": "MultipleChoiceSubmission", |
| 2114 "properties": { |
| 2115 "answer": { |
| 2116 "description": "Student's select choice.", |
| 2117 "type": "string" |
| 2118 } |
| 2119 }, |
| 2120 "type": "object" |
| 2121 }, |
1640 "Name": { | 2122 "Name": { |
1641 "description": "Details of the user's name.", | 2123 "description": "Details of the user's name.", |
1642 "id": "Name", | 2124 "id": "Name", |
1643 "properties": { | 2125 "properties": { |
1644 "givenName": { | 2126 "givenName": { |
1645 "description": "The user's first name.\n\nRead-only.", | 2127 "description": "The user's first name.\n\nRead-only.", |
1646 "type": "string" | 2128 "type": "string" |
1647 }, | 2129 }, |
1648 "familyName": { | 2130 "familyName": { |
1649 "description": "The user's last name.\n\nRead-only.", | 2131 "description": "The user's last name.\n\nRead-only.", |
(...skipping 89 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1739 }, | 2221 }, |
1740 "Course": { | 2222 "Course": { |
1741 "description": "A Course in Classroom.", | 2223 "description": "A Course in Classroom.", |
1742 "id": "Course", | 2224 "id": "Course", |
1743 "properties": { | 2225 "properties": { |
1744 "updateTime": { | 2226 "updateTime": { |
1745 "description": "Time of the most recent update to this cours
e.\nSpecifying this field in a course update mask results in an error.\n\nRead-o
nly.", | 2227 "description": "Time of the most recent update to this cours
e.\nSpecifying this field in a course update mask results in an error.\n\nRead-o
nly.", |
1746 "format": "google-datetime", | 2228 "format": "google-datetime", |
1747 "type": "string" | 2229 "type": "string" |
1748 }, | 2230 }, |
| 2231 "calendarId": { |
| 2232 "description": "The Calendar ID for a calendar that all cour
se members can see, to which\nClassroom adds events for course work and announce
ments in the course.\n\nRead-only.", |
| 2233 "type": "string" |
| 2234 }, |
1749 "alternateLink": { | 2235 "alternateLink": { |
1750 "description": "Absolute link to this course in the Classroo
m web UI.\n\nRead-only.", | 2236 "description": "Absolute link to this course in the Classroo
m web UI.\n\nRead-only.", |
1751 "type": "string" | 2237 "type": "string" |
1752 }, | 2238 }, |
1753 "guardiansEnabled": { | 2239 "guardiansEnabled": { |
1754 "description": "Whether or not guardian notifications are en
abled for this course.\n\nRead-only.", | 2240 "description": "Whether or not guardian notifications are en
abled for this course.\n\nRead-only.", |
1755 "type": "boolean" | 2241 "type": "boolean" |
1756 }, | 2242 }, |
1757 "courseState": { | 2243 "courseState": { |
1758 "description": "State of the course.\nIf unspecified, the de
fault state is `PROVISIONED`.", | 2244 "description": "State of the course.\nIf unspecified, the de
fault state is `PROVISIONED`.", |
(...skipping 90 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1849 "description": "Title of the Drive item.\n\nRead-only.", | 2335 "description": "Title of the Drive item.\n\nRead-only.", |
1850 "type": "string" | 2336 "type": "string" |
1851 }, | 2337 }, |
1852 "alternateLink": { | 2338 "alternateLink": { |
1853 "description": "URL that can be used to access the Drive ite
m.\n\nRead-only.", | 2339 "description": "URL that can be used to access the Drive ite
m.\n\nRead-only.", |
1854 "type": "string" | 2340 "type": "string" |
1855 } | 2341 } |
1856 }, | 2342 }, |
1857 "type": "object" | 2343 "type": "object" |
1858 }, | 2344 }, |
| 2345 "ReturnStudentSubmissionRequest": { |
| 2346 "description": "Request to return a student submission.", |
| 2347 "id": "ReturnStudentSubmissionRequest", |
| 2348 "properties": {}, |
| 2349 "type": "object" |
| 2350 }, |
1859 "GlobalPermission": { | 2351 "GlobalPermission": { |
1860 "description": "Global user permission description.", | 2352 "description": "Global user permission description.", |
1861 "id": "GlobalPermission", | 2353 "id": "GlobalPermission", |
1862 "properties": { | 2354 "properties": { |
1863 "permission": { | 2355 "permission": { |
1864 "description": "Permission value.", | 2356 "description": "Permission value.", |
1865 "enum": [ | 2357 "enum": [ |
1866 "PERMISSION_UNSPECIFIED", | 2358 "PERMISSION_UNSPECIFIED", |
1867 "CREATE_COURSE" | 2359 "CREATE_COURSE" |
1868 ], | 2360 ], |
1869 "enumDescriptions": [ | 2361 "enumDescriptions": [ |
1870 "No permission is specified. This is not returned and is
not a\nvalid value.", | 2362 "No permission is specified. This is not returned and is
not a\nvalid value.", |
1871 "User is permitted to create a course." | 2363 "User is permitted to create a course." |
1872 ], | 2364 ], |
1873 "type": "string" | 2365 "type": "string" |
1874 } | 2366 } |
1875 }, | 2367 }, |
1876 "type": "object" | 2368 "type": "object" |
1877 }, | 2369 }, |
1878 "ReturnStudentSubmissionRequest": { | |
1879 "description": "Request to return a student submission.", | |
1880 "id": "ReturnStudentSubmissionRequest", | |
1881 "properties": {}, | |
1882 "type": "object" | |
1883 }, | |
1884 "Teacher": { | 2370 "Teacher": { |
1885 "description": "Teacher of a course.", | 2371 "description": "Teacher of a course.", |
1886 "id": "Teacher", | 2372 "id": "Teacher", |
1887 "properties": { | 2373 "properties": { |
1888 "courseId": { | |
1889 "description": "Identifier of the course.\n\nRead-only.", | |
1890 "type": "string" | |
1891 }, | |
1892 "profile": { | 2374 "profile": { |
1893 "$ref": "UserProfile", | 2375 "$ref": "UserProfile", |
1894 "description": "Global user information for the teacher.\n\n
Read-only." | 2376 "description": "Global user information for the teacher.\n\n
Read-only." |
1895 }, | 2377 }, |
1896 "userId": { | 2378 "userId": { |
1897 "description": "Identifier of the user.\n\nWhen specified as
a parameter of a request, this identifier can be one of\nthe following:\n\n* th
e numeric identifier for the user\n* the email address of the user\n* the string
literal `\"me\"`, indicating the requesting user", | 2379 "description": "Identifier of the user.\n\nWhen specified as
a parameter of a request, this identifier can be one of\nthe following:\n\n* th
e numeric identifier for the user\n* the email address of the user\n* the string
literal `\"me\"`, indicating the requesting user", |
1898 "type": "string" | 2380 "type": "string" |
| 2381 }, |
| 2382 "courseId": { |
| 2383 "description": "Identifier of the course.\n\nRead-only.", |
| 2384 "type": "string" |
1899 } | 2385 } |
1900 }, | 2386 }, |
1901 "type": "object" | 2387 "type": "object" |
1902 }, | 2388 }, |
1903 "ReclaimStudentSubmissionRequest": { | 2389 "ReclaimStudentSubmissionRequest": { |
1904 "description": "Request to reclaim a student submission.", | 2390 "description": "Request to reclaim a student submission.", |
1905 "id": "ReclaimStudentSubmissionRequest", | 2391 "id": "ReclaimStudentSubmissionRequest", |
1906 "properties": {}, | 2392 "properties": {}, |
1907 "type": "object" | 2393 "type": "object" |
1908 }, | 2394 }, |
1909 "AssignmentSubmission": { | 2395 "AssignmentSubmission": { |
1910 "description": "Student work for an assignment.", | 2396 "description": "Student work for an assignment.", |
1911 "id": "AssignmentSubmission", | 2397 "id": "AssignmentSubmission", |
1912 "properties": { | 2398 "properties": { |
1913 "attachments": { | 2399 "attachments": { |
1914 "description": "Attachments added by the student.\nDrive fil
es that correspond to materials with a share mode of\nSTUDENT_COPY may not exist
yet if the student has not accessed the\nassignment in Classroom.\n\nSome attac
hment metadata is only populated if the requesting user has\npermission to acces
s it. Identifier and alternate_link fields are always\navailable, but others (e.
g. title) may not be.", | 2400 "description": "Attachments added by the student.\nDrive fil
es that correspond to materials with a share mode of\nSTUDENT_COPY may not exist
yet if the student has not accessed the\nassignment in Classroom.\n\nSome attac
hment metadata is only populated if the requesting user has\npermission to acces
s it. Identifier and alternate_link fields are always\navailable, but others (e.
g. title) may not be.", |
1915 "items": { | 2401 "items": { |
1916 "$ref": "Attachment" | 2402 "$ref": "Attachment" |
1917 }, | 2403 }, |
1918 "type": "array" | 2404 "type": "array" |
1919 } | 2405 } |
1920 }, | 2406 }, |
1921 "type": "object" | 2407 "type": "object" |
1922 }, | 2408 }, |
1923 "Material": { | 2409 "Material": { |
1924 "description": "Material attached to course work.\n\nWhen creating a
ttachments, setting the `form` field is not supported.", | 2410 "description": "Material attached to course work.\n\nWhen creating a
ttachments, setting the `form` field is not supported.", |
1925 "id": "Material", | 2411 "id": "Material", |
1926 "properties": { | 2412 "properties": { |
| 2413 "driveFile": { |
| 2414 "$ref": "SharedDriveFile", |
| 2415 "description": "Google Drive file material." |
| 2416 }, |
| 2417 "form": { |
| 2418 "$ref": "Form", |
| 2419 "description": "Google Forms material." |
| 2420 }, |
| 2421 "link": { |
| 2422 "$ref": "Link", |
| 2423 "description": "Link material. On creation, will be upgraded
to a more appropriate type\nif possible, and this will be reflected in the resp
onse." |
| 2424 }, |
1927 "youtubeVideo": { | 2425 "youtubeVideo": { |
1928 "$ref": "YouTubeVideo", | 2426 "$ref": "YouTubeVideo", |
1929 "description": "YouTube video material." | 2427 "description": "YouTube video material." |
1930 }, | |
1931 "driveFile": { | |
1932 "$ref": "SharedDriveFile", | |
1933 "description": "Google Drive file material." | |
1934 }, | |
1935 "form": { | |
1936 "$ref": "Form", | |
1937 "description": "Google Forms material." | |
1938 }, | |
1939 "link": { | |
1940 "$ref": "Link", | |
1941 "description": "Link material. On creation, will be upgraded
to a more appropriate type\nif possible, and this will be reflected in the resp
onse." | |
1942 } | 2428 } |
1943 }, | 2429 }, |
1944 "type": "object" | 2430 "type": "object" |
1945 }, | 2431 }, |
1946 "CourseWork": { | 2432 "CourseWork": { |
1947 "description": "Course work created by a teacher for students of the
course.", | 2433 "description": "Course work created by a teacher for students of the
course.", |
1948 "id": "CourseWork", | 2434 "id": "CourseWork", |
1949 "properties": { | 2435 "properties": { |
| 2436 "materials": { |
| 2437 "description": "Additional materials.\n\nCourseWork must hav
e no more than 20 material items.", |
| 2438 "items": { |
| 2439 "$ref": "Material" |
| 2440 }, |
| 2441 "type": "array" |
| 2442 }, |
| 2443 "associatedWithDeveloper": { |
| 2444 "description": "Whether this course work item is associated
with the Developer Console\nproject making the request.\n\nSee google.classroom.
Work.CreateCourseWork for more\ndetails.\n\nRead-only.", |
| 2445 "type": "boolean" |
| 2446 }, |
| 2447 "updateTime": { |
| 2448 "description": "Timestamp of the most recent change to this
course work.\n\nRead-only.", |
| 2449 "format": "google-datetime", |
| 2450 "type": "string" |
| 2451 }, |
| 2452 "alternateLink": { |
| 2453 "description": "Absolute link to this course work in the Cla
ssroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only."
, |
| 2454 "type": "string" |
| 2455 }, |
| 2456 "maxPoints": { |
| 2457 "description": "Maximum grade for this course work.\nIf zero
or unspecified, this assignment is considered ungraded.\nThis must be a non-neg
ative integer value.", |
| 2458 "format": "double", |
| 2459 "type": "number" |
| 2460 }, |
| 2461 "workType": { |
| 2462 "description": "Type of this course work.\n\nThe type is set
when the course work is created and cannot be changed.", |
| 2463 "enum": [ |
| 2464 "COURSE_WORK_TYPE_UNSPECIFIED", |
| 2465 "ASSIGNMENT", |
| 2466 "SHORT_ANSWER_QUESTION", |
| 2467 "MULTIPLE_CHOICE_QUESTION" |
| 2468 ], |
| 2469 "enumDescriptions": [ |
| 2470 "No work type specified. This is never returned.", |
| 2471 "An assignment.", |
| 2472 "A short answer question.", |
| 2473 "A multiple-choice question." |
| 2474 ], |
| 2475 "type": "string" |
| 2476 }, |
| 2477 "assignment": { |
| 2478 "$ref": "Assignment", |
| 2479 "description": "Assignment details.\nThis is populated only
when `work_type` is `ASSIGNMENT`.\n\nRead-only." |
| 2480 }, |
| 2481 "multipleChoiceQuestion": { |
| 2482 "$ref": "MultipleChoiceQuestion", |
| 2483 "description": "Multiple choice question details.\nFor read
operations, this field is populated only when `work_type` is\n`MULTIPLE_CHOICE_Q
UESTION`.\nFor write operations, this field must be specified when creating cour
se\nwork with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be\ns
et otherwise." |
| 2484 }, |
1950 "description": { | 2485 "description": { |
1951 "description": "Optional description of this course work.\nI
f set, the description must be a valid UTF-8 string containing no more\nthan 30,
000 characters.", | 2486 "description": "Optional description of this course work.\nI
f set, the description must be a valid UTF-8 string containing no more\nthan 30,
000 characters.", |
1952 "type": "string" | 2487 "type": "string" |
1953 }, | 2488 }, |
| 2489 "scheduledTime": { |
| 2490 "description": "Optional timestamp when this course work is
scheduled to be published.", |
| 2491 "format": "google-datetime", |
| 2492 "type": "string" |
| 2493 }, |
1954 "creationTime": { | 2494 "creationTime": { |
1955 "description": "Timestamp when this course work was created.
\n\nRead-only.", | 2495 "description": "Timestamp when this course work was created.
\n\nRead-only.", |
1956 "format": "google-datetime", | 2496 "format": "google-datetime", |
1957 "type": "string" | 2497 "type": "string" |
1958 }, | 2498 }, |
1959 "dueDate": { | 2499 "dueDate": { |
1960 "$ref": "Date", | 2500 "$ref": "Date", |
1961 "description": "Optional date, in UTC, that submissions for
this this course work are due.\nThis must be specified if `due_time` is specifie
d." | 2501 "description": "Optional date, in UTC, that submissions for
this this course work are due.\nThis must be specified if `due_time` is specifie
d." |
1962 }, | 2502 }, |
1963 "submissionModificationMode": { | 2503 "submissionModificationMode": { |
(...skipping 34 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1998 "description": "Classroom-assigned identifier of this course
work, unique per course.\n\nRead-only.", | 2538 "description": "Classroom-assigned identifier of this course
work, unique per course.\n\nRead-only.", |
1999 "type": "string" | 2539 "type": "string" |
2000 }, | 2540 }, |
2001 "dueTime": { | 2541 "dueTime": { |
2002 "$ref": "TimeOfDay", | 2542 "$ref": "TimeOfDay", |
2003 "description": "Optional time of day, in UTC, that submissio
ns for this this course work\nare due.\nThis must be specified if `due_date` is
specified." | 2543 "description": "Optional time of day, in UTC, that submissio
ns for this this course work\nare due.\nThis must be specified if `due_date` is
specified." |
2004 }, | 2544 }, |
2005 "title": { | 2545 "title": { |
2006 "description": "Title of this course work.\nThe title must b
e a valid UTF-8 string containing between 1 and 3000\ncharacters.", | 2546 "description": "Title of this course work.\nThe title must b
e a valid UTF-8 string containing between 1 and 3000\ncharacters.", |
2007 "type": "string" | 2547 "type": "string" |
2008 }, | |
2009 "materials": { | |
2010 "description": "Additional materials.\n\nCourseWork must hav
e no more than 20 material items.", | |
2011 "items": { | |
2012 "$ref": "Material" | |
2013 }, | |
2014 "type": "array" | |
2015 }, | |
2016 "associatedWithDeveloper": { | |
2017 "description": "Whether this course work item is associated
with the Developer Console\nproject making the request.\n\nSee google.classroom.
Work.CreateCourseWork for more\ndetails.\n\nRead-only.", | |
2018 "type": "boolean" | |
2019 }, | |
2020 "updateTime": { | |
2021 "description": "Timestamp of the most recent change to this
course work.\n\nRead-only.", | |
2022 "format": "google-datetime", | |
2023 "type": "string" | |
2024 }, | |
2025 "alternateLink": { | |
2026 "description": "Absolute link to this course work in the Cla
ssroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only."
, | |
2027 "type": "string" | |
2028 }, | |
2029 "maxPoints": { | |
2030 "description": "Maximum grade for this course work.\nIf zero
or unspecified, this assignment is considered ungraded.\nThis must be a non-neg
ative integer value.", | |
2031 "format": "double", | |
2032 "type": "number" | |
2033 }, | |
2034 "assignment": { | |
2035 "$ref": "Assignment", | |
2036 "description": "Assignment details.\nThis is populated only
when `work_type` is `ASSIGNMENT`.\n\nRead-only." | |
2037 }, | |
2038 "workType": { | |
2039 "description": "Type of this course work.\n\nThe type is set
when the course work is created and cannot be changed.", | |
2040 "enum": [ | |
2041 "COURSE_WORK_TYPE_UNSPECIFIED", | |
2042 "ASSIGNMENT", | |
2043 "SHORT_ANSWER_QUESTION", | |
2044 "MULTIPLE_CHOICE_QUESTION" | |
2045 ], | |
2046 "enumDescriptions": [ | |
2047 "No work type specified. This is never returned.", | |
2048 "An assignment.", | |
2049 "A short answer question.", | |
2050 "A multiple-choice question." | |
2051 ], | |
2052 "type": "string" | |
2053 }, | |
2054 "multipleChoiceQuestion": { | |
2055 "$ref": "MultipleChoiceQuestion", | |
2056 "description": "Multiple choice question details.\nFor read
operations, this field is populated only when `work_type` is\n`MULTIPLE_CHOICE_Q
UESTION`.\nFor write operations, this field must be specified when creating cour
se\nwork with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be\ns
et otherwise." | |
2057 } | 2548 } |
2058 }, | 2549 }, |
2059 "type": "object" | 2550 "type": "object" |
2060 }, | 2551 }, |
2061 "Guardian": { | 2552 "Guardian": { |
2062 "description": "Association between a student and a guardian of that
student. The guardian\nmay receive information about the student's course work.
", | 2553 "description": "Association between a student and a guardian of that
student. The guardian\nmay receive information about the student's course work.
", |
2063 "id": "Guardian", | 2554 "id": "Guardian", |
2064 "properties": { | 2555 "properties": { |
2065 "guardianId": { | 2556 "guardianId": { |
2066 "description": "Identifier for the guardian.", | 2557 "description": "Identifier for the guardian.", |
2067 "type": "string" | 2558 "type": "string" |
2068 }, | 2559 }, |
2069 "invitedEmailAddress": { | 2560 "invitedEmailAddress": { |
2070 "description": "The email address to which the initial guard
ian invitation was sent.\nThis field is only visible to domain administrators.", | 2561 "description": "The email address to which the initial guard
ian invitation was sent.\nThis field is only visible to domain administrators.", |
2071 "type": "string" | 2562 "type": "string" |
2072 }, | 2563 }, |
2073 "guardianProfile": { | 2564 "guardianProfile": { |
2074 "$ref": "UserProfile", | 2565 "$ref": "UserProfile", |
2075 "description": "User profile for the guardian." | 2566 "description": "User profile for the guardian." |
2076 }, | 2567 }, |
2077 "studentId": { | 2568 "studentId": { |
2078 "description": "Identifier for the student to whom the guard
ian relationship applies.", | 2569 "description": "Identifier for the student to whom the guard
ian relationship applies.", |
2079 "type": "string" | 2570 "type": "string" |
2080 } | 2571 } |
2081 }, | 2572 }, |
2082 "type": "object" | 2573 "type": "object" |
2083 }, | 2574 }, |
2084 "UserProfile": { | |
2085 "description": "Global information for a user.", | |
2086 "id": "UserProfile", | |
2087 "properties": { | |
2088 "id": { | |
2089 "description": "Identifier of the user.\n\nRead-only.", | |
2090 "type": "string" | |
2091 }, | |
2092 "emailAddress": { | |
2093 "description": "Email address of the user.\n\nRead-only.", | |
2094 "type": "string" | |
2095 }, | |
2096 "photoUrl": { | |
2097 "description": "URL of user's profile photo.\n\nRead-only.", | |
2098 "type": "string" | |
2099 }, | |
2100 "permissions": { | |
2101 "description": "Global permissions of the user.\n\nRead-only
.", | |
2102 "items": { | |
2103 "$ref": "GlobalPermission" | |
2104 }, | |
2105 "type": "array" | |
2106 }, | |
2107 "name": { | |
2108 "$ref": "Name", | |
2109 "description": "Name of the user.\n\nRead-only." | |
2110 } | |
2111 }, | |
2112 "type": "object" | |
2113 }, | |
2114 "ListStudentsResponse": { | 2575 "ListStudentsResponse": { |
2115 "description": "Response when listing students.", | 2576 "description": "Response when listing students.", |
2116 "id": "ListStudentsResponse", | 2577 "id": "ListStudentsResponse", |
2117 "properties": { | 2578 "properties": { |
2118 "students": { | 2579 "students": { |
2119 "description": "Students who match the list request.", | 2580 "description": "Students who match the list request.", |
2120 "items": { | 2581 "items": { |
2121 "$ref": "Student" | 2582 "$ref": "Student" |
2122 }, | 2583 }, |
2123 "type": "array" | 2584 "type": "array" |
2124 }, | 2585 }, |
2125 "nextPageToken": { | |
2126 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | |
2127 "type": "string" | |
2128 } | |
2129 }, | |
2130 "type": "object" | |
2131 }, | |
2132 "Student": { | |
2133 "description": "Student in a course.", | |
2134 "id": "Student", | |
2135 "properties": { | |
2136 "profile": { | |
2137 "$ref": "UserProfile", | |
2138 "description": "Global user information for the student.\n\n
Read-only." | |
2139 }, | |
2140 "studentWorkFolder": { | |
2141 "$ref": "DriveFolder", | |
2142 "description": "Information about a Drive Folder for this st
udent's work in this course.\nOnly visible to the student and domain administrat
ors.\n\nRead-only." | |
2143 }, | |
2144 "userId": { | |
2145 "description": "Identifier of the user.\n\nWhen specified as
a parameter of a request, this identifier can be one of\nthe following:\n\n* th
e numeric identifier for the user\n* the email address of the user\n* the string
literal `\"me\"`, indicating the requesting user", | |
2146 "type": "string" | |
2147 }, | |
2148 "courseId": { | |
2149 "description": "Identifier of the course.\n\nRead-only.", | |
2150 "type": "string" | |
2151 } | |
2152 }, | |
2153 "type": "object" | |
2154 }, | |
2155 "Invitation": { | |
2156 "description": "An invitation to join a course.", | |
2157 "id": "Invitation", | |
2158 "properties": { | |
2159 "courseId": { | |
2160 "description": "Identifier of the course to invite the user
to.", | |
2161 "type": "string" | |
2162 }, | |
2163 "id": { | |
2164 "description": "Identifier assigned by Classroom.\n\nRead-on
ly.", | |
2165 "type": "string" | |
2166 }, | |
2167 "role": { | |
2168 "description": "Role to invite the user to have.\nMust not b
e `COURSE_ROLE_UNSPECIFIED`.", | |
2169 "enum": [ | |
2170 "COURSE_ROLE_UNSPECIFIED", | |
2171 "STUDENT", | |
2172 "TEACHER" | |
2173 ], | |
2174 "enumDescriptions": [ | |
2175 "No course role.", | |
2176 "Student in the course.", | |
2177 "Teacher of the course." | |
2178 ], | |
2179 "type": "string" | |
2180 }, | |
2181 "userId": { | |
2182 "description": "Identifier of the invited user.\n\nWhen spec
ified as a parameter of a request, this identifier can be set to\none of the fol
lowing:\n\n* the numeric identifier for the user\n* the email address of the use
r\n* the string literal `\"me\"`, indicating the requesting user", | |
2183 "type": "string" | |
2184 } | |
2185 }, | |
2186 "type": "object" | |
2187 }, | |
2188 "DriveFolder": { | |
2189 "description": "Representation of a Google Drive folder.", | |
2190 "id": "DriveFolder", | |
2191 "properties": { | |
2192 "alternateLink": { | |
2193 "description": "URL that can be used to access the Drive fol
der.\n\nRead-only.", | |
2194 "type": "string" | |
2195 }, | |
2196 "id": { | |
2197 "description": "Drive API resource ID.", | |
2198 "type": "string" | |
2199 }, | |
2200 "title": { | |
2201 "description": "Title of the Drive folder.\n\nRead-only.", | |
2202 "type": "string" | |
2203 } | |
2204 }, | |
2205 "type": "object" | |
2206 }, | |
2207 "ShortAnswerSubmission": { | |
2208 "description": "Student work for a short answer question.", | |
2209 "id": "ShortAnswerSubmission", | |
2210 "properties": { | |
2211 "answer": { | |
2212 "description": "Student response to a short-answer question.
", | |
2213 "type": "string" | |
2214 } | |
2215 }, | |
2216 "type": "object" | |
2217 }, | |
2218 "StudentSubmission": { | |
2219 "description": "Student submission for course work.\n\nStudentSubmis
sion items are generated when a CourseWork item is created.\n\nStudentSubmission
s that have never been accessed (i.e. with `state` = NEW)\nmay not have a creati
on time or update time.", | |
2220 "id": "StudentSubmission", | |
2221 "properties": { | |
2222 "late": { | |
2223 "description": "Whether this submission is late.\n\nRead-onl
y.", | |
2224 "type": "boolean" | |
2225 }, | |
2226 "draftGrade": { | |
2227 "description": "Optional pending grade. If unset, no grade w
as set.\nThis must be a non-negative integer value.\n\nThis is only visible to a
nd modifiable by course teachers.", | |
2228 "format": "double", | |
2229 "type": "number" | |
2230 }, | |
2231 "courseWorkType": { | |
2232 "description": "Type of course work this submission is for.\
n\nRead-only.", | |
2233 "enum": [ | |
2234 "COURSE_WORK_TYPE_UNSPECIFIED", | |
2235 "ASSIGNMENT", | |
2236 "SHORT_ANSWER_QUESTION", | |
2237 "MULTIPLE_CHOICE_QUESTION" | |
2238 ], | |
2239 "enumDescriptions": [ | |
2240 "No work type specified. This is never returned.", | |
2241 "An assignment.", | |
2242 "A short answer question.", | |
2243 "A multiple-choice question." | |
2244 ], | |
2245 "type": "string" | |
2246 }, | |
2247 "creationTime": { | |
2248 "description": "Creation time of this submission.\nThis may
be unset if the student has not accessed this item.\n\nRead-only.", | |
2249 "format": "google-datetime", | |
2250 "type": "string" | |
2251 }, | |
2252 "state": { | |
2253 "description": "State of this submission.\n\nRead-only.", | |
2254 "enum": [ | |
2255 "SUBMISSION_STATE_UNSPECIFIED", | |
2256 "NEW", | |
2257 "CREATED", | |
2258 "TURNED_IN", | |
2259 "RETURNED", | |
2260 "RECLAIMED_BY_STUDENT" | |
2261 ], | |
2262 "enumDescriptions": [ | |
2263 "No state specified. This should never be returned.", | |
2264 "The student has never accessed this submission. Attachm
ents are not\nreturned and timestamps is not set.", | |
2265 "Has been created.", | |
2266 "Has been turned in to the teacher.", | |
2267 "Has been returned to the student.", | |
2268 "Student chose to \"unsubmit\" the assignment." | |
2269 ], | |
2270 "type": "string" | |
2271 }, | |
2272 "userId": { | |
2273 "description": "Identifier for the student that owns this su
bmission.\n\nRead-only.", | |
2274 "type": "string" | |
2275 }, | |
2276 "courseWorkId": { | |
2277 "description": "Identifier for the course work this correspo
nds to.\n\nRead-only.", | |
2278 "type": "string" | |
2279 }, | |
2280 "courseId": { | |
2281 "description": "Identifier of the course.\n\nRead-only.", | |
2282 "type": "string" | |
2283 }, | |
2284 "id": { | |
2285 "description": "Classroom-assigned Identifier for the studen
t submission.\nThis is unique among submissions for the relevant course work.\n\
nRead-only.", | |
2286 "type": "string" | |
2287 }, | |
2288 "assignedGrade": { | |
2289 "description": "Optional grade. If unset, no grade was set.\
nThis must be a non-negative integer value.\n\nThis may be modified only by cour
se teachers.", | |
2290 "format": "double", | |
2291 "type": "number" | |
2292 }, | |
2293 "multipleChoiceSubmission": { | |
2294 "$ref": "MultipleChoiceSubmission", | |
2295 "description": "Submission content when course_work_type is
MULTIPLE_CHOICE_QUESTION." | |
2296 }, | |
2297 "assignmentSubmission": { | |
2298 "$ref": "AssignmentSubmission", | |
2299 "description": "Submission content when course_work_type is
ASSIGNMENT ." | |
2300 }, | |
2301 "shortAnswerSubmission": { | |
2302 "$ref": "ShortAnswerSubmission", | |
2303 "description": "Submission content when course_work_type is
SHORT_ANSWER_QUESTION." | |
2304 }, | |
2305 "associatedWithDeveloper": { | |
2306 "description": "Whether this student submission is associate
d with the Developer Console\nproject making the request.\n\nSee google.classroo
m.Work.CreateCourseWork for more\ndetails.\n\nRead-only.", | |
2307 "type": "boolean" | |
2308 }, | |
2309 "updateTime": { | |
2310 "description": "Last update time of this submission.\nThis m
ay be unset if the student has not accessed this item.\n\nRead-only.", | |
2311 "format": "google-datetime", | |
2312 "type": "string" | |
2313 }, | |
2314 "alternateLink": { | |
2315 "description": "Absolute link to the submission in the Class
room web UI.\n\nRead-only.", | |
2316 "type": "string" | |
2317 } | |
2318 }, | |
2319 "type": "object" | |
2320 }, | |
2321 "ListStudentSubmissionsResponse": { | |
2322 "description": "Response when listing student submissions.", | |
2323 "id": "ListStudentSubmissionsResponse", | |
2324 "properties": { | |
2325 "nextPageToken": { | |
2326 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | |
2327 "type": "string" | |
2328 }, | |
2329 "studentSubmissions": { | |
2330 "description": "Student work that matches the request.", | |
2331 "items": { | |
2332 "$ref": "StudentSubmission" | |
2333 }, | |
2334 "type": "array" | |
2335 } | |
2336 }, | |
2337 "type": "object" | |
2338 }, | |
2339 "TurnInStudentSubmissionRequest": { | |
2340 "description": "Request to turn in a student submission.", | |
2341 "id": "TurnInStudentSubmissionRequest", | |
2342 "properties": {}, | |
2343 "type": "object" | |
2344 }, | |
2345 "ModifyAttachmentsRequest": { | |
2346 "description": "Request to modify the attachments of a student submi
ssion.", | |
2347 "id": "ModifyAttachmentsRequest", | |
2348 "properties": { | |
2349 "addAttachments": { | |
2350 "description": "Attachments to add.\nA student submission ma
y not have more than 20 attachments.\n\nForm attachments are not supported.", | |
2351 "items": { | |
2352 "$ref": "Attachment" | |
2353 }, | |
2354 "type": "array" | |
2355 } | |
2356 }, | |
2357 "type": "object" | |
2358 }, | |
2359 "ListCourseWorkResponse": { | |
2360 "description": "Response when listing course work.", | |
2361 "id": "ListCourseWorkResponse", | |
2362 "properties": { | |
2363 "nextPageToken": { | |
2364 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | |
2365 "type": "string" | |
2366 }, | |
2367 "courseWork": { | |
2368 "description": "Course work items that match the request.", | |
2369 "items": { | |
2370 "$ref": "CourseWork" | |
2371 }, | |
2372 "type": "array" | |
2373 } | |
2374 }, | |
2375 "type": "object" | |
2376 }, | |
2377 "YouTubeVideo": { | |
2378 "description": "YouTube video item.", | |
2379 "id": "YouTubeVideo", | |
2380 "properties": { | |
2381 "alternateLink": { | |
2382 "description": "URL that can be used to view the YouTube vid
eo.\n\nRead-only.", | |
2383 "type": "string" | |
2384 }, | |
2385 "thumbnailUrl": { | |
2386 "description": "URL of a thumbnail image of the YouTube vide
o.\n\nRead-only.", | |
2387 "type": "string" | |
2388 }, | |
2389 "id": { | |
2390 "description": "YouTube API resource ID.", | |
2391 "type": "string" | |
2392 }, | |
2393 "title": { | |
2394 "description": "Title of the YouTube video.\n\nRead-only.", | |
2395 "type": "string" | |
2396 } | |
2397 }, | |
2398 "type": "object" | |
2399 }, | |
2400 "ListInvitationsResponse": { | |
2401 "description": "Response when listing invitations.", | |
2402 "id": "ListInvitationsResponse", | |
2403 "properties": { | |
2404 "nextPageToken": { | |
2405 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | |
2406 "type": "string" | |
2407 }, | |
2408 "invitations": { | |
2409 "description": "Invitations that match the list request.", | |
2410 "items": { | |
2411 "$ref": "Invitation" | |
2412 }, | |
2413 "type": "array" | |
2414 } | |
2415 }, | |
2416 "type": "object" | |
2417 }, | |
2418 "GuardianInvitation": { | |
2419 "description": "An invitation to become the guardian of a specified
user, sent to a specified\nemail address.", | |
2420 "id": "GuardianInvitation", | |
2421 "properties": { | |
2422 "studentId": { | |
2423 "description": "ID of the student (in standard format)", | |
2424 "type": "string" | |
2425 }, | |
2426 "state": { | |
2427 "description": "The state that this invitation is in.", | |
2428 "enum": [ | |
2429 "GUARDIAN_INVITATION_STATE_UNSPECIFIED", | |
2430 "PENDING", | |
2431 "COMPLETE" | |
2432 ], | |
2433 "enumDescriptions": [ | |
2434 "Should never be returned.", | |
2435 "The invitation is active and awaiting a response.", | |
2436 "The invitation is no longer active. It may have been ac
cepted, declined,\nwithdrawn or it may have expired." | |
2437 ], | |
2438 "type": "string" | |
2439 }, | |
2440 "invitedEmailAddress": { | |
2441 "description": "Email address that the invitation was sent t
o.\nThis field is only visible to domain administrators.", | |
2442 "type": "string" | |
2443 }, | |
2444 "creationTime": { | |
2445 "description": "The time that this invitation was created.\n
\nRead-only.", | |
2446 "format": "google-datetime", | |
2447 "type": "string" | |
2448 }, | |
2449 "invitationId": { | |
2450 "description": "Unique identifier for this invitation.\n\nRe
ad-only.", | |
2451 "type": "string" | |
2452 } | |
2453 }, | |
2454 "type": "object" | |
2455 }, | |
2456 "Attachment": { | |
2457 "description": "Attachment added to student assignment work.\n\nWhen
creating attachments, setting the `form` field is not supported.", | |
2458 "id": "Attachment", | |
2459 "properties": { | |
2460 "driveFile": { | |
2461 "$ref": "DriveFile", | |
2462 "description": "Google Drive file attachment." | |
2463 }, | |
2464 "youTubeVideo": { | |
2465 "$ref": "YouTubeVideo", | |
2466 "description": "Youtube video attachment." | |
2467 }, | |
2468 "form": { | |
2469 "$ref": "Form", | |
2470 "description": "Google Forms attachment." | |
2471 }, | |
2472 "link": { | |
2473 "$ref": "Link", | |
2474 "description": "Link attachment." | |
2475 } | |
2476 }, | |
2477 "type": "object" | |
2478 }, | |
2479 "CourseMaterialSet": { | |
2480 "description": "A set of materials that appears on the \"About\" pag
e of the course.\nThese materials might include a syllabus, schedule, or other b
ackground\ninformation relating to the course as a whole.", | |
2481 "id": "CourseMaterialSet", | |
2482 "properties": { | |
2483 "title": { | |
2484 "description": "Title for this set.", | |
2485 "type": "string" | |
2486 }, | |
2487 "materials": { | |
2488 "description": "Materials attached to this set.", | |
2489 "items": { | |
2490 "$ref": "CourseMaterial" | |
2491 }, | |
2492 "type": "array" | |
2493 } | |
2494 }, | |
2495 "type": "object" | |
2496 }, | |
2497 "TimeOfDay": { | |
2498 "description": "Represents a time of day. The date and time zone are
either not significant\nor are specified elsewhere. An API may choose to allow
leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp
`.", | |
2499 "id": "TimeOfDay", | |
2500 "properties": { | |
2501 "nanos": { | |
2502 "description": "Fractions of seconds in nanoseconds. Must be
from 0 to 999,999,999.", | |
2503 "format": "int32", | |
2504 "type": "integer" | |
2505 }, | |
2506 "seconds": { | |
2507 "description": "Seconds of minutes of the time. Must normall
y be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.", | |
2508 "format": "int32", | |
2509 "type": "integer" | |
2510 }, | |
2511 "minutes": { | |
2512 "description": "Minutes of hour of day. Must be from 0 to 59
.", | |
2513 "format": "int32", | |
2514 "type": "integer" | |
2515 }, | |
2516 "hours": { | |
2517 "description": "Hours of day in 24 hour format. Should be fr
om 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios lik
e business closing time.", | |
2518 "format": "int32", | |
2519 "type": "integer" | |
2520 } | |
2521 }, | |
2522 "type": "object" | |
2523 }, | |
2524 "ListCoursesResponse": { | |
2525 "description": "Response when listing courses.", | |
2526 "id": "ListCoursesResponse", | |
2527 "properties": { | |
2528 "nextPageToken": { | |
2529 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | |
2530 "type": "string" | |
2531 }, | |
2532 "courses": { | |
2533 "description": "Courses that match the list request.", | |
2534 "items": { | |
2535 "$ref": "Course" | |
2536 }, | |
2537 "type": "array" | |
2538 } | |
2539 }, | |
2540 "type": "object" | |
2541 }, | |
2542 "Form": { | |
2543 "description": "Google Forms item.", | |
2544 "id": "Form", | |
2545 "properties": { | |
2546 "formUrl": { | |
2547 "description": "URL of the form.", | |
2548 "type": "string" | |
2549 }, | |
2550 "title": { | |
2551 "description": "Title of the Form.\n\nRead-only.", | |
2552 "type": "string" | |
2553 }, | |
2554 "thumbnailUrl": { | |
2555 "description": "URL of a thumbnail image of the Form.\n\nRea
d-only.", | |
2556 "type": "string" | |
2557 }, | |
2558 "responseUrl": { | |
2559 "description": "URL of the form responses document.\nOnly se
t if respsonses have been recorded and only when the\nrequesting user is an edit
or of the form.\n\nRead-only.", | |
2560 "type": "string" | |
2561 } | |
2562 }, | |
2563 "type": "object" | |
2564 }, | |
2565 "ListTeachersResponse": { | |
2566 "description": "Response when listing teachers.", | |
2567 "id": "ListTeachersResponse", | |
2568 "properties": { | |
2569 "teachers": { | |
2570 "description": "Teachers who match the list request.", | |
2571 "items": { | |
2572 "$ref": "Teacher" | |
2573 }, | |
2574 "type": "array" | |
2575 }, | |
2576 "nextPageToken": { | 2586 "nextPageToken": { |
2577 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | 2587 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
2578 "type": "string" | 2588 "type": "string" |
2579 } | 2589 } |
2580 }, | 2590 }, |
2581 "type": "object" | 2591 "type": "object" |
2582 }, | 2592 }, |
2583 "Link": { | 2593 "UserProfile": { |
2584 "description": "URL item.", | 2594 "description": "Global information for a user.", |
2585 "id": "Link", | 2595 "id": "UserProfile", |
2586 "properties": { | 2596 "properties": { |
2587 "thumbnailUrl": { | 2597 "id": { |
2588 "description": "URL of a thumbnail image of the target URL.\
n\nRead-only.", | 2598 "description": "Identifier of the user.\n\nRead-only.", |
2589 "type": "string" | 2599 "type": "string" |
2590 }, | 2600 }, |
2591 "url": { | 2601 "verifiedTeacher": { |
2592 "description": "URL to link to.\nThis must be a valid UTF-8
string containing between 1 and 2024 characters.", | 2602 "description": "Whether or not the user is a verified teache
r\n\nRead-only", |
| 2603 "type": "boolean" |
| 2604 }, |
| 2605 "emailAddress": { |
| 2606 "description": "Email address of the user.\n\nRead-only.", |
2593 "type": "string" | 2607 "type": "string" |
2594 }, | 2608 }, |
2595 "title": { | 2609 "photoUrl": { |
2596 "description": "Title of the target of the URL.\n\nRead-only
.", | 2610 "description": "URL of user's profile photo.\n\nRead-only.", |
| 2611 "type": "string" |
| 2612 }, |
| 2613 "permissions": { |
| 2614 "description": "Global permissions of the user.\n\nRead-only
.", |
| 2615 "items": { |
| 2616 "$ref": "GlobalPermission" |
| 2617 }, |
| 2618 "type": "array" |
| 2619 }, |
| 2620 "name": { |
| 2621 "$ref": "Name", |
| 2622 "description": "Name of the user.\n\nRead-only." |
| 2623 } |
| 2624 }, |
| 2625 "type": "object" |
| 2626 }, |
| 2627 "Student": { |
| 2628 "description": "Student in a course.", |
| 2629 "id": "Student", |
| 2630 "properties": { |
| 2631 "profile": { |
| 2632 "$ref": "UserProfile", |
| 2633 "description": "Global user information for the student.\n\n
Read-only." |
| 2634 }, |
| 2635 "studentWorkFolder": { |
| 2636 "$ref": "DriveFolder", |
| 2637 "description": "Information about a Drive Folder for this st
udent's work in this course.\nOnly visible to the student and domain administrat
ors.\n\nRead-only." |
| 2638 }, |
| 2639 "userId": { |
| 2640 "description": "Identifier of the user.\n\nWhen specified as
a parameter of a request, this identifier can be one of\nthe following:\n\n* th
e numeric identifier for the user\n* the email address of the user\n* the string
literal `\"me\"`, indicating the requesting user", |
| 2641 "type": "string" |
| 2642 }, |
| 2643 "courseId": { |
| 2644 "description": "Identifier of the course.\n\nRead-only.", |
2597 "type": "string" | 2645 "type": "string" |
2598 } | 2646 } |
2599 }, | 2647 }, |
2600 "type": "object" | 2648 "type": "object" |
2601 }, | 2649 }, |
2602 "ListGuardiansResponse": { | 2650 "Invitation": { |
2603 "description": "Response when listing guardians.", | 2651 "description": "An invitation to join a course.", |
2604 "id": "ListGuardiansResponse", | 2652 "id": "Invitation", |
2605 "properties": { | 2653 "properties": { |
2606 "guardians": { | 2654 "courseId": { |
2607 "description": "Guardians on this page of results that met t
he criteria specified in\nthe request.", | 2655 "description": "Identifier of the course to invite the user
to.", |
2608 "items": { | 2656 "type": "string" |
2609 "$ref": "Guardian" | |
2610 }, | |
2611 "type": "array" | |
2612 }, | 2657 }, |
2613 "nextPageToken": { | 2658 "id": { |
2614 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | 2659 "description": "Identifier assigned by Classroom.\n\nRead-on
ly.", |
| 2660 "type": "string" |
| 2661 }, |
| 2662 "role": { |
| 2663 "description": "Role to invite the user to have.\nMust not b
e `COURSE_ROLE_UNSPECIFIED`.", |
| 2664 "enum": [ |
| 2665 "COURSE_ROLE_UNSPECIFIED", |
| 2666 "STUDENT", |
| 2667 "TEACHER" |
| 2668 ], |
| 2669 "enumDescriptions": [ |
| 2670 "No course role.", |
| 2671 "Student in the course.", |
| 2672 "Teacher of the course." |
| 2673 ], |
| 2674 "type": "string" |
| 2675 }, |
| 2676 "userId": { |
| 2677 "description": "Identifier of the invited user.\n\nWhen spec
ified as a parameter of a request, this identifier can be set to\none of the fol
lowing:\n\n* the numeric identifier for the user\n* the email address of the use
r\n* the string literal `\"me\"`, indicating the requesting user", |
2615 "type": "string" | 2678 "type": "string" |
2616 } | 2679 } |
2617 }, | 2680 }, |
2618 "type": "object" | 2681 "type": "object" |
2619 }, | 2682 }, |
2620 "ListCourseAliasesResponse": { | 2683 "DriveFolder": { |
2621 "description": "Response when listing course aliases.", | 2684 "description": "Representation of a Google Drive folder.", |
2622 "id": "ListCourseAliasesResponse", | 2685 "id": "DriveFolder", |
2623 "properties": { | 2686 "properties": { |
2624 "aliases": { | 2687 "title": { |
2625 "description": "The course aliases.", | 2688 "description": "Title of the Drive folder.\n\nRead-only.", |
2626 "items": { | 2689 "type": "string" |
2627 "$ref": "CourseAlias" | |
2628 }, | |
2629 "type": "array" | |
2630 }, | 2690 }, |
2631 "nextPageToken": { | 2691 "alternateLink": { |
2632 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | 2692 "description": "URL that can be used to access the Drive fol
der.\n\nRead-only.", |
| 2693 "type": "string" |
| 2694 }, |
| 2695 "id": { |
| 2696 "description": "Drive API resource ID.", |
2633 "type": "string" | 2697 "type": "string" |
2634 } | 2698 } |
2635 }, | 2699 }, |
2636 "type": "object" | 2700 "type": "object" |
2637 }, | 2701 }, |
2638 "CourseAlias": { | 2702 "ShortAnswerSubmission": { |
2639 "description": "Alternative identifier for a course.\n\nAn alias uni
quely identifies a course. It must be unique within one of the\nfollowing scopes
:\n\n* domain: A domain-scoped alias is visible to all users within the alias\nc
reator's domain and can be created only by a domain admin. A domain-scoped\nalia
s is often used when a course has an identifier external to Classroom.\n\n* proj
ect: A project-scoped alias is visible to any request from an\napplication using
the Developer Console project ID that created the alias\nand can be created by
any project. A project-scoped alias is often used when\nan application has alter
native identifiers. A random value can also be used\nto avoid duplicate courses
in the event of transmission failures, as retrying\na request will return `ALREA
DY_EXISTS` if a previous one has succeeded.", | 2703 "description": "Student work for a short answer question.", |
2640 "id": "CourseAlias", | 2704 "id": "ShortAnswerSubmission", |
2641 "properties": { | 2705 "properties": { |
2642 "alias": { | 2706 "answer": { |
2643 "description": "Alias string. The format of the string indic
ates the desired alias scoping.\n\n* `d:<name>` indicates a domain-scoped alias.
\n Example: `d:math_101`\n* `p:<name>` indicates a project-scoped alias.\n Exa
mple: `p:abc123`\n\nThis field has a maximum length of 256 characters.", | 2707 "description": "Student response to a short-answer question.
", |
2644 "type": "string" | 2708 "type": "string" |
2645 } | 2709 } |
2646 }, | 2710 }, |
2647 "type": "object" | |
2648 }, | |
2649 "ListGuardianInvitationsResponse": { | |
2650 "description": "Response when listing guardian invitations.", | |
2651 "id": "ListGuardianInvitationsResponse", | |
2652 "properties": { | |
2653 "nextPageToken": { | |
2654 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | |
2655 "type": "string" | |
2656 }, | |
2657 "guardianInvitations": { | |
2658 "description": "Guardian invitations that matched the list r
equest.", | |
2659 "items": { | |
2660 "$ref": "GuardianInvitation" | |
2661 }, | |
2662 "type": "array" | |
2663 } | |
2664 }, | |
2665 "type": "object" | |
2666 }, | |
2667 "Date": { | |
2668 "description": "Represents a whole calendar date, e.g. date of birth
. The time of day and\ntime zone are either specified elsewhere or are not signi
ficant. The date\nis relative to the Proleptic Gregorian Calendar. The day may b
e 0 to\nrepresent a year and month where the day is not significant, e.g. credit
card\nexpiration date. The year may be 0 to represent a month and day independe
nt\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand
`google.protobuf.Timestamp`.", | |
2669 "id": "Date", | |
2670 "properties": { | |
2671 "year": { | |
2672 "description": "Year of date. Must be from 1 to 9999, or 0 i
f specifying a date without\na year.", | |
2673 "format": "int32", | |
2674 "type": "integer" | |
2675 }, | |
2676 "day": { | |
2677 "description": "Day of month. Must be from 1 to 31 and valid
for the year and month, or 0\nif specifying a year/month where the day is not s
ignificant.", | |
2678 "format": "int32", | |
2679 "type": "integer" | |
2680 }, | |
2681 "month": { | |
2682 "description": "Month of year. Must be from 1 to 12.", | |
2683 "format": "int32", | |
2684 "type": "integer" | |
2685 } | |
2686 }, | |
2687 "type": "object" | |
2688 }, | |
2689 "MultipleChoiceSubmission": { | |
2690 "description": "Student work for a multiple-choice question.", | |
2691 "id": "MultipleChoiceSubmission", | |
2692 "properties": { | |
2693 "answer": { | |
2694 "description": "Student's select choice.", | |
2695 "type": "string" | |
2696 } | |
2697 }, | |
2698 "type": "object" | 2711 "type": "object" |
2699 } | 2712 } |
2700 }, | 2713 }, |
2701 "servicePath": "", | 2714 "servicePath": "", |
2702 "title": "Google Classroom API", | 2715 "title": "Google Classroom API", |
2703 "version": "v1" | 2716 "version": "v1" |
2704 } | 2717 } |
OLD | NEW |