OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/classroom.rosters": { |
| 6 "description": "Manage your Google Classroom class rosters" |
| 7 }, |
| 8 "https://www.googleapis.com/auth/classroom.student-submissions.s
tudents.readonly": { |
| 9 "description": "View course work and grades for students in
the Google Classroom classes you teach or administer" |
| 10 }, |
| 11 "https://www.googleapis.com/auth/classroom.guardianlinks.student
s.readonly": { |
| 12 "description": "View guardians for students in your Google C
lassroom classes" |
| 13 }, |
| 14 "https://www.googleapis.com/auth/classroom.courses": { |
| 15 "description": "Manage your Google Classroom classes" |
| 16 }, |
| 17 "https://www.googleapis.com/auth/classroom.courses.readonly": { |
| 18 "description": "View your Google Classroom classes" |
| 19 }, |
| 20 "https://www.googleapis.com/auth/classroom.rosters.readonly": { |
| 21 "description": "View your Google Classroom class rosters" |
| 22 }, |
| 23 "https://www.googleapis.com/auth/classroom.profile.photos": { |
| 24 "description": "View the profile photos of people in your cl
asses" |
| 25 }, |
5 "https://www.googleapis.com/auth/classroom.guardianlinks.student
s": { | 26 "https://www.googleapis.com/auth/classroom.guardianlinks.student
s": { |
6 "description": "View and manage guardians for students in yo
ur Google Classroom classes" | 27 "description": "View and manage guardians for students in yo
ur Google Classroom classes" |
7 }, | 28 }, |
8 "https://www.googleapis.com/auth/classroom.student-submissions.m
e.readonly": { | 29 "https://www.googleapis.com/auth/classroom.student-submissions.m
e.readonly": { |
9 "description": "View your course work and grades in Google C
lassroom" | 30 "description": "View your course work and grades in Google C
lassroom" |
10 }, | 31 }, |
11 "https://www.googleapis.com/auth/classroom.guardianlinks.me.read
only": { | |
12 "description": "View your Google Classroom guardians" | |
13 }, | |
14 "https://www.googleapis.com/auth/classroom.coursework.students":
{ | 32 "https://www.googleapis.com/auth/classroom.coursework.students":
{ |
15 "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" | 33 "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" |
16 }, | 34 }, |
17 "https://www.googleapis.com/auth/classroom.coursework.students.r
eadonly": { | 35 "https://www.googleapis.com/auth/classroom.coursework.students.r
eadonly": { |
18 "description": "View course work and grades for students in
the Google Classroom classes you teach or administer" | 36 "description": "View course work and grades for students in
the Google Classroom classes you teach or administer" |
19 }, | 37 }, |
| 38 "https://www.googleapis.com/auth/classroom.guardianlinks.me.read
only": { |
| 39 "description": "View your Google Classroom guardians" |
| 40 }, |
20 "https://www.googleapis.com/auth/classroom.coursework.me.readonl
y": { | 41 "https://www.googleapis.com/auth/classroom.coursework.me.readonl
y": { |
21 "description": "View your course work and grades in Google C
lassroom" | 42 "description": "View your course work and grades in Google C
lassroom" |
22 }, | 43 }, |
23 "https://www.googleapis.com/auth/classroom.profile.emails": { | 44 "https://www.googleapis.com/auth/classroom.profile.emails": { |
24 "description": "View the email addresses of people in your c
lasses" | 45 "description": "View the email addresses of people in your c
lasses" |
25 }, | 46 }, |
26 "https://www.googleapis.com/auth/classroom.coursework.me": { | 47 "https://www.googleapis.com/auth/classroom.coursework.me": { |
27 "description": "Manage your course work and view your grades
in Google Classroom" | 48 "description": "Manage your course work and view your grades
in Google Classroom" |
28 }, | |
29 "https://www.googleapis.com/auth/classroom.rosters": { | |
30 "description": "Manage your Google Classroom class rosters" | |
31 }, | |
32 "https://www.googleapis.com/auth/classroom.student-submissions.s
tudents.readonly": { | |
33 "description": "View course work and grades for students in
the Google Classroom classes you teach or administer" | |
34 }, | |
35 "https://www.googleapis.com/auth/classroom.guardianlinks.student
s.readonly": { | |
36 "description": "View guardians for students in your Google C
lassroom classes" | |
37 }, | |
38 "https://www.googleapis.com/auth/classroom.courses": { | |
39 "description": "Manage your Google Classroom classes" | |
40 }, | |
41 "https://www.googleapis.com/auth/classroom.courses.readonly": { | |
42 "description": "View your Google Classroom classes" | |
43 }, | |
44 "https://www.googleapis.com/auth/classroom.profile.photos": { | |
45 "description": "View the profile photos of people in your cl
asses" | |
46 }, | |
47 "https://www.googleapis.com/auth/classroom.rosters.readonly": { | |
48 "description": "View your Google Classroom class rosters" | |
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/", |
(...skipping 11 matching lines...) Expand all Loading... |
70 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 70 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
71 "location": "query", | 71 "location": "query", |
72 "type": "string" | 72 "type": "string" |
73 }, | 73 }, |
74 "prettyPrint": { | 74 "prettyPrint": { |
75 "default": "true", | 75 "default": "true", |
76 "description": "Returns response with indentations and line breaks."
, | 76 "description": "Returns response with indentations and line breaks."
, |
77 "location": "query", | 77 "location": "query", |
78 "type": "boolean" | 78 "type": "boolean" |
79 }, | 79 }, |
| 80 "uploadType": { |
| 81 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 82 "location": "query", |
| 83 "type": "string" |
| 84 }, |
80 "fields": { | 85 "fields": { |
81 "description": "Selector specifying which fields to include in a par
tial response.", | 86 "description": "Selector specifying which fields to include in a par
tial response.", |
82 "location": "query", | 87 "location": "query", |
83 "type": "string" | 88 "type": "string" |
84 }, | 89 }, |
85 "uploadType": { | |
86 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | |
87 "location": "query", | |
88 "type": "string" | |
89 }, | |
90 "callback": { | 90 "callback": { |
91 "description": "JSONP", | 91 "description": "JSONP", |
92 "location": "query", | 92 "location": "query", |
93 "type": "string" | 93 "type": "string" |
94 }, | 94 }, |
95 "$.xgafv": { | 95 "$.xgafv": { |
96 "description": "V1 error format.", | 96 "description": "V1 error format.", |
97 "enum": [ | 97 "enum": [ |
98 "1", | 98 "1", |
99 "2" | 99 "2" |
(...skipping 14 matching lines...) Expand all Loading... |
114 "proto" | 114 "proto" |
115 ], | 115 ], |
116 "enumDescriptions": [ | 116 "enumDescriptions": [ |
117 "Responses with Content-Type of application/json", | 117 "Responses with Content-Type of application/json", |
118 "Media download with context-dependent Content-Type", | 118 "Media download with context-dependent Content-Type", |
119 "Responses with Content-Type of application/x-protobuf" | 119 "Responses with Content-Type of application/x-protobuf" |
120 ], | 120 ], |
121 "location": "query", | 121 "location": "query", |
122 "type": "string" | 122 "type": "string" |
123 }, | 123 }, |
| 124 "access_token": { |
| 125 "description": "OAuth access token.", |
| 126 "location": "query", |
| 127 "type": "string" |
| 128 }, |
124 "key": { | 129 "key": { |
125 "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.", | 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.", |
126 "location": "query", | 131 "location": "query", |
127 "type": "string" | 132 "type": "string" |
128 }, | 133 }, |
129 "access_token": { | |
130 "description": "OAuth access token.", | |
131 "location": "query", | |
132 "type": "string" | |
133 }, | |
134 "quotaUser": { | 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.", | 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", | 136 "location": "query", |
137 "type": "string" | 137 "type": "string" |
138 }, | 138 }, |
139 "pp": { | 139 "pp": { |
140 "default": "true", | 140 "default": "true", |
141 "description": "Pretty-print response.", | 141 "description": "Pretty-print response.", |
142 "location": "query", | 142 "location": "query", |
143 "type": "boolean" | 143 "type": "boolean" |
(...skipping 34 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
178 }, | 178 }, |
179 "scopes": [ | 179 "scopes": [ |
180 "https://www.googleapis.com/auth/classroom.profile.email
s", | 180 "https://www.googleapis.com/auth/classroom.profile.email
s", |
181 "https://www.googleapis.com/auth/classroom.profile.photo
s", | 181 "https://www.googleapis.com/auth/classroom.profile.photo
s", |
182 "https://www.googleapis.com/auth/classroom.rosters", | 182 "https://www.googleapis.com/auth/classroom.rosters", |
183 "https://www.googleapis.com/auth/classroom.rosters.reado
nly" | 183 "https://www.googleapis.com/auth/classroom.rosters.reado
nly" |
184 ] | 184 ] |
185 } | 185 } |
186 }, | 186 }, |
187 "resources": { | 187 "resources": { |
188 "guardianInvitations": { | 188 "guardians": { |
189 "methods": { | 189 "methods": { |
190 "patch": { | 190 "delete": { |
191 "description": "Modifies a guardian invitation.\n\nC
urrently, the only valid modification is to change the `state` from\n`PENDING` t
o `COMPLETE`. This has the effect of withdrawing the invitation.\n\nThis method
returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user
does not have permission to\n manage guardians, if guardians are not enabled fo
r the domain in question\n or for other access errors.\n* `FAILED_PRECONDITION`
if the guardian link is not in the `PENDING` state.\n* `INVALID_ARGUMENT` if th
e format of the student ID provided\n cannot be recognized (it is not an email
address, nor a `user_id` from\n this API), or if the passed `GuardianInvitation
` has a `state` other than\n `COMPLETE`, or if it modifies fields other than `s
tate`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n C
lassroom has no record of that student, or if the `id` field does not\n refer t
o a guardian invitation known to Classroom.", | 191 "description": "Deletes a guardian.\n\nThe guardian
will no longer receive guardian notifications and the guardian\nwill no longer b
e accessible via the API.\n\nThis method returns the following error codes:\n\n*
`PERMISSION_DENIED` if no user that matches the provided `student_id`\n is vis
ible to the requesting user, if the requesting user is not\n permitted to manag
e guardians for the student identified by the\n `student_id`, if guardians are
not enabled for the domain in question,\n or for other access errors.\n* `INVAL
ID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recogni
zed (it is not an email address, nor a `student_id` from the\n API).\n* `NOT_FO
UND` if the requesting user is permitted to modify guardians for\n the requeste
d `student_id`, but no `Guardian` record exists for that\n student with the pro
vided `guardian_id`.", |
192 "httpMethod": "PATCH", | 192 "httpMethod": "DELETE", |
193 "id": "classroom.userProfiles.guardianInvitations.pa
tch", | 193 "id": "classroom.userProfiles.guardians.delete", |
194 "parameterOrder": [ | 194 "parameterOrder": [ |
195 "studentId", | 195 "studentId", |
196 "invitationId" | 196 "guardianId" |
197 ], | 197 ], |
198 "parameters": { | 198 "parameters": { |
199 "updateMask": { | 199 "studentId": { |
200 "description": "Mask that identifies which f
ields on the course to update.\nThis field is required to do an update. The upda
te will fail if invalid\nfields are specified. The following fields are valid:\n
\n* `state`\n\nWhen set in a query parameter, this field should be specified as\
n\n`updateMask=<field1>,<field2>,...`", | 200 "description": "The student whose guardian i
s to be deleted. One of the following:\n\n* the numeric identifier for the user\
n* the email address of the user\n* the string literal `\"me\"`, indicating the
requesting user", |
201 "format": "google-fieldmask", | |
202 "location": "query", | |
203 "type": "string" | |
204 }, | |
205 "invitationId": { | |
206 "description": "The `id` field of the `Guard
ianInvitation` to be modified.", | |
207 "location": "path", | 201 "location": "path", |
208 "required": true, | 202 "required": true, |
209 "type": "string" | 203 "type": "string" |
210 }, | 204 }, |
211 "studentId": { | 205 "guardianId": { |
212 "description": "The ID of the student whose
guardian invitation is to be modified.", | 206 "description": "The `id` field from a `Guard
ian`.", |
213 "location": "path", | 207 "location": "path", |
214 "required": true, | 208 "required": true, |
215 "type": "string" | 209 "type": "string" |
216 } | 210 } |
217 }, | 211 }, |
218 "path": "v1/userProfiles/{studentId}/guardianInvitat
ions/{invitationId}", | 212 "path": "v1/userProfiles/{studentId}/guardians/{guar
dianId}", |
219 "request": { | |
220 "$ref": "GuardianInvitation" | |
221 }, | |
222 "response": { | 213 "response": { |
223 "$ref": "GuardianInvitation" | 214 "$ref": "Empty" |
224 }, | 215 }, |
225 "scopes": [ | 216 "scopes": [ |
226 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students" | 217 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students" |
227 ] | 218 ] |
228 }, | 219 }, |
229 "get": { | 220 "get": { |
230 "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.", | 221 "description": "Returns a specific guardian.\n\nThis
method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user t
hat matches the provided `student_id`\n is visible to the requesting user, if t
he requesting user is not\n permitted to view guardian information for the stud
ent identified by the\n `student_id`, if guardians are not enabled for the doma
in in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `stude
nt_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 literal string `me`).\n* `N
OT_FOUND` if the requesting user is permitted to view guardians for\n the reque
sted `student_id`, but no `Guardian` record exists for that\n student that matc
hes the provided `guardian_id`.", |
231 "httpMethod": "GET", | 222 "httpMethod": "GET", |
232 "id": "classroom.userProfiles.guardianInvitations.ge
t", | 223 "id": "classroom.userProfiles.guardians.get", |
233 "parameterOrder": [ | 224 "parameterOrder": [ |
234 "studentId", | 225 "studentId", |
235 "invitationId" | 226 "guardianId" |
236 ], | 227 ], |
237 "parameters": { | 228 "parameters": { |
238 "invitationId": { | 229 "studentId": { |
239 "description": "The `id` field of the `Guard
ianInvitation` being requested.", | 230 "description": "The student whose guardian i
s being requested. One of the following:\n\n* the numeric identifier for the use
r\n* the email address of the user\n* the string literal `\"me\"`, indicating th
e requesting user", |
240 "location": "path", | 231 "location": "path", |
241 "required": true, | 232 "required": true, |
242 "type": "string" | 233 "type": "string" |
243 }, | 234 }, |
244 "studentId": { | 235 "guardianId": { |
245 "description": "The ID of the student whose
guardian invitation is being requested.", | 236 "description": "The `id` field from a `Guard
ian`.", |
246 "location": "path", | 237 "location": "path", |
247 "required": true, | 238 "required": true, |
248 "type": "string" | 239 "type": "string" |
249 } | 240 } |
250 }, | 241 }, |
251 "path": "v1/userProfiles/{studentId}/guardianInvitat
ions/{invitationId}", | 242 "path": "v1/userProfiles/{studentId}/guardians/{guar
dianId}", |
252 "response": { | 243 "response": { |
253 "$ref": "GuardianInvitation" | 244 "$ref": "Guardian" |
254 }, | 245 }, |
255 "scopes": [ | 246 "scopes": [ |
| 247 "https://www.googleapis.com/auth/classroom.guard
ianlinks.me.readonly", |
256 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students", | 248 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students", |
257 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students.readonly" | 249 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students.readonly" |
258 ] | 250 ] |
259 }, | 251 }, |
260 "list": { | 252 "list": { |
261 "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.", | 253 "description": "Returns a list of guardians that the
requesting user is permitted to\nview, restricted to those that match the reque
st.\n\nTo list guardians for any student that the requesting user may view\nguar
dians for, use the literal character `-` for the student ID.\n\nThis method retu
rns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is spe
cified, and the requesting\n user is not permitted to view guardian information
for that student, if\n `\"-\"` is specified as the `student_id` and the user i
s not a domain\n administrator, if guardians are not enabled for the domain in
question,\n if the `invited_email_address` filter is set by a user who is not a
\n domain administrator, 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 literal string `me`)
. May also be returned if an invalid\n `page_token` is provided.\n* `NOT_FOUND`
if a `student_id` is specified, and its format can be\n recognized, but Classr
oom has no record of that student.", |
262 "httpMethod": "GET", | 254 "httpMethod": "GET", |
263 "id": "classroom.userProfiles.guardianInvitations.li
st", | 255 "id": "classroom.userProfiles.guardians.list", |
264 "parameterOrder": [ | 256 "parameterOrder": [ |
265 "studentId" | 257 "studentId" |
266 ], | 258 ], |
267 "parameters": { | 259 "parameters": { |
268 "studentId": { | 260 "studentId": { |
269 "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.", | 261 "description": "Filter results by the studen
t who the guardian is linked to.\nThe identifier can be one of the following:\n\
n* the numeric identifier for the user\n* the email address of the user\n* the s
tring literal `\"me\"`, indicating the requesting user\n* the string literal `\"
-\"`, indicating that results should be returned for\n all students that the re
questing user has access to view.", |
270 "location": "path", | 262 "location": "path", |
271 "required": true, | 263 "required": true, |
272 "type": "string" | 264 "type": "string" |
273 }, | 265 }, |
274 "pageToken": { | 266 "pageToken": { |
275 "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.", | 267 "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.", |
276 "location": "query", | 268 "location": "query", |
277 "type": "string" | 269 "type": "string" |
278 }, | 270 }, |
279 "pageSize": { | 271 "pageSize": { |
280 "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.", | 272 "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.", |
281 "format": "int32", | 273 "format": "int32", |
282 "location": "query", | 274 "location": "query", |
283 "type": "integer" | 275 "type": "integer" |
284 }, | 276 }, |
| 277 "invitedEmailAddress": { |
| 278 "description": "Filter results by the email
address that the original invitation was sent\nto, resulting in this guardian li
nk.\nThis filter can only be used by domain administrators.", |
| 279 "location": "query", |
| 280 "type": "string" |
| 281 } |
| 282 }, |
| 283 "path": "v1/userProfiles/{studentId}/guardians", |
| 284 "response": { |
| 285 "$ref": "ListGuardiansResponse" |
| 286 }, |
| 287 "scopes": [ |
| 288 "https://www.googleapis.com/auth/classroom.guard
ianlinks.me.readonly", |
| 289 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students", |
| 290 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students.readonly" |
| 291 ] |
| 292 } |
| 293 } |
| 294 }, |
| 295 "guardianInvitations": { |
| 296 "methods": { |
| 297 "patch": { |
| 298 "description": "Modifies a guardian invitation.\n\nC
urrently, the only valid modification is to change the `state` from\n`PENDING` t
o `COMPLETE`. This has the effect of withdrawing the invitation.\n\nThis method
returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user
does not have permission to\n manage guardians, if guardians are not enabled fo
r the domain in question\n or for other access errors.\n* `FAILED_PRECONDITION`
if the guardian link is not in the `PENDING` state.\n* `INVALID_ARGUMENT` if th
e format of the student ID provided\n cannot be recognized (it is not an email
address, nor a `user_id` from\n this API), or if the passed `GuardianInvitation
` has a `state` other than\n `COMPLETE`, or if it modifies fields other than `s
tate`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n C
lassroom has no record of that student, or if the `id` field does not\n refer t
o a guardian invitation known to Classroom.", |
| 299 "httpMethod": "PATCH", |
| 300 "id": "classroom.userProfiles.guardianInvitations.pa
tch", |
| 301 "parameterOrder": [ |
| 302 "studentId", |
| 303 "invitationId" |
| 304 ], |
| 305 "parameters": { |
| 306 "studentId": { |
| 307 "description": "The ID of the student whose
guardian invitation is to be modified.", |
| 308 "location": "path", |
| 309 "required": true, |
| 310 "type": "string" |
| 311 }, |
| 312 "updateMask": { |
| 313 "description": "Mask that identifies which f
ields on the course to update.\nThis field is required to do an update. The upda
te will fail if invalid\nfields are specified. The following fields are valid:\n
\n* `state`\n\nWhen set in a query parameter, this field should be specified as\
n\n`updateMask=<field1>,<field2>,...`", |
| 314 "format": "google-fieldmask", |
| 315 "location": "query", |
| 316 "type": "string" |
| 317 }, |
| 318 "invitationId": { |
| 319 "description": "The `id` field of the `Guard
ianInvitation` to be modified.", |
| 320 "location": "path", |
| 321 "required": true, |
| 322 "type": "string" |
| 323 } |
| 324 }, |
| 325 "path": "v1/userProfiles/{studentId}/guardianInvitat
ions/{invitationId}", |
| 326 "request": { |
| 327 "$ref": "GuardianInvitation" |
| 328 }, |
| 329 "response": { |
| 330 "$ref": "GuardianInvitation" |
| 331 }, |
| 332 "scopes": [ |
| 333 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students" |
| 334 ] |
| 335 }, |
| 336 "get": { |
| 337 "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.", |
| 338 "httpMethod": "GET", |
| 339 "id": "classroom.userProfiles.guardianInvitations.ge
t", |
| 340 "parameterOrder": [ |
| 341 "studentId", |
| 342 "invitationId" |
| 343 ], |
| 344 "parameters": { |
| 345 "invitationId": { |
| 346 "description": "The `id` field of the `Guard
ianInvitation` being requested.", |
| 347 "location": "path", |
| 348 "required": true, |
| 349 "type": "string" |
| 350 }, |
| 351 "studentId": { |
| 352 "description": "The ID of the student whose
guardian invitation is being requested.", |
| 353 "location": "path", |
| 354 "required": true, |
| 355 "type": "string" |
| 356 } |
| 357 }, |
| 358 "path": "v1/userProfiles/{studentId}/guardianInvitat
ions/{invitationId}", |
| 359 "response": { |
| 360 "$ref": "GuardianInvitation" |
| 361 }, |
| 362 "scopes": [ |
| 363 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students", |
| 364 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students.readonly" |
| 365 ] |
| 366 }, |
| 367 "list": { |
| 368 "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.", |
| 369 "httpMethod": "GET", |
| 370 "id": "classroom.userProfiles.guardianInvitations.li
st", |
| 371 "parameterOrder": [ |
| 372 "studentId" |
| 373 ], |
| 374 "parameters": { |
| 375 "pageSize": { |
| 376 "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.", |
| 377 "format": "int32", |
| 378 "location": "query", |
| 379 "type": "integer" |
| 380 }, |
285 "states": { | 381 "states": { |
286 "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.", | 382 "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.", |
287 "enum": [ | 383 "enum": [ |
288 "GUARDIAN_INVITATION_STATE_UNSPECIFIED", | 384 "GUARDIAN_INVITATION_STATE_UNSPECIFIED", |
289 "PENDING", | 385 "PENDING", |
290 "COMPLETE" | 386 "COMPLETE" |
291 ], | 387 ], |
292 "location": "query", | 388 "location": "query", |
293 "repeated": true, | 389 "repeated": true, |
294 "type": "string" | 390 "type": "string" |
295 }, | 391 }, |
296 "invitedEmailAddress": { | 392 "invitedEmailAddress": { |
297 "description": "If specified, only results w
ith the specified `invited_email_address`\nwill be returned.", | 393 "description": "If specified, only results w
ith the specified `invited_email_address`\nwill be returned.", |
298 "location": "query", | 394 "location": "query", |
299 "type": "string" | 395 "type": "string" |
| 396 }, |
| 397 "studentId": { |
| 398 "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.", |
| 399 "location": "path", |
| 400 "required": true, |
| 401 "type": "string" |
| 402 }, |
| 403 "pageToken": { |
| 404 "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.", |
| 405 "location": "query", |
| 406 "type": "string" |
300 } | 407 } |
301 }, | 408 }, |
302 "path": "v1/userProfiles/{studentId}/guardianInvitat
ions", | 409 "path": "v1/userProfiles/{studentId}/guardianInvitat
ions", |
303 "response": { | 410 "response": { |
304 "$ref": "ListGuardianInvitationsResponse" | 411 "$ref": "ListGuardianInvitationsResponse" |
305 }, | 412 }, |
306 "scopes": [ | 413 "scopes": [ |
307 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students", | 414 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students", |
308 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students.readonly" | 415 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students.readonly" |
309 ] | 416 ] |
(...skipping 18 matching lines...) Expand all Loading... |
328 "$ref": "GuardianInvitation" | 435 "$ref": "GuardianInvitation" |
329 }, | 436 }, |
330 "response": { | 437 "response": { |
331 "$ref": "GuardianInvitation" | 438 "$ref": "GuardianInvitation" |
332 }, | 439 }, |
333 "scopes": [ | 440 "scopes": [ |
334 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students" | 441 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students" |
335 ] | 442 ] |
336 } | 443 } |
337 } | 444 } |
338 }, | |
339 "guardians": { | |
340 "methods": { | |
341 "delete": { | |
342 "description": "Deletes a guardian.\n\nThe guardian
will no longer receive guardian notifications and the guardian\nwill no longer b
e accessible via the API.\n\nThis method returns the following error codes:\n\n*
`PERMISSION_DENIED` if no user that matches the provided `student_id`\n is vis
ible to the requesting user, if the requesting user is not\n permitted to manag
e guardians for the student identified by the\n `student_id`, if guardians are
not enabled for the domain in question,\n or for other access errors.\n* `INVAL
ID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recogni
zed (it is not an email address, nor a `student_id` from the\n API).\n* `NOT_FO
UND` if the requesting user is permitted to modify guardians for\n the requeste
d `student_id`, but no `Guardian` record exists for that\n student with the pro
vided `guardian_id`.", | |
343 "httpMethod": "DELETE", | |
344 "id": "classroom.userProfiles.guardians.delete", | |
345 "parameterOrder": [ | |
346 "studentId", | |
347 "guardianId" | |
348 ], | |
349 "parameters": { | |
350 "studentId": { | |
351 "description": "The student whose guardian i
s to be deleted. One of the following:\n\n* the numeric identifier for the user\
n* the email address of the user\n* the string literal `\"me\"`, indicating the
requesting user", | |
352 "location": "path", | |
353 "required": true, | |
354 "type": "string" | |
355 }, | |
356 "guardianId": { | |
357 "description": "The `id` field from a `Guard
ian`.", | |
358 "location": "path", | |
359 "required": true, | |
360 "type": "string" | |
361 } | |
362 }, | |
363 "path": "v1/userProfiles/{studentId}/guardians/{guar
dianId}", | |
364 "response": { | |
365 "$ref": "Empty" | |
366 }, | |
367 "scopes": [ | |
368 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students" | |
369 ] | |
370 }, | |
371 "get": { | |
372 "description": "Returns a specific guardian.\n\nThis
method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user t
hat matches the provided `student_id`\n is visible to the requesting user, if t
he requesting user is not\n permitted to view guardian information for the stud
ent identified by the\n `student_id`, if guardians are not enabled for the doma
in in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `stude
nt_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 literal string `me`).\n* `N
OT_FOUND` if the requesting user is permitted to view guardians for\n the reque
sted `student_id`, but no `Guardian` record exists for that\n student that matc
hes the provided `guardian_id`.", | |
373 "httpMethod": "GET", | |
374 "id": "classroom.userProfiles.guardians.get", | |
375 "parameterOrder": [ | |
376 "studentId", | |
377 "guardianId" | |
378 ], | |
379 "parameters": { | |
380 "studentId": { | |
381 "description": "The student whose guardian i
s being requested. One of the following:\n\n* the numeric identifier for the use
r\n* the email address of the user\n* the string literal `\"me\"`, indicating th
e requesting user", | |
382 "location": "path", | |
383 "required": true, | |
384 "type": "string" | |
385 }, | |
386 "guardianId": { | |
387 "description": "The `id` field from a `Guard
ian`.", | |
388 "location": "path", | |
389 "required": true, | |
390 "type": "string" | |
391 } | |
392 }, | |
393 "path": "v1/userProfiles/{studentId}/guardians/{guar
dianId}", | |
394 "response": { | |
395 "$ref": "Guardian" | |
396 }, | |
397 "scopes": [ | |
398 "https://www.googleapis.com/auth/classroom.guard
ianlinks.me.readonly", | |
399 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students", | |
400 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students.readonly" | |
401 ] | |
402 }, | |
403 "list": { | |
404 "description": "Returns a list of guardians that the
requesting user is permitted to\nview, restricted to those that match the reque
st.\n\nTo list guardians for any student that the requesting user may view\nguar
dians for, use the literal character `-` for the student ID.\n\nThis method retu
rns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is spe
cified, and the requesting\n user is not permitted to view guardian information
for that student, if\n `\"-\"` is specified as the `student_id` and the user i
s not a domain\n administrator, if guardians are not enabled for the domain in
question,\n if the `invited_email_address` filter is set by a user who is not a
\n domain administrator, 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 literal string `me`)
. May also be returned if an invalid\n `page_token` is provided.\n* `NOT_FOUND`
if a `student_id` is specified, and its format can be\n recognized, but Classr
oom has no record of that student.", | |
405 "httpMethod": "GET", | |
406 "id": "classroom.userProfiles.guardians.list", | |
407 "parameterOrder": [ | |
408 "studentId" | |
409 ], | |
410 "parameters": { | |
411 "studentId": { | |
412 "description": "Filter results by the studen
t who the guardian is linked to.\nThe identifier can be one of the following:\n\
n* the numeric identifier for the user\n* the email address of the user\n* the s
tring literal `\"me\"`, indicating the requesting user\n* the string literal `\"
-\"`, indicating that results should be returned for\n all students that the re
questing user has access to view.", | |
413 "location": "path", | |
414 "required": true, | |
415 "type": "string" | |
416 }, | |
417 "pageToken": { | |
418 "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.", | |
419 "location": "query", | |
420 "type": "string" | |
421 }, | |
422 "pageSize": { | |
423 "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.", | |
424 "format": "int32", | |
425 "location": "query", | |
426 "type": "integer" | |
427 }, | |
428 "invitedEmailAddress": { | |
429 "description": "Filter results by the email
address that the original invitation was sent\nto, resulting in this guardian li
nk.\nThis filter can only be used by domain administrators.", | |
430 "location": "query", | |
431 "type": "string" | |
432 } | |
433 }, | |
434 "path": "v1/userProfiles/{studentId}/guardians", | |
435 "response": { | |
436 "$ref": "ListGuardiansResponse" | |
437 }, | |
438 "scopes": [ | |
439 "https://www.googleapis.com/auth/classroom.guard
ianlinks.me.readonly", | |
440 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students", | |
441 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students.readonly" | |
442 ] | |
443 } | |
444 } | |
445 } | 445 } |
446 } | 446 } |
447 }, | 447 }, |
448 "courses": { | 448 "courses": { |
449 "methods": { | 449 "methods": { |
450 "patch": { | |
451 "description": "Updates one or more fields in a course.\n\nT
his method returns the following error codes:\n\n* `PERMISSION_DENIED` if the re
questing user is not permitted to modify the\nrequested course or for access err
ors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `INVALID_ARGUM
ENT` if invalid fields are specified in the update mask or\nif no update mask is
supplied.\n* `FAILED_PRECONDITION` for the following request errors:\n * Cou
rseNotModifiable", | |
452 "httpMethod": "PATCH", | |
453 "id": "classroom.courses.patch", | |
454 "parameterOrder": [ | |
455 "id" | |
456 ], | |
457 "parameters": { | |
458 "id": { | |
459 "description": "Identifier of the course to update.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", | |
460 "location": "path", | |
461 "required": true, | |
462 "type": "string" | |
463 }, | |
464 "updateMask": { | |
465 "description": "Mask that identifies which fields on
the course to update.\nThis field is required to do an update. The update will
fail if invalid\nfields are specified. The following fields are valid:\n\n* `nam
e`\n* `section`\n* `descriptionHeading`\n* `description`\n* `room`\n* `courseSta
te`\n\nWhen set in a query parameter, this field should be specified as\n\n`upda
teMask=<field1>,<field2>,...`", | |
466 "format": "google-fieldmask", | |
467 "location": "query", | |
468 "type": "string" | |
469 } | |
470 }, | |
471 "path": "v1/courses/{id}", | |
472 "request": { | |
473 "$ref": "Course" | |
474 }, | |
475 "response": { | |
476 "$ref": "Course" | |
477 }, | |
478 "scopes": [ | |
479 "https://www.googleapis.com/auth/classroom.courses" | |
480 ] | |
481 }, | |
482 "get": { | |
483 "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.", | |
484 "httpMethod": "GET", | |
485 "id": "classroom.courses.get", | |
486 "parameterOrder": [ | |
487 "id" | |
488 ], | |
489 "parameters": { | |
490 "id": { | |
491 "description": "Identifier of the course to return.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", | |
492 "location": "path", | |
493 "required": true, | |
494 "type": "string" | |
495 } | |
496 }, | |
497 "path": "v1/courses/{id}", | |
498 "response": { | |
499 "$ref": "Course" | |
500 }, | |
501 "scopes": [ | |
502 "https://www.googleapis.com/auth/classroom.courses", | |
503 "https://www.googleapis.com/auth/classroom.courses.reado
nly" | |
504 ] | |
505 }, | |
506 "update": { | |
507 "description": "Updates a course.\n\nThis method returns the
following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not p
ermitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if
no course exists with the requested ID.\n* `FAILED_PRECONDITION` for the follow
ing request errors:\n * CourseNotModifiable", | |
508 "httpMethod": "PUT", | |
509 "id": "classroom.courses.update", | |
510 "parameterOrder": [ | |
511 "id" | |
512 ], | |
513 "parameters": { | |
514 "id": { | |
515 "description": "Identifier of the course to update.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", | |
516 "location": "path", | |
517 "required": true, | |
518 "type": "string" | |
519 } | |
520 }, | |
521 "path": "v1/courses/{id}", | |
522 "request": { | |
523 "$ref": "Course" | |
524 }, | |
525 "response": { | |
526 "$ref": "Course" | |
527 }, | |
528 "scopes": [ | |
529 "https://www.googleapis.com/auth/classroom.courses" | |
530 ] | |
531 }, | |
532 "delete": { | 450 "delete": { |
533 "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.", | 451 "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.", |
534 "httpMethod": "DELETE", | 452 "httpMethod": "DELETE", |
535 "id": "classroom.courses.delete", | 453 "id": "classroom.courses.delete", |
536 "parameterOrder": [ | 454 "parameterOrder": [ |
537 "id" | 455 "id" |
538 ], | 456 ], |
539 "parameters": { | 457 "parameters": { |
540 "id": { | 458 "id": { |
541 "description": "Identifier of the course to delete.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", | 459 "description": "Identifier of the course to delete.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", |
542 "location": "path", | 460 "location": "path", |
543 "required": true, | 461 "required": true, |
544 "type": "string" | 462 "type": "string" |
545 } | 463 } |
546 }, | 464 }, |
547 "path": "v1/courses/{id}", | 465 "path": "v1/courses/{id}", |
548 "response": { | 466 "response": { |
549 "$ref": "Empty" | 467 "$ref": "Empty" |
550 }, | 468 }, |
551 "scopes": [ | 469 "scopes": [ |
552 "https://www.googleapis.com/auth/classroom.courses" | 470 "https://www.googleapis.com/auth/classroom.courses" |
553 ] | 471 ] |
554 }, | 472 }, |
555 "list": { | 473 "list": { |
556 "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.", | 474 "description": "Returns a list of courses that the requestin
g user is permitted to view,\nrestricted to those that match the request. Return
ed courses are ordered by\ncreation time, with the most recently created coming
first.\n\nThis 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.", |
557 "httpMethod": "GET", | 475 "httpMethod": "GET", |
558 "id": "classroom.courses.list", | 476 "id": "classroom.courses.list", |
559 "parameterOrder": [], | 477 "parameterOrder": [], |
560 "parameters": { | 478 "parameters": { |
561 "pageSize": { | |
562 "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.", | |
563 "format": "int32", | |
564 "location": "query", | |
565 "type": "integer" | |
566 }, | |
567 "courseStates": { | 479 "courseStates": { |
568 "description": "Restricts returned courses to those
in one of the specified states\nThe default value is ACTIVE, ARCHIVED, PROVISION
ED, DECLINED.", | 480 "description": "Restricts returned courses to those
in one of the specified states\nThe default value is ACTIVE, ARCHIVED, PROVISION
ED, DECLINED.", |
569 "enum": [ | 481 "enum": [ |
570 "COURSE_STATE_UNSPECIFIED", | 482 "COURSE_STATE_UNSPECIFIED", |
571 "ACTIVE", | 483 "ACTIVE", |
572 "ARCHIVED", | 484 "ARCHIVED", |
573 "PROVISIONED", | 485 "PROVISIONED", |
574 "DECLINED", | 486 "DECLINED", |
575 "SUSPENDED" | 487 "SUSPENDED" |
576 ], | 488 ], |
577 "location": "query", | 489 "location": "query", |
578 "repeated": true, | 490 "repeated": true, |
579 "type": "string" | 491 "type": "string" |
580 }, | 492 }, |
581 "teacherId": { | 493 "teacherId": { |
582 "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", | 494 "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", |
583 "location": "query", | 495 "location": "query", |
584 "type": "string" | 496 "type": "string" |
585 }, | 497 }, |
586 "studentId": { | 498 "studentId": { |
587 "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", | 499 "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", |
588 "location": "query", | 500 "location": "query", |
589 "type": "string" | 501 "type": "string" |
590 }, | 502 }, |
591 "pageToken": { | 503 "pageToken": { |
592 "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.", | 504 "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.", |
593 "location": "query", | 505 "location": "query", |
594 "type": "string" | 506 "type": "string" |
| 507 }, |
| 508 "pageSize": { |
| 509 "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.", |
| 510 "format": "int32", |
| 511 "location": "query", |
| 512 "type": "integer" |
595 } | 513 } |
596 }, | 514 }, |
597 "path": "v1/courses", | 515 "path": "v1/courses", |
598 "response": { | 516 "response": { |
599 "$ref": "ListCoursesResponse" | 517 "$ref": "ListCoursesResponse" |
600 }, | 518 }, |
601 "scopes": [ | 519 "scopes": [ |
602 "https://www.googleapis.com/auth/classroom.courses", | 520 "https://www.googleapis.com/auth/classroom.courses", |
603 "https://www.googleapis.com/auth/classroom.courses.reado
nly" | 521 "https://www.googleapis.com/auth/classroom.courses.reado
nly" |
604 ] | 522 ] |
605 }, | 523 }, |
606 "create": { | 524 "create": { |
607 "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.", | 525 "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.", |
608 "httpMethod": "POST", | 526 "httpMethod": "POST", |
609 "id": "classroom.courses.create", | 527 "id": "classroom.courses.create", |
610 "parameterOrder": [], | 528 "parameterOrder": [], |
611 "parameters": {}, | 529 "parameters": {}, |
612 "path": "v1/courses", | 530 "path": "v1/courses", |
613 "request": { | 531 "request": { |
614 "$ref": "Course" | 532 "$ref": "Course" |
615 }, | 533 }, |
616 "response": { | 534 "response": { |
617 "$ref": "Course" | 535 "$ref": "Course" |
618 }, | 536 }, |
619 "scopes": [ | 537 "scopes": [ |
620 "https://www.googleapis.com/auth/classroom.courses" | 538 "https://www.googleapis.com/auth/classroom.courses" |
621 ] | 539 ] |
| 540 }, |
| 541 "patch": { |
| 542 "description": "Updates one or more fields in a course.\n\nT
his method returns the following error codes:\n\n* `PERMISSION_DENIED` if the re
questing user is not permitted to modify the\nrequested course or for access err
ors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `INVALID_ARGUM
ENT` if invalid fields are specified in the update mask or\nif no update mask is
supplied.\n* `FAILED_PRECONDITION` for the following request errors:\n * Cou
rseNotModifiable", |
| 543 "httpMethod": "PATCH", |
| 544 "id": "classroom.courses.patch", |
| 545 "parameterOrder": [ |
| 546 "id" |
| 547 ], |
| 548 "parameters": { |
| 549 "id": { |
| 550 "description": "Identifier of the course to update.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", |
| 551 "location": "path", |
| 552 "required": true, |
| 553 "type": "string" |
| 554 }, |
| 555 "updateMask": { |
| 556 "description": "Mask that identifies which fields on
the course to update.\nThis field is required to do an update. The update will
fail if invalid\nfields are specified. The following fields are valid:\n\n* `nam
e`\n* `section`\n* `descriptionHeading`\n* `description`\n* `room`\n* `courseSta
te`\n* `ownerId`\n\nNote: patches to ownerId are treated as being effective imme
diately, but in\npractice it may take some time for the ownership transfer of al
l affected\nresources to complete.\n\nWhen set in a query parameter, this field
should be specified as\n\n`updateMask=<field1>,<field2>,...`", |
| 557 "format": "google-fieldmask", |
| 558 "location": "query", |
| 559 "type": "string" |
| 560 } |
| 561 }, |
| 562 "path": "v1/courses/{id}", |
| 563 "request": { |
| 564 "$ref": "Course" |
| 565 }, |
| 566 "response": { |
| 567 "$ref": "Course" |
| 568 }, |
| 569 "scopes": [ |
| 570 "https://www.googleapis.com/auth/classroom.courses" |
| 571 ] |
| 572 }, |
| 573 "get": { |
| 574 "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.", |
| 575 "httpMethod": "GET", |
| 576 "id": "classroom.courses.get", |
| 577 "parameterOrder": [ |
| 578 "id" |
| 579 ], |
| 580 "parameters": { |
| 581 "id": { |
| 582 "description": "Identifier of the course to return.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", |
| 583 "location": "path", |
| 584 "required": true, |
| 585 "type": "string" |
| 586 } |
| 587 }, |
| 588 "path": "v1/courses/{id}", |
| 589 "response": { |
| 590 "$ref": "Course" |
| 591 }, |
| 592 "scopes": [ |
| 593 "https://www.googleapis.com/auth/classroom.courses", |
| 594 "https://www.googleapis.com/auth/classroom.courses.reado
nly" |
| 595 ] |
| 596 }, |
| 597 "update": { |
| 598 "description": "Updates a course.\n\nThis method returns the
following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not p
ermitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if
no course exists with the requested ID.\n* `FAILED_PRECONDITION` for the follow
ing request errors:\n * CourseNotModifiable", |
| 599 "httpMethod": "PUT", |
| 600 "id": "classroom.courses.update", |
| 601 "parameterOrder": [ |
| 602 "id" |
| 603 ], |
| 604 "parameters": { |
| 605 "id": { |
| 606 "description": "Identifier of the course to update.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", |
| 607 "location": "path", |
| 608 "required": true, |
| 609 "type": "string" |
| 610 } |
| 611 }, |
| 612 "path": "v1/courses/{id}", |
| 613 "request": { |
| 614 "$ref": "Course" |
| 615 }, |
| 616 "response": { |
| 617 "$ref": "Course" |
| 618 }, |
| 619 "scopes": [ |
| 620 "https://www.googleapis.com/auth/classroom.courses" |
| 621 ] |
622 } | 622 } |
623 }, | 623 }, |
624 "resources": { | 624 "resources": { |
625 "aliases": { | 625 "aliases": { |
626 "methods": { | 626 "methods": { |
627 "delete": { | 627 "delete": { |
628 "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).", | 628 "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).", |
629 "httpMethod": "DELETE", | 629 "httpMethod": "DELETE", |
630 "id": "classroom.courses.aliases.delete", | 630 "id": "classroom.courses.aliases.delete", |
631 "parameterOrder": [ | 631 "parameterOrder": [ |
632 "courseId", | 632 "courseId", |
633 "alias" | 633 "alias" |
634 ], | 634 ], |
635 "parameters": { | 635 "parameters": { |
| 636 "alias": { |
| 637 "description": "Alias to delete.\nThis may n
ot be the Classroom-assigned identifier.", |
| 638 "location": "path", |
| 639 "required": true, |
| 640 "type": "string" |
| 641 }, |
636 "courseId": { | 642 "courseId": { |
637 "description": "Identifier of the course who
se alias should be deleted.\nThis identifier can be either the Classroom-assigne
d identifier or an\nalias.", | 643 "description": "Identifier of the course who
se alias should be deleted.\nThis identifier can be either the Classroom-assigne
d identifier or an\nalias.", |
638 "location": "path", | 644 "location": "path", |
639 "required": true, | 645 "required": true, |
640 "type": "string" | 646 "type": "string" |
641 }, | |
642 "alias": { | |
643 "description": "Alias to delete.\nThis may n
ot be the Classroom-assigned identifier.", | |
644 "location": "path", | |
645 "required": true, | |
646 "type": "string" | |
647 } | 647 } |
648 }, | 648 }, |
649 "path": "v1/courses/{courseId}/aliases/{alias}", | 649 "path": "v1/courses/{courseId}/aliases/{alias}", |
650 "response": { | 650 "response": { |
651 "$ref": "Empty" | 651 "$ref": "Empty" |
652 }, | 652 }, |
653 "scopes": [ | 653 "scopes": [ |
654 "https://www.googleapis.com/auth/classroom.cours
es" | 654 "https://www.googleapis.com/auth/classroom.cours
es" |
655 ] | 655 ] |
656 }, | 656 }, |
(...skipping 64 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
721 "methods": { | 721 "methods": { |
722 "delete": { | 722 "delete": { |
723 "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.", | 723 "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.", |
724 "httpMethod": "DELETE", | 724 "httpMethod": "DELETE", |
725 "id": "classroom.courses.students.delete", | 725 "id": "classroom.courses.students.delete", |
726 "parameterOrder": [ | 726 "parameterOrder": [ |
727 "courseId", | 727 "courseId", |
728 "userId" | 728 "userId" |
729 ], | 729 ], |
730 "parameters": { | 730 "parameters": { |
| 731 "courseId": { |
| 732 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
| 733 "location": "path", |
| 734 "required": true, |
| 735 "type": "string" |
| 736 }, |
731 "userId": { | 737 "userId": { |
732 "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", | 738 "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", |
733 "location": "path", | 739 "location": "path", |
734 "required": true, | 740 "required": true, |
735 "type": "string" | 741 "type": "string" |
736 }, | |
737 "courseId": { | |
738 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | |
739 "location": "path", | |
740 "required": true, | |
741 "type": "string" | |
742 } | 742 } |
743 }, | 743 }, |
744 "path": "v1/courses/{courseId}/students/{userId}", | 744 "path": "v1/courses/{courseId}/students/{userId}", |
745 "response": { | 745 "response": { |
746 "$ref": "Empty" | 746 "$ref": "Empty" |
747 }, | 747 }, |
748 "scopes": [ | 748 "scopes": [ |
749 "https://www.googleapis.com/auth/classroom.roste
rs" | 749 "https://www.googleapis.com/auth/classroom.roste
rs" |
750 ] | 750 ] |
751 }, | 751 }, |
752 "list": { | 752 "list": { |
753 "description": "Returns a list of students 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.", | 753 "description": "Returns a list of students 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.", |
754 "httpMethod": "GET", | 754 "httpMethod": "GET", |
755 "id": "classroom.courses.students.list", | 755 "id": "classroom.courses.students.list", |
756 "parameterOrder": [ | 756 "parameterOrder": [ |
757 "courseId" | 757 "courseId" |
758 ], | 758 ], |
759 "parameters": { | 759 "parameters": { |
| 760 "pageToken": { |
| 761 "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.", |
| 762 "location": "query", |
| 763 "type": "string" |
| 764 }, |
760 "pageSize": { | 765 "pageSize": { |
761 "description": "Maximum number of items to r
eturn. Zero means no maximum.\n\nThe server may return fewer than the specified
number of results.", | 766 "description": "Maximum number of items to r
eturn. Zero means no maximum.\n\nThe server may return fewer than the specified
number of results.", |
762 "format": "int32", | 767 "format": "int32", |
763 "location": "query", | 768 "location": "query", |
764 "type": "integer" | 769 "type": "integer" |
765 }, | 770 }, |
766 "courseId": { | 771 "courseId": { |
767 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | 772 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
768 "location": "path", | 773 "location": "path", |
769 "required": true, | 774 "required": true, |
770 "type": "string" | 775 "type": "string" |
771 }, | |
772 "pageToken": { | |
773 "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.", | |
774 "location": "query", | |
775 "type": "string" | |
776 } | 776 } |
777 }, | 777 }, |
778 "path": "v1/courses/{courseId}/students", | 778 "path": "v1/courses/{courseId}/students", |
779 "response": { | 779 "response": { |
780 "$ref": "ListStudentsResponse" | 780 "$ref": "ListStudentsResponse" |
781 }, | 781 }, |
782 "scopes": [ | 782 "scopes": [ |
783 "https://www.googleapis.com/auth/classroom.profi
le.emails", | 783 "https://www.googleapis.com/auth/classroom.profi
le.emails", |
784 "https://www.googleapis.com/auth/classroom.profi
le.photos", | 784 "https://www.googleapis.com/auth/classroom.profi
le.photos", |
785 "https://www.googleapis.com/auth/classroom.roste
rs", | 785 "https://www.googleapis.com/auth/classroom.roste
rs", |
(...skipping 72 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
858 "methods": { | 858 "methods": { |
859 "delete": { | 859 "delete": { |
860 "description": "Deletes a course work.\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 developer project did not create\nthe corresponding
course work, if the requesting user is not permitted\nto delete the requested c
ourse or for access errors.\n* `FAILED_PRECONDITION` if the requested course wor
k has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the request
ed ID.", | 860 "description": "Deletes a course work.\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 developer project did not create\nthe corresponding
course work, if the requesting user is not permitted\nto delete the requested c
ourse or for access errors.\n* `FAILED_PRECONDITION` if the requested course wor
k has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the request
ed ID.", |
861 "httpMethod": "DELETE", | 861 "httpMethod": "DELETE", |
862 "id": "classroom.courses.courseWork.delete", | 862 "id": "classroom.courses.courseWork.delete", |
863 "parameterOrder": [ | 863 "parameterOrder": [ |
864 "courseId", | 864 "courseId", |
865 "id" | 865 "id" |
866 ], | 866 ], |
867 "parameters": { | 867 "parameters": { |
| 868 "id": { |
| 869 "description": "Identifier of the course wor
k to delete.\nThis identifier is a Classroom-assigned identifier.", |
| 870 "location": "path", |
| 871 "required": true, |
| 872 "type": "string" |
| 873 }, |
868 "courseId": { | 874 "courseId": { |
869 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | 875 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
870 "location": "path", | 876 "location": "path", |
871 "required": true, | 877 "required": true, |
872 "type": "string" | 878 "type": "string" |
873 }, | |
874 "id": { | |
875 "description": "Identifier of the course wor
k to delete.\nThis identifier is a Classroom-assigned identifier.", | |
876 "location": "path", | |
877 "required": true, | |
878 "type": "string" | |
879 } | 879 } |
880 }, | 880 }, |
881 "path": "v1/courses/{courseId}/courseWork/{id}", | 881 "path": "v1/courses/{courseId}/courseWork/{id}", |
882 "response": { | 882 "response": { |
883 "$ref": "Empty" | 883 "$ref": "Empty" |
884 }, | 884 }, |
885 "scopes": [ | 885 "scopes": [ |
886 "https://www.googleapis.com/auth/classroom.cours
ework.students" | 886 "https://www.googleapis.com/auth/classroom.cours
ework.students" |
887 ] | 887 ] |
888 }, | 888 }, |
889 "list": { | 889 "list": { |
890 "description": "Returns a list of course work that t
he requester is permitted to view.\n\nCourse students may only view `PUBLISHED`
course work. Course teachers\nand domain administrators may view all course work
.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if
the requesting user is not permitted to access\nthe requested course or for acce
ss errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if
the requested course does not exist.", | 890 "description": "Returns a list of course work that t
he requester is permitted to view.\n\nCourse students may only view `PUBLISHED`
course work. Course teachers\nand domain administrators may view all course work
.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if
the requesting user is not permitted to access\nthe requested course or for acce
ss errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if
the requested course does not exist.", |
891 "httpMethod": "GET", | 891 "httpMethod": "GET", |
892 "id": "classroom.courses.courseWork.list", | 892 "id": "classroom.courses.courseWork.list", |
893 "parameterOrder": [ | 893 "parameterOrder": [ |
894 "courseId" | 894 "courseId" |
895 ], | 895 ], |
896 "parameters": { | 896 "parameters": { |
| 897 "pageToken": { |
| 898 "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.", |
| 899 "location": "query", |
| 900 "type": "string" |
| 901 }, |
| 902 "orderBy": { |
| 903 "description": "Optional sort ordering for r
esults. A comma-separated list of fields with\nan optional sort direction keywor
d. Supported fields are `updateTime`\nand `dueDate`. Supported direction keyword
s are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default beha
vior.\nExamples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`", |
| 904 "location": "query", |
| 905 "type": "string" |
| 906 }, |
897 "pageSize": { | 907 "pageSize": { |
898 "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.", | 908 "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.", |
899 "format": "int32", | 909 "format": "int32", |
900 "location": "query", | 910 "location": "query", |
901 "type": "integer" | 911 "type": "integer" |
902 }, | 912 }, |
903 "courseWorkStates": { | 913 "courseWorkStates": { |
904 "description": "Restriction on the work stat
us to return. Only courseWork that matches\nis returned. If unspecified, items w
ith a work status of `PUBLISHED`\nis returned.", | 914 "description": "Restriction on the work stat
us to return. Only courseWork that matches\nis returned. If unspecified, items w
ith a work status of `PUBLISHED`\nis returned.", |
905 "enum": [ | 915 "enum": [ |
906 "COURSE_WORK_STATE_UNSPECIFIED", | 916 "COURSE_WORK_STATE_UNSPECIFIED", |
907 "PUBLISHED", | 917 "PUBLISHED", |
908 "DRAFT", | 918 "DRAFT", |
909 "DELETED" | 919 "DELETED" |
910 ], | 920 ], |
911 "location": "query", | 921 "location": "query", |
912 "repeated": true, | 922 "repeated": true, |
913 "type": "string" | 923 "type": "string" |
914 }, | 924 }, |
915 "courseId": { | 925 "courseId": { |
916 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | 926 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
917 "location": "path", | 927 "location": "path", |
918 "required": true, | 928 "required": true, |
919 "type": "string" | 929 "type": "string" |
920 }, | |
921 "pageToken": { | |
922 "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.", | |
923 "location": "query", | |
924 "type": "string" | |
925 }, | |
926 "orderBy": { | |
927 "description": "Optional sort ordering for r
esults. A comma-separated list of fields with\nan optional sort direction keywor
d. Supported fields are `updateTime`\nand `dueDate`. Supported direction keyword
s are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default beha
vior.\nExamples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`", | |
928 "location": "query", | |
929 "type": "string" | |
930 } | 930 } |
931 }, | 931 }, |
932 "path": "v1/courses/{courseId}/courseWork", | 932 "path": "v1/courses/{courseId}/courseWork", |
933 "response": { | 933 "response": { |
934 "$ref": "ListCourseWorkResponse" | 934 "$ref": "ListCourseWorkResponse" |
935 }, | 935 }, |
936 "scopes": [ | 936 "scopes": [ |
937 "https://www.googleapis.com/auth/classroom.cours
ework.me", | 937 "https://www.googleapis.com/auth/classroom.cours
ework.me", |
938 "https://www.googleapis.com/auth/classroom.cours
ework.me.readonly", | 938 "https://www.googleapis.com/auth/classroom.cours
ework.me.readonly", |
939 "https://www.googleapis.com/auth/classroom.cours
ework.students", | 939 "https://www.googleapis.com/auth/classroom.cours
ework.students", |
940 "https://www.googleapis.com/auth/classroom.cours
ework.students.readonly" | 940 "https://www.googleapis.com/auth/classroom.cours
ework.students.readonly" |
941 ] | 941 ] |
942 }, | 942 }, |
943 "get": { | 943 "get": { |
944 "description": "Returns course work.\n\nThis method
returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting us
er is not permitted to access the\nrequested course or course work, or for acces
s errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if t
he requested course or course work does not exist.", | 944 "description": "Returns course work.\n\nThis method
returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting us
er is not permitted to access the\nrequested course or course work, or for acces
s errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if t
he requested course or course work does not exist.", |
945 "httpMethod": "GET", | 945 "httpMethod": "GET", |
946 "id": "classroom.courses.courseWork.get", | 946 "id": "classroom.courses.courseWork.get", |
947 "parameterOrder": [ | 947 "parameterOrder": [ |
948 "courseId", | 948 "courseId", |
949 "id" | 949 "id" |
950 ], | 950 ], |
951 "parameters": { | 951 "parameters": { |
| 952 "id": { |
| 953 "description": "Identifier of the course wor
k.", |
| 954 "location": "path", |
| 955 "required": true, |
| 956 "type": "string" |
| 957 }, |
952 "courseId": { | 958 "courseId": { |
953 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | 959 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
954 "location": "path", | 960 "location": "path", |
955 "required": true, | 961 "required": true, |
956 "type": "string" | 962 "type": "string" |
957 }, | |
958 "id": { | |
959 "description": "Identifier of the course wor
k.", | |
960 "location": "path", | |
961 "required": true, | |
962 "type": "string" | |
963 } | 963 } |
964 }, | 964 }, |
965 "path": "v1/courses/{courseId}/courseWork/{id}", | 965 "path": "v1/courses/{courseId}/courseWork/{id}", |
966 "response": { | 966 "response": { |
967 "$ref": "CourseWork" | 967 "$ref": "CourseWork" |
968 }, | 968 }, |
969 "scopes": [ | 969 "scopes": [ |
970 "https://www.googleapis.com/auth/classroom.cours
ework.me", | 970 "https://www.googleapis.com/auth/classroom.cours
ework.me", |
971 "https://www.googleapis.com/auth/classroom.cours
ework.me.readonly", | 971 "https://www.googleapis.com/auth/classroom.cours
ework.me.readonly", |
972 "https://www.googleapis.com/auth/classroom.cours
ework.students", | 972 "https://www.googleapis.com/auth/classroom.cours
ework.students", |
973 "https://www.googleapis.com/auth/classroom.cours
ework.students.readonly" | 973 "https://www.googleapis.com/auth/classroom.cours
ework.students.readonly" |
974 ] | 974 ] |
975 }, | 975 }, |
976 "patch": { | 976 "patch": { |
977 "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
.", | 977 "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
.", |
978 "httpMethod": "PATCH", | 978 "httpMethod": "PATCH", |
979 "id": "classroom.courses.courseWork.patch", | 979 "id": "classroom.courses.courseWork.patch", |
980 "parameterOrder": [ | 980 "parameterOrder": [ |
981 "courseId", | 981 "courseId", |
982 "id" | 982 "id" |
983 ], | 983 ], |
984 "parameters": { | 984 "parameters": { |
985 "updateMask": { | |
986 "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* `sche
duled_time`\n* `submission_modification_mode`", | |
987 "format": "google-fieldmask", | |
988 "location": "query", | |
989 "type": "string" | |
990 }, | |
991 "courseId": { | 985 "courseId": { |
992 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | 986 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
993 "location": "path", | 987 "location": "path", |
994 "required": true, | 988 "required": true, |
995 "type": "string" | 989 "type": "string" |
996 }, | 990 }, |
997 "id": { | 991 "id": { |
998 "description": "Identifier of the course wor
k.", | 992 "description": "Identifier of the course wor
k.", |
999 "location": "path", | 993 "location": "path", |
1000 "required": true, | 994 "required": true, |
1001 "type": "string" | 995 "type": "string" |
| 996 }, |
| 997 "updateMask": { |
| 998 "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* `sche
duled_time`\n* `submission_modification_mode`", |
| 999 "format": "google-fieldmask", |
| 1000 "location": "query", |
| 1001 "type": "string" |
1002 } | 1002 } |
1003 }, | 1003 }, |
1004 "path": "v1/courses/{courseId}/courseWork/{id}", | 1004 "path": "v1/courses/{courseId}/courseWork/{id}", |
1005 "request": { | 1005 "request": { |
1006 "$ref": "CourseWork" | 1006 "$ref": "CourseWork" |
1007 }, | 1007 }, |
1008 "response": { | 1008 "response": { |
1009 "$ref": "CourseWork" | 1009 "$ref": "CourseWork" |
1010 }, | 1010 }, |
1011 "scopes": [ | 1011 "scopes": [ |
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1045 "get": { | 1045 "get": { |
1046 "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.", | 1046 "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.", |
1047 "httpMethod": "GET", | 1047 "httpMethod": "GET", |
1048 "id": "classroom.courses.courseWork.studentS
ubmissions.get", | 1048 "id": "classroom.courses.courseWork.studentS
ubmissions.get", |
1049 "parameterOrder": [ | 1049 "parameterOrder": [ |
1050 "courseId", | 1050 "courseId", |
1051 "courseWorkId", | 1051 "courseWorkId", |
1052 "id" | 1052 "id" |
1053 ], | 1053 ], |
1054 "parameters": { | 1054 "parameters": { |
| 1055 "id": { |
| 1056 "description": "Identifier of the st
udent submission.", |
| 1057 "location": "path", |
| 1058 "required": true, |
| 1059 "type": "string" |
| 1060 }, |
1055 "courseWorkId": { | 1061 "courseWorkId": { |
1056 "description": "Identifier of the co
urse work.", | 1062 "description": "Identifier of the co
urse work.", |
1057 "location": "path", | 1063 "location": "path", |
1058 "required": true, | 1064 "required": true, |
1059 "type": "string" | 1065 "type": "string" |
1060 }, | 1066 }, |
1061 "courseId": { | 1067 "courseId": { |
1062 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", | 1068 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", |
1063 "location": "path", | 1069 "location": "path", |
1064 "required": true, | 1070 "required": true, |
1065 "type": "string" | 1071 "type": "string" |
1066 }, | |
1067 "id": { | |
1068 "description": "Identifier of the st
udent submission.", | |
1069 "location": "path", | |
1070 "required": true, | |
1071 "type": "string" | |
1072 } | 1072 } |
1073 }, | 1073 }, |
1074 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}", | 1074 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}", |
1075 "response": { | 1075 "response": { |
1076 "$ref": "StudentSubmission" | 1076 "$ref": "StudentSubmission" |
1077 }, | 1077 }, |
1078 "scopes": [ | 1078 "scopes": [ |
1079 "https://www.googleapis.com/auth/classro
om.coursework.me", | 1079 "https://www.googleapis.com/auth/classro
om.coursework.me", |
1080 "https://www.googleapis.com/auth/classro
om.coursework.me.readonly", | 1080 "https://www.googleapis.com/auth/classro
om.coursework.me.readonly", |
1081 "https://www.googleapis.com/auth/classro
om.coursework.students", | 1081 "https://www.googleapis.com/auth/classro
om.coursework.students", |
1082 "https://www.googleapis.com/auth/classro
om.coursework.students.readonly", | 1082 "https://www.googleapis.com/auth/classro
om.coursework.students.readonly", |
1083 "https://www.googleapis.com/auth/classro
om.student-submissions.me.readonly", | 1083 "https://www.googleapis.com/auth/classro
om.student-submissions.me.readonly", |
1084 "https://www.googleapis.com/auth/classro
om.student-submissions.students.readonly" | 1084 "https://www.googleapis.com/auth/classro
om.student-submissions.students.readonly" |
1085 ] | 1085 ] |
1086 }, | 1086 }, |
1087 "patch": { | 1087 "patch": { |
1088 "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.", | 1088 "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.", |
1089 "httpMethod": "PATCH", | 1089 "httpMethod": "PATCH", |
1090 "id": "classroom.courses.courseWork.studentS
ubmissions.patch", | 1090 "id": "classroom.courses.courseWork.studentS
ubmissions.patch", |
1091 "parameterOrder": [ | 1091 "parameterOrder": [ |
1092 "courseId", | 1092 "courseId", |
1093 "courseWorkId", | 1093 "courseWorkId", |
1094 "id" | 1094 "id" |
1095 ], | 1095 ], |
1096 "parameters": { | 1096 "parameters": { |
1097 "updateMask": { | |
1098 "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`", | |
1099 "format": "google-fieldmask", | |
1100 "location": "query", | |
1101 "type": "string" | |
1102 }, | |
1103 "courseWorkId": { | 1097 "courseWorkId": { |
1104 "description": "Identifier of the co
urse work.", | 1098 "description": "Identifier of the co
urse work.", |
1105 "location": "path", | 1099 "location": "path", |
1106 "required": true, | 1100 "required": true, |
1107 "type": "string" | 1101 "type": "string" |
1108 }, | 1102 }, |
1109 "courseId": { | 1103 "courseId": { |
1110 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", | 1104 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", |
1111 "location": "path", | 1105 "location": "path", |
1112 "required": true, | 1106 "required": true, |
1113 "type": "string" | 1107 "type": "string" |
1114 }, | 1108 }, |
1115 "id": { | 1109 "id": { |
1116 "description": "Identifier of the st
udent submission.", | 1110 "description": "Identifier of the st
udent submission.", |
1117 "location": "path", | 1111 "location": "path", |
1118 "required": true, | 1112 "required": true, |
1119 "type": "string" | 1113 "type": "string" |
| 1114 }, |
| 1115 "updateMask": { |
| 1116 "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`", |
| 1117 "format": "google-fieldmask", |
| 1118 "location": "query", |
| 1119 "type": "string" |
1120 } | 1120 } |
1121 }, | 1121 }, |
1122 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}", | 1122 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}", |
1123 "request": { | 1123 "request": { |
1124 "$ref": "StudentSubmission" | 1124 "$ref": "StudentSubmission" |
1125 }, | 1125 }, |
1126 "response": { | 1126 "response": { |
1127 "$ref": "StudentSubmission" | 1127 "$ref": "StudentSubmission" |
1128 }, | 1128 }, |
1129 "scopes": [ | 1129 "scopes": [ |
(...skipping 44 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1174 "reclaim": { | 1174 "reclaim": { |
1175 "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.", | 1175 "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.", |
1176 "httpMethod": "POST", | 1176 "httpMethod": "POST", |
1177 "id": "classroom.courses.courseWork.studentS
ubmissions.reclaim", | 1177 "id": "classroom.courses.courseWork.studentS
ubmissions.reclaim", |
1178 "parameterOrder": [ | 1178 "parameterOrder": [ |
1179 "courseId", | 1179 "courseId", |
1180 "courseWorkId", | 1180 "courseWorkId", |
1181 "id" | 1181 "id" |
1182 ], | 1182 ], |
1183 "parameters": { | 1183 "parameters": { |
| 1184 "id": { |
| 1185 "description": "Identifier of the st
udent submission.", |
| 1186 "location": "path", |
| 1187 "required": true, |
| 1188 "type": "string" |
| 1189 }, |
1184 "courseWorkId": { | 1190 "courseWorkId": { |
1185 "description": "Identifier of the co
urse work.", | 1191 "description": "Identifier of the co
urse work.", |
1186 "location": "path", | 1192 "location": "path", |
1187 "required": true, | 1193 "required": true, |
1188 "type": "string" | 1194 "type": "string" |
1189 }, | 1195 }, |
1190 "courseId": { | 1196 "courseId": { |
1191 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", | 1197 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", |
1192 "location": "path", | 1198 "location": "path", |
1193 "required": true, | 1199 "required": true, |
1194 "type": "string" | 1200 "type": "string" |
1195 }, | |
1196 "id": { | |
1197 "description": "Identifier of the st
udent submission.", | |
1198 "location": "path", | |
1199 "required": true, | |
1200 "type": "string" | |
1201 } | 1201 } |
1202 }, | 1202 }, |
1203 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}:reclaim", | 1203 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}:reclaim", |
1204 "request": { | 1204 "request": { |
1205 "$ref": "ReclaimStudentSubmissionRequest
" | 1205 "$ref": "ReclaimStudentSubmissionRequest
" |
1206 }, | 1206 }, |
1207 "response": { | 1207 "response": { |
1208 "$ref": "Empty" | 1208 "$ref": "Empty" |
1209 }, | 1209 }, |
1210 "scopes": [ | 1210 "scopes": [ |
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1244 "request": { | 1244 "request": { |
1245 "$ref": "TurnInStudentSubmissionRequest" | 1245 "$ref": "TurnInStudentSubmissionRequest" |
1246 }, | 1246 }, |
1247 "response": { | 1247 "response": { |
1248 "$ref": "Empty" | 1248 "$ref": "Empty" |
1249 }, | 1249 }, |
1250 "scopes": [ | 1250 "scopes": [ |
1251 "https://www.googleapis.com/auth/classro
om.coursework.me" | 1251 "https://www.googleapis.com/auth/classro
om.coursework.me" |
1252 ] | 1252 ] |
1253 }, | 1253 }, |
1254 "modifyAttachments": { | |
1255 "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.", | |
1256 "httpMethod": "POST", | |
1257 "id": "classroom.courses.courseWork.studentS
ubmissions.modifyAttachments", | |
1258 "parameterOrder": [ | |
1259 "courseId", | |
1260 "courseWorkId", | |
1261 "id" | |
1262 ], | |
1263 "parameters": { | |
1264 "courseWorkId": { | |
1265 "description": "Identifier of the co
urse work.", | |
1266 "location": "path", | |
1267 "required": true, | |
1268 "type": "string" | |
1269 }, | |
1270 "courseId": { | |
1271 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", | |
1272 "location": "path", | |
1273 "required": true, | |
1274 "type": "string" | |
1275 }, | |
1276 "id": { | |
1277 "description": "Identifier of the st
udent submission.", | |
1278 "location": "path", | |
1279 "required": true, | |
1280 "type": "string" | |
1281 } | |
1282 }, | |
1283 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}:modifyAttachments", | |
1284 "request": { | |
1285 "$ref": "ModifyAttachmentsRequest" | |
1286 }, | |
1287 "response": { | |
1288 "$ref": "StudentSubmission" | |
1289 }, | |
1290 "scopes": [ | |
1291 "https://www.googleapis.com/auth/classro
om.coursework.me", | |
1292 "https://www.googleapis.com/auth/classro
om.coursework.students" | |
1293 ] | |
1294 }, | |
1295 "list": { | 1254 "list": { |
1296 "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.", | 1255 "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.", |
1297 "httpMethod": "GET", | 1256 "httpMethod": "GET", |
1298 "id": "classroom.courses.courseWork.studentS
ubmissions.list", | 1257 "id": "classroom.courses.courseWork.studentS
ubmissions.list", |
1299 "parameterOrder": [ | 1258 "parameterOrder": [ |
1300 "courseId", | 1259 "courseId", |
1301 "courseWorkId" | 1260 "courseWorkId" |
1302 ], | 1261 ], |
1303 "parameters": { | 1262 "parameters": { |
1304 "late": { | 1263 "late": { |
(...skipping 30 matching lines...) Expand all Loading... |
1335 "format": "int32", | 1294 "format": "int32", |
1336 "location": "query", | 1295 "location": "query", |
1337 "type": "integer" | 1296 "type": "integer" |
1338 }, | 1297 }, |
1339 "userId": { | 1298 "userId": { |
1340 "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", | 1299 "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", |
1341 "location": "query", | 1300 "location": "query", |
1342 "type": "string" | 1301 "type": "string" |
1343 }, | 1302 }, |
1344 "courseWorkId": { | 1303 "courseWorkId": { |
1345 "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.", | 1304 "description": "Identifier of the st
udent work to request.\nThis may be set to the string literal `\"-\"` to request
student work for\nall course work in the specified course.", |
1346 "location": "path", | 1305 "location": "path", |
1347 "required": true, | 1306 "required": true, |
1348 "type": "string" | 1307 "type": "string" |
1349 }, | 1308 }, |
1350 "courseId": { | 1309 "courseId": { |
1351 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", | 1310 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", |
1352 "location": "path", | 1311 "location": "path", |
1353 "required": true, | 1312 "required": true, |
1354 "type": "string" | 1313 "type": "string" |
1355 } | 1314 } |
1356 }, | 1315 }, |
1357 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions", | 1316 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions", |
1358 "response": { | 1317 "response": { |
1359 "$ref": "ListStudentSubmissionsResponse" | 1318 "$ref": "ListStudentSubmissionsResponse" |
1360 }, | 1319 }, |
1361 "scopes": [ | 1320 "scopes": [ |
1362 "https://www.googleapis.com/auth/classro
om.coursework.me", | 1321 "https://www.googleapis.com/auth/classro
om.coursework.me", |
1363 "https://www.googleapis.com/auth/classro
om.coursework.me.readonly", | 1322 "https://www.googleapis.com/auth/classro
om.coursework.me.readonly", |
1364 "https://www.googleapis.com/auth/classro
om.coursework.students", | 1323 "https://www.googleapis.com/auth/classro
om.coursework.students", |
1365 "https://www.googleapis.com/auth/classro
om.coursework.students.readonly", | 1324 "https://www.googleapis.com/auth/classro
om.coursework.students.readonly", |
1366 "https://www.googleapis.com/auth/classro
om.student-submissions.me.readonly", | 1325 "https://www.googleapis.com/auth/classro
om.student-submissions.me.readonly", |
1367 "https://www.googleapis.com/auth/classro
om.student-submissions.students.readonly" | 1326 "https://www.googleapis.com/auth/classro
om.student-submissions.students.readonly" |
1368 ] | 1327 ] |
| 1328 }, |
| 1329 "modifyAttachments": { |
| 1330 "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.", |
| 1331 "httpMethod": "POST", |
| 1332 "id": "classroom.courses.courseWork.studentS
ubmissions.modifyAttachments", |
| 1333 "parameterOrder": [ |
| 1334 "courseId", |
| 1335 "courseWorkId", |
| 1336 "id" |
| 1337 ], |
| 1338 "parameters": { |
| 1339 "courseWorkId": { |
| 1340 "description": "Identifier of the co
urse work.", |
| 1341 "location": "path", |
| 1342 "required": true, |
| 1343 "type": "string" |
| 1344 }, |
| 1345 "courseId": { |
| 1346 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", |
| 1347 "location": "path", |
| 1348 "required": true, |
| 1349 "type": "string" |
| 1350 }, |
| 1351 "id": { |
| 1352 "description": "Identifier of the st
udent submission.", |
| 1353 "location": "path", |
| 1354 "required": true, |
| 1355 "type": "string" |
| 1356 } |
| 1357 }, |
| 1358 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}:modifyAttachments", |
| 1359 "request": { |
| 1360 "$ref": "ModifyAttachmentsRequest" |
| 1361 }, |
| 1362 "response": { |
| 1363 "$ref": "StudentSubmission" |
| 1364 }, |
| 1365 "scopes": [ |
| 1366 "https://www.googleapis.com/auth/classro
om.coursework.me", |
| 1367 "https://www.googleapis.com/auth/classro
om.coursework.students" |
| 1368 ] |
1369 } | 1369 } |
1370 } | 1370 } |
1371 } | 1371 } |
1372 } | 1372 } |
1373 }, | 1373 }, |
1374 "teachers": { | 1374 "teachers": { |
1375 "methods": { | 1375 "methods": { |
1376 "delete": { | |
1377 "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.", | |
1378 "httpMethod": "DELETE", | |
1379 "id": "classroom.courses.teachers.delete", | |
1380 "parameterOrder": [ | |
1381 "courseId", | |
1382 "userId" | |
1383 ], | |
1384 "parameters": { | |
1385 "courseId": { | |
1386 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | |
1387 "location": "path", | |
1388 "required": true, | |
1389 "type": "string" | |
1390 }, | |
1391 "userId": { | |
1392 "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", | |
1393 "location": "path", | |
1394 "required": true, | |
1395 "type": "string" | |
1396 } | |
1397 }, | |
1398 "path": "v1/courses/{courseId}/teachers/{userId}", | |
1399 "response": { | |
1400 "$ref": "Empty" | |
1401 }, | |
1402 "scopes": [ | |
1403 "https://www.googleapis.com/auth/classroom.roste
rs" | |
1404 ] | |
1405 }, | |
1406 "list": { | 1376 "list": { |
1407 "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.", | 1377 "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.", |
1408 "httpMethod": "GET", | 1378 "httpMethod": "GET", |
1409 "id": "classroom.courses.teachers.list", | 1379 "id": "classroom.courses.teachers.list", |
1410 "parameterOrder": [ | 1380 "parameterOrder": [ |
1411 "courseId" | 1381 "courseId" |
1412 ], | 1382 ], |
1413 "parameters": { | 1383 "parameters": { |
1414 "pageToken": { | 1384 "pageToken": { |
1415 "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.", | 1385 "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.", |
(...skipping 26 matching lines...) Expand all Loading... |
1442 }, | 1412 }, |
1443 "get": { | 1413 "get": { |
1444 "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.", | 1414 "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.", |
1445 "httpMethod": "GET", | 1415 "httpMethod": "GET", |
1446 "id": "classroom.courses.teachers.get", | 1416 "id": "classroom.courses.teachers.get", |
1447 "parameterOrder": [ | 1417 "parameterOrder": [ |
1448 "courseId", | 1418 "courseId", |
1449 "userId" | 1419 "userId" |
1450 ], | 1420 ], |
1451 "parameters": { | 1421 "parameters": { |
| 1422 "userId": { |
| 1423 "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", |
| 1424 "location": "path", |
| 1425 "required": true, |
| 1426 "type": "string" |
| 1427 }, |
1452 "courseId": { | 1428 "courseId": { |
1453 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | 1429 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
1454 "location": "path", | 1430 "location": "path", |
1455 "required": true, | 1431 "required": true, |
1456 "type": "string" | 1432 "type": "string" |
1457 }, | |
1458 "userId": { | |
1459 "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", | |
1460 "location": "path", | |
1461 "required": true, | |
1462 "type": "string" | |
1463 } | 1433 } |
1464 }, | 1434 }, |
1465 "path": "v1/courses/{courseId}/teachers/{userId}", | 1435 "path": "v1/courses/{courseId}/teachers/{userId}", |
1466 "response": { | 1436 "response": { |
1467 "$ref": "Teacher" | 1437 "$ref": "Teacher" |
1468 }, | 1438 }, |
1469 "scopes": [ | 1439 "scopes": [ |
1470 "https://www.googleapis.com/auth/classroom.profi
le.emails", | 1440 "https://www.googleapis.com/auth/classroom.profi
le.emails", |
1471 "https://www.googleapis.com/auth/classroom.profi
le.photos", | 1441 "https://www.googleapis.com/auth/classroom.profi
le.photos", |
1472 "https://www.googleapis.com/auth/classroom.roste
rs", | 1442 "https://www.googleapis.com/auth/classroom.roste
rs", |
(...skipping 20 matching lines...) Expand all Loading... |
1493 "$ref": "Teacher" | 1463 "$ref": "Teacher" |
1494 }, | 1464 }, |
1495 "response": { | 1465 "response": { |
1496 "$ref": "Teacher" | 1466 "$ref": "Teacher" |
1497 }, | 1467 }, |
1498 "scopes": [ | 1468 "scopes": [ |
1499 "https://www.googleapis.com/auth/classroom.profi
le.emails", | 1469 "https://www.googleapis.com/auth/classroom.profi
le.emails", |
1500 "https://www.googleapis.com/auth/classroom.profi
le.photos", | 1470 "https://www.googleapis.com/auth/classroom.profi
le.photos", |
1501 "https://www.googleapis.com/auth/classroom.roste
rs" | 1471 "https://www.googleapis.com/auth/classroom.roste
rs" |
1502 ] | 1472 ] |
| 1473 }, |
| 1474 "delete": { |
| 1475 "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.", |
| 1476 "httpMethod": "DELETE", |
| 1477 "id": "classroom.courses.teachers.delete", |
| 1478 "parameterOrder": [ |
| 1479 "courseId", |
| 1480 "userId" |
| 1481 ], |
| 1482 "parameters": { |
| 1483 "userId": { |
| 1484 "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", |
| 1485 "location": "path", |
| 1486 "required": true, |
| 1487 "type": "string" |
| 1488 }, |
| 1489 "courseId": { |
| 1490 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
| 1491 "location": "path", |
| 1492 "required": true, |
| 1493 "type": "string" |
| 1494 } |
| 1495 }, |
| 1496 "path": "v1/courses/{courseId}/teachers/{userId}", |
| 1497 "response": { |
| 1498 "$ref": "Empty" |
| 1499 }, |
| 1500 "scopes": [ |
| 1501 "https://www.googleapis.com/auth/classroom.roste
rs" |
| 1502 ] |
1503 } | 1503 } |
1504 } | 1504 } |
1505 } | 1505 } |
1506 } | 1506 } |
1507 }, | 1507 }, |
1508 "invitations": { | 1508 "invitations": { |
1509 "methods": { | 1509 "methods": { |
| 1510 "delete": { |
| 1511 "description": "Deletes an invitation.\n\nThis method return
s the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is
not permitted to delete the\nrequested invitation or for access errors.\n* `NOT_
FOUND` if no invitation exists with the requested ID.", |
| 1512 "httpMethod": "DELETE", |
| 1513 "id": "classroom.invitations.delete", |
| 1514 "parameterOrder": [ |
| 1515 "id" |
| 1516 ], |
| 1517 "parameters": { |
| 1518 "id": { |
| 1519 "description": "Identifier of the invitation to dele
te.", |
| 1520 "location": "path", |
| 1521 "required": true, |
| 1522 "type": "string" |
| 1523 } |
| 1524 }, |
| 1525 "path": "v1/invitations/{id}", |
| 1526 "response": { |
| 1527 "$ref": "Empty" |
| 1528 }, |
| 1529 "scopes": [ |
| 1530 "https://www.googleapis.com/auth/classroom.rosters" |
| 1531 ] |
| 1532 }, |
1510 "list": { | 1533 "list": { |
1511 "description": "Returns a list of invitations that the reque
sting user is permitted to\nview, restricted to those that match the list reques
t.\n\n*Note:* At least one of `user_id` or `course_id` must be supplied. Both\nf
ields can be supplied.\n\nThis method returns the following error codes:\n\n* `P
ERMISSION_DENIED` for access errors.", | 1534 "description": "Returns a list of invitations that the reque
sting user is permitted to\nview, restricted to those that match the list reques
t.\n\n*Note:* At least one of `user_id` or `course_id` must be supplied. Both\nf
ields can be supplied.\n\nThis method returns the following error codes:\n\n* `P
ERMISSION_DENIED` for access errors.", |
1512 "httpMethod": "GET", | 1535 "httpMethod": "GET", |
1513 "id": "classroom.invitations.list", | 1536 "id": "classroom.invitations.list", |
1514 "parameterOrder": [], | 1537 "parameterOrder": [], |
1515 "parameters": { | 1538 "parameters": { |
1516 "pageToken": { | 1539 "pageToken": { |
1517 "description": "nextPageToken\nvalue returned from a
previous\nlist call, indicating\nthat 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.", | 1540 "description": "nextPageToken\nvalue returned from a
previous\nlist call, indicating\nthat 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.", |
1518 "location": "query", | 1541 "location": "query", |
1519 "type": "string" | 1542 "type": "string" |
(...skipping 80 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1600 "type": "string" | 1623 "type": "string" |
1601 } | 1624 } |
1602 }, | 1625 }, |
1603 "path": "v1/invitations/{id}:accept", | 1626 "path": "v1/invitations/{id}:accept", |
1604 "response": { | 1627 "response": { |
1605 "$ref": "Empty" | 1628 "$ref": "Empty" |
1606 }, | 1629 }, |
1607 "scopes": [ | 1630 "scopes": [ |
1608 "https://www.googleapis.com/auth/classroom.rosters" | 1631 "https://www.googleapis.com/auth/classroom.rosters" |
1609 ] | 1632 ] |
1610 }, | |
1611 "delete": { | |
1612 "description": "Deletes an invitation.\n\nThis method return
s the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is
not permitted to delete the\nrequested invitation or for access errors.\n* `NOT_
FOUND` if no invitation exists with the requested ID.", | |
1613 "httpMethod": "DELETE", | |
1614 "id": "classroom.invitations.delete", | |
1615 "parameterOrder": [ | |
1616 "id" | |
1617 ], | |
1618 "parameters": { | |
1619 "id": { | |
1620 "description": "Identifier of the invitation to dele
te.", | |
1621 "location": "path", | |
1622 "required": true, | |
1623 "type": "string" | |
1624 } | |
1625 }, | |
1626 "path": "v1/invitations/{id}", | |
1627 "response": { | |
1628 "$ref": "Empty" | |
1629 }, | |
1630 "scopes": [ | |
1631 "https://www.googleapis.com/auth/classroom.rosters" | |
1632 ] | |
1633 } | 1633 } |
1634 } | 1634 } |
1635 } | 1635 } |
1636 }, | 1636 }, |
1637 "revision": "20170727", | 1637 "revision": "20170818", |
1638 "rootUrl": "https://classroom.googleapis.com/", | 1638 "rootUrl": "https://classroom.googleapis.com/", |
1639 "schemas": { | 1639 "schemas": { |
1640 "Empty": { | |
1641 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", | |
1642 "id": "Empty", | |
1643 "properties": {}, | |
1644 "type": "object" | |
1645 }, | |
1646 "MultipleChoiceQuestion": { | |
1647 "description": "Additional details for multiple-choice questions.", | |
1648 "id": "MultipleChoiceQuestion", | |
1649 "properties": { | |
1650 "choices": { | |
1651 "description": "Possible choices.", | |
1652 "items": { | |
1653 "type": "string" | |
1654 }, | |
1655 "type": "array" | |
1656 } | |
1657 }, | |
1658 "type": "object" | |
1659 }, | |
1660 "Course": { | |
1661 "description": "A Course in Classroom.", | |
1662 "id": "Course", | |
1663 "properties": { | |
1664 "teacherFolder": { | |
1665 "$ref": "DriveFolder", | |
1666 "description": "Information about a Drive Folder that is sha
red with all teachers of the\ncourse.\n\nThis field will only be set for teacher
s of the course and domain administrators.\n\nRead-only." | |
1667 }, | |
1668 "name": { | |
1669 "description": "Name of the course.\nFor example, \"10th Gra
de Biology\".\nThe name is required. It must be between 1 and 750 characters and
a valid\nUTF-8 string.", | |
1670 "type": "string" | |
1671 }, | |
1672 "section": { | |
1673 "description": "Section of the course.\nFor example, \"Perio
d 2\".\nIf set, this field must be a valid UTF-8 string and no longer than 2800\
ncharacters.", | |
1674 "type": "string" | |
1675 }, | |
1676 "id": { | |
1677 "description": "Identifier for this course assigned by Class
room.\n\nWhen\ncreating a course,\nyou may optionally set this identifier to an\
nalias string in the\nrequest to create a corresponding alias. The `id` is still
assigned by\nClassroom and cannot be updated after the course is created.\n\nSp
ecifying this field in a course update mask results in an error.", | |
1678 "type": "string" | |
1679 }, | |
1680 "room": { | |
1681 "description": "Optional room location.\nFor example, \"301\
".\nIf set, this field must be a valid UTF-8 string and no longer than 650\nchar
acters.", | |
1682 "type": "string" | |
1683 }, | |
1684 "courseGroupEmail": { | |
1685 "description": "The email address of a Google group containi
ng all members of the course.\nThis group does not accept email and can only be
used for permissions.\n\nRead-only.", | |
1686 "type": "string" | |
1687 }, | |
1688 "enrollmentCode": { | |
1689 "description": "Enrollment code to use when joining this cou
rse.\nSpecifying this field in a course update mask results in an error.\n\nRead
-only.", | |
1690 "type": "string" | |
1691 }, | |
1692 "courseMaterialSets": { | |
1693 "description": "Sets of materials that appear on the \"about
\" page of this course.\n\nRead-only.", | |
1694 "items": { | |
1695 "$ref": "CourseMaterialSet" | |
1696 }, | |
1697 "type": "array" | |
1698 }, | |
1699 "descriptionHeading": { | |
1700 "description": "Optional heading for the description.\nFor e
xample, \"Welcome to 10th Grade Biology.\"\nIf set, this field must be a valid U
TF-8 string and no longer than 3600\ncharacters.", | |
1701 "type": "string" | |
1702 }, | |
1703 "updateTime": { | |
1704 "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.", | |
1705 "format": "google-datetime", | |
1706 "type": "string" | |
1707 }, | |
1708 "calendarId": { | |
1709 "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.", | |
1710 "type": "string" | |
1711 }, | |
1712 "alternateLink": { | |
1713 "description": "Absolute link to this course in the Classroo
m web UI.\n\nRead-only.", | |
1714 "type": "string" | |
1715 }, | |
1716 "guardiansEnabled": { | |
1717 "description": "Whether or not guardian notifications are en
abled for this course.\n\nRead-only.", | |
1718 "type": "boolean" | |
1719 }, | |
1720 "courseState": { | |
1721 "description": "State of the course.\nIf unspecified, the de
fault state is `PROVISIONED`.", | |
1722 "enum": [ | |
1723 "COURSE_STATE_UNSPECIFIED", | |
1724 "ACTIVE", | |
1725 "ARCHIVED", | |
1726 "PROVISIONED", | |
1727 "DECLINED", | |
1728 "SUSPENDED" | |
1729 ], | |
1730 "enumDescriptions": [ | |
1731 "No course state. No returned Course message will use th
is value.", | |
1732 "The course is active.", | |
1733 "The course has been archived. You cannot modify it exce
pt to change it\nto a different state.", | |
1734 "The course has been created, but not yet activated. It
is accessible by\nthe primary teacher and domain administrators, who may modify
it or\nchange it to the `ACTIVE` or `DECLINED` states.\nA course may only be cha
nged to `PROVISIONED` if it is in the `DECLINED`\nstate.", | |
1735 "The course has been created, but declined. It is access
ible by the\ncourse owner and domain administrators, though it will not be\ndisp
layed in the web UI. You cannot modify the course except to change it\nto the `P
ROVISIONED` state.\nA course may only be changed to `DECLINED` if it is in the `
PROVISIONED`\nstate.", | |
1736 "The course has been suspended. You cannot modify the co
urse, and only the\nuser identified by the `owner_id` can view the course.\nA co
urse may be placed in this state if it potentially violates the\nTerms of Servic
e." | |
1737 ], | |
1738 "type": "string" | |
1739 }, | |
1740 "ownerId": { | |
1741 "description": "The identifier of the owner of a course.\n\n
When specified as a parameter of a\ncreate course request, this\nfield is requir
ed.\nThe identifier can be one of the following:\n\n* the numeric identifier for
the user\n* the email address of the user\n* the string literal `\"me\"`, indic
ating the requesting user\n\nThis must be set in a create request. Specifying th
is field in a course\nupdate mask results in an `INVALID_ARGUMENT` error.", | |
1742 "type": "string" | |
1743 }, | |
1744 "description": { | |
1745 "description": "Optional description.\nFor example, \"We'll
be learning about the structure of living\ncreatures from a combination of textb
ooks, guest lectures, and lab work.\nExpect to be excited!\"\nIf set, this field
must be a valid UTF-8 string and no longer than 30,000\ncharacters.", | |
1746 "type": "string" | |
1747 }, | |
1748 "teacherGroupEmail": { | |
1749 "description": "The email address of a Google group containi
ng all teachers of the course.\nThis group does not accept email and can only be
used for permissions.\n\nRead-only.", | |
1750 "type": "string" | |
1751 }, | |
1752 "creationTime": { | |
1753 "description": "Creation time of the course.\nSpecifying thi
s field in a course update mask results in an error.\n\nRead-only.", | |
1754 "format": "google-datetime", | |
1755 "type": "string" | |
1756 } | |
1757 }, | |
1758 "type": "object" | |
1759 }, | |
1760 "DriveFile": { | |
1761 "description": "Representation of a Google Drive file.", | |
1762 "id": "DriveFile", | |
1763 "properties": { | |
1764 "title": { | |
1765 "description": "Title of the Drive item.\n\nRead-only.", | |
1766 "type": "string" | |
1767 }, | |
1768 "alternateLink": { | |
1769 "description": "URL that can be used to access the Drive ite
m.\n\nRead-only.", | |
1770 "type": "string" | |
1771 }, | |
1772 "thumbnailUrl": { | |
1773 "description": "URL of a thumbnail image of the Drive item.\
n\nRead-only.", | |
1774 "type": "string" | |
1775 }, | |
1776 "id": { | |
1777 "description": "Drive API resource ID.", | |
1778 "type": "string" | |
1779 } | |
1780 }, | |
1781 "type": "object" | |
1782 }, | |
1783 "GlobalPermission": { | |
1784 "description": "Global user permission description.", | |
1785 "id": "GlobalPermission", | |
1786 "properties": { | |
1787 "permission": { | |
1788 "description": "Permission value.", | |
1789 "enum": [ | |
1790 "PERMISSION_UNSPECIFIED", | |
1791 "CREATE_COURSE" | |
1792 ], | |
1793 "enumDescriptions": [ | |
1794 "No permission is specified. This is not returned and is
not a\nvalid value.", | |
1795 "User is permitted to create a course." | |
1796 ], | |
1797 "type": "string" | |
1798 } | |
1799 }, | |
1800 "type": "object" | |
1801 }, | |
1802 "ReturnStudentSubmissionRequest": { | |
1803 "description": "Request to return a student submission.", | |
1804 "id": "ReturnStudentSubmissionRequest", | |
1805 "properties": {}, | |
1806 "type": "object" | |
1807 }, | |
1808 "Teacher": { | |
1809 "description": "Teacher of a course.", | |
1810 "id": "Teacher", | |
1811 "properties": { | |
1812 "courseId": { | |
1813 "description": "Identifier of the course.\n\nRead-only.", | |
1814 "type": "string" | |
1815 }, | |
1816 "profile": { | |
1817 "$ref": "UserProfile", | |
1818 "description": "Global user information for the teacher.\n\n
Read-only." | |
1819 }, | |
1820 "userId": { | |
1821 "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", | |
1822 "type": "string" | |
1823 } | |
1824 }, | |
1825 "type": "object" | |
1826 }, | |
1827 "ReclaimStudentSubmissionRequest": { | 1640 "ReclaimStudentSubmissionRequest": { |
1828 "description": "Request to reclaim a student submission.", | 1641 "description": "Request to reclaim a student submission.", |
1829 "id": "ReclaimStudentSubmissionRequest", | 1642 "id": "ReclaimStudentSubmissionRequest", |
1830 "properties": {}, | 1643 "properties": {}, |
1831 "type": "object" | 1644 "type": "object" |
1832 }, | 1645 }, |
| 1646 "GradeHistory": { |
| 1647 "description": "The history of each grade on this submission.", |
| 1648 "id": "GradeHistory", |
| 1649 "properties": { |
| 1650 "actorUserId": { |
| 1651 "description": "The teacher who made the grade change.", |
| 1652 "type": "string" |
| 1653 }, |
| 1654 "gradeChangeType": { |
| 1655 "description": "The type of grade change at this time in the
submission grade history.", |
| 1656 "enum": [ |
| 1657 "UNKNOWN_GRADE_CHANGE_TYPE", |
| 1658 "DRAFT_GRADE_POINTS_EARNED_CHANGE", |
| 1659 "ASSIGNED_GRADE_POINTS_EARNED_CHANGE", |
| 1660 "MAX_POINTS_CHANGE" |
| 1661 ], |
| 1662 "enumDescriptions": [ |
| 1663 "No grade change type specified. This should never be re
turned.", |
| 1664 "A change in the numerator of the draft grade.", |
| 1665 "A change in the numerator of the assigned grade.", |
| 1666 "A change in the denominator of the grade." |
| 1667 ], |
| 1668 "type": "string" |
| 1669 }, |
| 1670 "gradeTimestamp": { |
| 1671 "description": "When the grade of the submission was changed
.", |
| 1672 "format": "google-datetime", |
| 1673 "type": "string" |
| 1674 }, |
| 1675 "maxPoints": { |
| 1676 "description": "The denominator of the grade at this time in
the submission grade\nhistory.", |
| 1677 "format": "double", |
| 1678 "type": "number" |
| 1679 }, |
| 1680 "pointsEarned": { |
| 1681 "description": "The numerator of the grade at this time in t
he submission grade history.", |
| 1682 "format": "double", |
| 1683 "type": "number" |
| 1684 } |
| 1685 }, |
| 1686 "type": "object" |
| 1687 }, |
1833 "AssignmentSubmission": { | 1688 "AssignmentSubmission": { |
1834 "description": "Student work for an assignment.", | 1689 "description": "Student work for an assignment.", |
1835 "id": "AssignmentSubmission", | 1690 "id": "AssignmentSubmission", |
1836 "properties": { | 1691 "properties": { |
1837 "attachments": { | 1692 "attachments": { |
1838 "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.", | 1693 "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.", |
1839 "items": { | 1694 "items": { |
1840 "$ref": "Attachment" | 1695 "$ref": "Attachment" |
1841 }, | 1696 }, |
1842 "type": "array" | 1697 "type": "array" |
1843 } | 1698 } |
1844 }, | 1699 }, |
1845 "type": "object" | 1700 "type": "object" |
1846 }, | 1701 }, |
1847 "Material": { | 1702 "Material": { |
1848 "description": "Material attached to course work.\n\nWhen creating a
ttachments, setting the `form` field is not supported.", | 1703 "description": "Material attached to course work.\n\nWhen creating a
ttachments, setting the `form` field is not supported.", |
1849 "id": "Material", | 1704 "id": "Material", |
1850 "properties": { | 1705 "properties": { |
| 1706 "link": { |
| 1707 "$ref": "Link", |
| 1708 "description": "Link material. On creation, will be upgraded
to a more appropriate type\nif possible, and this will be reflected in the resp
onse." |
| 1709 }, |
1851 "youtubeVideo": { | 1710 "youtubeVideo": { |
1852 "$ref": "YouTubeVideo", | 1711 "$ref": "YouTubeVideo", |
1853 "description": "YouTube video material." | 1712 "description": "YouTube video material." |
1854 }, | 1713 }, |
1855 "driveFile": { | 1714 "driveFile": { |
1856 "$ref": "SharedDriveFile", | 1715 "$ref": "SharedDriveFile", |
1857 "description": "Google Drive file material." | 1716 "description": "Google Drive file material." |
1858 }, | 1717 }, |
1859 "form": { | 1718 "form": { |
1860 "$ref": "Form", | 1719 "$ref": "Form", |
1861 "description": "Google Forms material." | 1720 "description": "Google Forms material." |
1862 }, | |
1863 "link": { | |
1864 "$ref": "Link", | |
1865 "description": "Link material. On creation, will be upgraded
to a more appropriate type\nif possible, and this will be reflected in the resp
onse." | |
1866 } | 1721 } |
1867 }, | 1722 }, |
1868 "type": "object" | 1723 "type": "object" |
1869 }, | 1724 }, |
1870 "CourseWork": { | 1725 "CourseWork": { |
1871 "description": "Course work created by a teacher for students of the
course.", | 1726 "description": "Course work created by a teacher for students of the
course.", |
1872 "id": "CourseWork", | 1727 "id": "CourseWork", |
1873 "properties": { | 1728 "properties": { |
1874 "associatedWithDeveloper": { | |
1875 "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.", | |
1876 "type": "boolean" | |
1877 }, | |
1878 "materials": { | 1729 "materials": { |
1879 "description": "Additional materials.\n\nCourseWork must hav
e no more than 20 material items.", | 1730 "description": "Additional materials.\n\nCourseWork must hav
e no more than 20 material items.", |
1880 "items": { | 1731 "items": { |
1881 "$ref": "Material" | 1732 "$ref": "Material" |
1882 }, | 1733 }, |
1883 "type": "array" | 1734 "type": "array" |
1884 }, | 1735 }, |
| 1736 "associatedWithDeveloper": { |
| 1737 "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.", |
| 1738 "type": "boolean" |
| 1739 }, |
1885 "updateTime": { | 1740 "updateTime": { |
1886 "description": "Timestamp of the most recent change to this
course work.\n\nRead-only.", | 1741 "description": "Timestamp of the most recent change to this
course work.\n\nRead-only.", |
1887 "format": "google-datetime", | 1742 "format": "google-datetime", |
1888 "type": "string" | 1743 "type": "string" |
1889 }, | 1744 }, |
1890 "alternateLink": { | 1745 "alternateLink": { |
1891 "description": "Absolute link to this course work in the Cla
ssroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only."
, | 1746 "description": "Absolute link to this course work in the Cla
ssroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only."
, |
1892 "type": "string" | 1747 "type": "string" |
1893 }, | 1748 }, |
1894 "maxPoints": { | 1749 "maxPoints": { |
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1931 }, | 1786 }, |
1932 "creationTime": { | 1787 "creationTime": { |
1933 "description": "Timestamp when this course work was created.
\n\nRead-only.", | 1788 "description": "Timestamp when this course work was created.
\n\nRead-only.", |
1934 "format": "google-datetime", | 1789 "format": "google-datetime", |
1935 "type": "string" | 1790 "type": "string" |
1936 }, | 1791 }, |
1937 "dueDate": { | 1792 "dueDate": { |
1938 "$ref": "Date", | 1793 "$ref": "Date", |
1939 "description": "Optional date, in UTC, that submissions for
this this course work are due.\nThis must be specified if `due_time` is specifie
d." | 1794 "description": "Optional date, in UTC, that submissions for
this this course work are due.\nThis must be specified if `due_time` is specifie
d." |
1940 }, | 1795 }, |
1941 "submissionModificationMode": { | |
1942 "description": "Setting to determine when students are allow
ed to modify submissions.\nIf unspecified, the default value is `MODIFIABLE_UNTI
L_TURNED_IN`.", | |
1943 "enum": [ | |
1944 "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED", | |
1945 "MODIFIABLE_UNTIL_TURNED_IN", | |
1946 "MODIFIABLE" | |
1947 ], | |
1948 "enumDescriptions": [ | |
1949 "No modification mode specified. This is never returned.
", | |
1950 "Submisisons can be modified before being turned in.", | |
1951 "Submisisons can be modified at any time." | |
1952 ], | |
1953 "type": "string" | |
1954 }, | |
1955 "state": { | 1796 "state": { |
1956 "description": "Status of this course work.\nIf unspecified,
the default state is `DRAFT`.", | 1797 "description": "Status of this course work.\nIf unspecified,
the default state is `DRAFT`.", |
1957 "enum": [ | 1798 "enum": [ |
1958 "COURSE_WORK_STATE_UNSPECIFIED", | 1799 "COURSE_WORK_STATE_UNSPECIFIED", |
1959 "PUBLISHED", | 1800 "PUBLISHED", |
1960 "DRAFT", | 1801 "DRAFT", |
1961 "DELETED" | 1802 "DELETED" |
1962 ], | 1803 ], |
1963 "enumDescriptions": [ | 1804 "enumDescriptions": [ |
1964 "No state specified. This is never returned.", | 1805 "No state specified. This is never returned.", |
1965 "Status for work that has been published.\nThis is the d
efault state.", | 1806 "Status for work that has been published.\nThis is the d
efault state.", |
1966 "Status for work that is not yet published.\nWork in thi
s state is visible only to course teachers and domain\nadministrators.", | 1807 "Status for work that is not yet published.\nWork in thi
s state is visible only to course teachers and domain\nadministrators.", |
1967 "Status for work that was published but is now deleted.\
nWork in this state is visible only to course teachers and domain\nadministrator
s.\nWork in this state is deleted after some time." | 1808 "Status for work that was published but is now deleted.\
nWork in this state is visible only to course teachers and domain\nadministrator
s.\nWork in this state is deleted after some time." |
1968 ], | 1809 ], |
1969 "type": "string" | 1810 "type": "string" |
1970 }, | 1811 }, |
| 1812 "submissionModificationMode": { |
| 1813 "description": "Setting to determine when students are allow
ed to modify submissions.\nIf unspecified, the default value is `MODIFIABLE_UNTI
L_TURNED_IN`.", |
| 1814 "enum": [ |
| 1815 "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED", |
| 1816 "MODIFIABLE_UNTIL_TURNED_IN", |
| 1817 "MODIFIABLE" |
| 1818 ], |
| 1819 "enumDescriptions": [ |
| 1820 "No modification mode specified. This is never returned.
", |
| 1821 "Submisisons can be modified before being turned in.", |
| 1822 "Submisisons can be modified at any time." |
| 1823 ], |
| 1824 "type": "string" |
| 1825 }, |
1971 "courseId": { | 1826 "courseId": { |
1972 "description": "Identifier of the course.\n\nRead-only.", | 1827 "description": "Identifier of the course.\n\nRead-only.", |
1973 "type": "string" | 1828 "type": "string" |
1974 }, | 1829 }, |
1975 "id": { | 1830 "id": { |
1976 "description": "Classroom-assigned identifier of this course
work, unique per course.\n\nRead-only.", | 1831 "description": "Classroom-assigned identifier of this course
work, unique per course.\n\nRead-only.", |
1977 "type": "string" | 1832 "type": "string" |
1978 }, | 1833 }, |
1979 "dueTime": { | 1834 "dueTime": { |
1980 "$ref": "TimeOfDay", | 1835 "$ref": "TimeOfDay", |
1981 "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." | 1836 "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." |
1982 }, | 1837 }, |
1983 "title": { | 1838 "title": { |
1984 "description": "Title of this course work.\nThe title must b
e a valid UTF-8 string containing between 1 and 3000\ncharacters.", | 1839 "description": "Title of this course work.\nThe title must b
e a valid UTF-8 string containing between 1 and 3000\ncharacters.", |
1985 "type": "string" | 1840 "type": "string" |
1986 } | 1841 } |
1987 }, | 1842 }, |
1988 "type": "object" | 1843 "type": "object" |
1989 }, | 1844 }, |
1990 "Guardian": { | 1845 "Guardian": { |
1991 "description": "Association between a student and a guardian of that
student. The guardian\nmay receive information about the student's course work.
", | 1846 "description": "Association between a student and a guardian of that
student. The guardian\nmay receive information about the student's course work.
", |
1992 "id": "Guardian", | 1847 "id": "Guardian", |
1993 "properties": { | 1848 "properties": { |
| 1849 "guardianProfile": { |
| 1850 "$ref": "UserProfile", |
| 1851 "description": "User profile for the guardian." |
| 1852 }, |
1994 "studentId": { | 1853 "studentId": { |
1995 "description": "Identifier for the student to whom the guard
ian relationship applies.", | 1854 "description": "Identifier for the student to whom the guard
ian relationship applies.", |
1996 "type": "string" | 1855 "type": "string" |
1997 }, | 1856 }, |
1998 "invitedEmailAddress": { | 1857 "invitedEmailAddress": { |
1999 "description": "The email address to which the initial guard
ian invitation was sent.\nThis field is only visible to domain administrators.", | 1858 "description": "The email address to which the initial guard
ian invitation was sent.\nThis field is only visible to domain administrators.", |
2000 "type": "string" | 1859 "type": "string" |
2001 }, | 1860 }, |
2002 "guardianId": { | 1861 "guardianId": { |
2003 "description": "Identifier for the guardian.", | 1862 "description": "Identifier for the guardian.", |
2004 "type": "string" | 1863 "type": "string" |
2005 }, | |
2006 "guardianProfile": { | |
2007 "$ref": "UserProfile", | |
2008 "description": "User profile for the guardian." | |
2009 } | 1864 } |
2010 }, | 1865 }, |
2011 "type": "object" | 1866 "type": "object" |
2012 }, | 1867 }, |
2013 "UserProfile": { | 1868 "UserProfile": { |
2014 "description": "Global information for a user.", | 1869 "description": "Global information for a user.", |
2015 "id": "UserProfile", | 1870 "id": "UserProfile", |
2016 "properties": { | 1871 "properties": { |
| 1872 "id": { |
| 1873 "description": "Identifier of the user.\n\nRead-only.", |
| 1874 "type": "string" |
| 1875 }, |
| 1876 "verifiedTeacher": { |
| 1877 "description": "Represents whether a G Suite for Education u
ser's domain administrator has\nexplicitly verified them as being a teacher. If
the user is not a member of\na G Suite for Education domain, than this field wil
l always be false.\n\nRead-only", |
| 1878 "type": "boolean" |
| 1879 }, |
2017 "emailAddress": { | 1880 "emailAddress": { |
2018 "description": "Email address of the user.\n\nRead-only.", | 1881 "description": "Email address of the user.\n\nRead-only.", |
2019 "type": "string" | 1882 "type": "string" |
2020 }, | 1883 }, |
2021 "photoUrl": { | 1884 "photoUrl": { |
2022 "description": "URL of user's profile photo.\n\nRead-only.", | 1885 "description": "URL of user's profile photo.\n\nRead-only.", |
2023 "type": "string" | 1886 "type": "string" |
2024 }, | 1887 }, |
2025 "permissions": { | 1888 "permissions": { |
2026 "description": "Global permissions of the user.\n\nRead-only
.", | 1889 "description": "Global permissions of the user.\n\nRead-only
.", |
2027 "items": { | 1890 "items": { |
2028 "$ref": "GlobalPermission" | 1891 "$ref": "GlobalPermission" |
2029 }, | 1892 }, |
2030 "type": "array" | 1893 "type": "array" |
2031 }, | 1894 }, |
2032 "name": { | 1895 "name": { |
2033 "$ref": "Name", | 1896 "$ref": "Name", |
2034 "description": "Name of the user.\n\nRead-only." | 1897 "description": "Name of the user.\n\nRead-only." |
2035 }, | |
2036 "id": { | |
2037 "description": "Identifier of the user.\n\nRead-only.", | |
2038 "type": "string" | |
2039 }, | |
2040 "verifiedTeacher": { | |
2041 "description": "Represents whether a G Suite for Education u
ser's domain administrator has\nexplicitly verified them as being a teacher. If
the user is not a member of\na G Suite for Education domain, than this field wil
l always be false.\n\nRead-only", | |
2042 "type": "boolean" | |
2043 } | 1898 } |
2044 }, | 1899 }, |
2045 "type": "object" | 1900 "type": "object" |
2046 }, | 1901 }, |
2047 "ListStudentsResponse": { | 1902 "ListStudentsResponse": { |
2048 "description": "Response when listing students.", | 1903 "description": "Response when listing students.", |
2049 "id": "ListStudentsResponse", | 1904 "id": "ListStudentsResponse", |
2050 "properties": { | 1905 "properties": { |
2051 "nextPageToken": { | 1906 "nextPageToken": { |
2052 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | 1907 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
(...skipping 42 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2095 }, | 1950 }, |
2096 "id": { | 1951 "id": { |
2097 "description": "Identifier assigned by Classroom.\n\nRead-on
ly.", | 1952 "description": "Identifier assigned by Classroom.\n\nRead-on
ly.", |
2098 "type": "string" | 1953 "type": "string" |
2099 }, | 1954 }, |
2100 "role": { | 1955 "role": { |
2101 "description": "Role to invite the user to have.\nMust not b
e `COURSE_ROLE_UNSPECIFIED`.", | 1956 "description": "Role to invite the user to have.\nMust not b
e `COURSE_ROLE_UNSPECIFIED`.", |
2102 "enum": [ | 1957 "enum": [ |
2103 "COURSE_ROLE_UNSPECIFIED", | 1958 "COURSE_ROLE_UNSPECIFIED", |
2104 "STUDENT", | 1959 "STUDENT", |
2105 "TEACHER" | 1960 "TEACHER", |
| 1961 "OWNER" |
2106 ], | 1962 ], |
2107 "enumDescriptions": [ | 1963 "enumDescriptions": [ |
2108 "No course role.", | 1964 "No course role.", |
2109 "Student in the course.", | 1965 "Student in the course.", |
2110 "Teacher of the course." | 1966 "Teacher of the course.", |
| 1967 "Owner of the course." |
2111 ], | 1968 ], |
2112 "type": "string" | 1969 "type": "string" |
2113 }, | 1970 }, |
2114 "userId": { | 1971 "userId": { |
2115 "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", | 1972 "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", |
2116 "type": "string" | 1973 "type": "string" |
2117 } | 1974 } |
2118 }, | 1975 }, |
2119 "type": "object" | 1976 "type": "object" |
2120 }, | 1977 }, |
2121 "DriveFolder": { | 1978 "DriveFolder": { |
2122 "description": "Representation of a Google Drive folder.", | 1979 "description": "Representation of a Google Drive folder.", |
2123 "id": "DriveFolder", | 1980 "id": "DriveFolder", |
2124 "properties": { | 1981 "properties": { |
2125 "title": { | 1982 "title": { |
2126 "description": "Title of the Drive folder.\n\nRead-only.", | 1983 "description": "Title of the Drive folder.\n\nRead-only.", |
2127 "type": "string" | 1984 "type": "string" |
2128 }, | 1985 }, |
2129 "alternateLink": { | 1986 "alternateLink": { |
2130 "description": "URL that can be used to access the Drive fol
der.\n\nRead-only.", | 1987 "description": "URL that can be used to access the Drive fol
der.\n\nRead-only.", |
2131 "type": "string" | 1988 "type": "string" |
2132 }, | 1989 }, |
2133 "id": { | 1990 "id": { |
2134 "description": "Drive API resource ID.", | 1991 "description": "Drive API resource ID.", |
2135 "type": "string" | 1992 "type": "string" |
2136 } | 1993 } |
2137 }, | 1994 }, |
2138 "type": "object" | 1995 "type": "object" |
2139 }, | 1996 }, |
| 1997 "SubmissionHistory": { |
| 1998 "description": "The history of the submission. This currently includ
es state and grade\nhistories.", |
| 1999 "id": "SubmissionHistory", |
| 2000 "properties": { |
| 2001 "stateHistory": { |
| 2002 "$ref": "StateHistory", |
| 2003 "description": "The state history information of the submiss
ion, if present." |
| 2004 }, |
| 2005 "gradeHistory": { |
| 2006 "$ref": "GradeHistory", |
| 2007 "description": "The grade history information of the submiss
ion, if present." |
| 2008 } |
| 2009 }, |
| 2010 "type": "object" |
| 2011 }, |
2140 "ShortAnswerSubmission": { | 2012 "ShortAnswerSubmission": { |
2141 "description": "Student work for a short answer question.", | 2013 "description": "Student work for a short answer question.", |
2142 "id": "ShortAnswerSubmission", | 2014 "id": "ShortAnswerSubmission", |
2143 "properties": { | 2015 "properties": { |
2144 "answer": { | 2016 "answer": { |
2145 "description": "Student response to a short-answer question.
", | 2017 "description": "Student response to a short-answer question.
", |
2146 "type": "string" | 2018 "type": "string" |
2147 } | 2019 } |
2148 }, | 2020 }, |
2149 "type": "object" | 2021 "type": "object" |
2150 }, | 2022 }, |
2151 "StudentSubmission": { | 2023 "StudentSubmission": { |
2152 "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.", | 2024 "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.", |
2153 "id": "StudentSubmission", | 2025 "id": "StudentSubmission", |
2154 "properties": { | 2026 "properties": { |
| 2027 "shortAnswerSubmission": { |
| 2028 "$ref": "ShortAnswerSubmission", |
| 2029 "description": "Submission content when course_work_type is
SHORT_ANSWER_QUESTION." |
| 2030 }, |
| 2031 "associatedWithDeveloper": { |
| 2032 "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.", |
| 2033 "type": "boolean" |
| 2034 }, |
| 2035 "updateTime": { |
| 2036 "description": "Last update time of this submission.\nThis m
ay be unset if the student has not accessed this item.\n\nRead-only.", |
| 2037 "format": "google-datetime", |
| 2038 "type": "string" |
| 2039 }, |
| 2040 "alternateLink": { |
| 2041 "description": "Absolute link to the submission in the Class
room web UI.\n\nRead-only.", |
| 2042 "type": "string" |
| 2043 }, |
| 2044 "draftGrade": { |
| 2045 "description": "Optional pending grade. If unset, no grade w
as set.\nThis value must be non-negative. Decimal (i.e. non-integer) values are\
nallowed, but will be rounded to two decimal places.\n\nThis is only visible to
and modifiable by course teachers.", |
| 2046 "format": "double", |
| 2047 "type": "number" |
| 2048 }, |
| 2049 "late": { |
| 2050 "description": "Whether this submission is late.\n\nRead-onl
y.", |
| 2051 "type": "boolean" |
| 2052 }, |
| 2053 "courseWorkType": { |
| 2054 "description": "Type of course work this submission is for.\
n\nRead-only.", |
| 2055 "enum": [ |
| 2056 "COURSE_WORK_TYPE_UNSPECIFIED", |
| 2057 "ASSIGNMENT", |
| 2058 "SHORT_ANSWER_QUESTION", |
| 2059 "MULTIPLE_CHOICE_QUESTION" |
| 2060 ], |
| 2061 "enumDescriptions": [ |
| 2062 "No work type specified. This is never returned.", |
| 2063 "An assignment.", |
| 2064 "A short answer question.", |
| 2065 "A multiple-choice question." |
| 2066 ], |
| 2067 "type": "string" |
| 2068 }, |
| 2069 "creationTime": { |
| 2070 "description": "Creation time of this submission.\nThis may
be unset if the student has not accessed this item.\n\nRead-only.", |
| 2071 "format": "google-datetime", |
| 2072 "type": "string" |
| 2073 }, |
2155 "state": { | 2074 "state": { |
2156 "description": "State of this submission.\n\nRead-only.", | 2075 "description": "State of this submission.\n\nRead-only.", |
2157 "enum": [ | 2076 "enum": [ |
2158 "SUBMISSION_STATE_UNSPECIFIED", | 2077 "SUBMISSION_STATE_UNSPECIFIED", |
2159 "NEW", | 2078 "NEW", |
2160 "CREATED", | 2079 "CREATED", |
2161 "TURNED_IN", | 2080 "TURNED_IN", |
2162 "RETURNED", | 2081 "RETURNED", |
2163 "RECLAIMED_BY_STUDENT" | 2082 "RECLAIMED_BY_STUDENT" |
2164 ], | 2083 ], |
(...skipping 16 matching lines...) Expand all Loading... |
2181 "type": "string" | 2100 "type": "string" |
2182 }, | 2101 }, |
2183 "courseId": { | 2102 "courseId": { |
2184 "description": "Identifier of the course.\n\nRead-only.", | 2103 "description": "Identifier of the course.\n\nRead-only.", |
2185 "type": "string" | 2104 "type": "string" |
2186 }, | 2105 }, |
2187 "id": { | 2106 "id": { |
2188 "description": "Classroom-assigned Identifier for the studen
t submission.\nThis is unique among submissions for the relevant course work.\n\
nRead-only.", | 2107 "description": "Classroom-assigned Identifier for the studen
t submission.\nThis is unique among submissions for the relevant course work.\n\
nRead-only.", |
2189 "type": "string" | 2108 "type": "string" |
2190 }, | 2109 }, |
| 2110 "submissionHistory": { |
| 2111 "description": "The history of the submission (includes stat
e and grade histories).\n\nRead-only.", |
| 2112 "items": { |
| 2113 "$ref": "SubmissionHistory" |
| 2114 }, |
| 2115 "type": "array" |
| 2116 }, |
2191 "assignedGrade": { | 2117 "assignedGrade": { |
2192 "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.", | 2118 "description": "Optional grade. If unset, no grade was set.\
nThis value must be non-negative. Decimal (i.e. non-integer) values are\nallowed
, but will be rounded to two decimal places.\n\nThis may be modified only by cou
rse teachers.", |
2193 "format": "double", | 2119 "format": "double", |
2194 "type": "number" | 2120 "type": "number" |
2195 }, | 2121 }, |
2196 "multipleChoiceSubmission": { | 2122 "multipleChoiceSubmission": { |
2197 "$ref": "MultipleChoiceSubmission", | 2123 "$ref": "MultipleChoiceSubmission", |
2198 "description": "Submission content when course_work_type is
MULTIPLE_CHOICE_QUESTION." | 2124 "description": "Submission content when course_work_type is
MULTIPLE_CHOICE_QUESTION." |
2199 }, | 2125 }, |
2200 "assignmentSubmission": { | 2126 "assignmentSubmission": { |
2201 "$ref": "AssignmentSubmission", | 2127 "$ref": "AssignmentSubmission", |
2202 "description": "Submission content when course_work_type is
ASSIGNMENT ." | 2128 "description": "Submission content when course_work_type is
ASSIGNMENT ." |
2203 }, | |
2204 "associatedWithDeveloper": { | |
2205 "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.", | |
2206 "type": "boolean" | |
2207 }, | |
2208 "shortAnswerSubmission": { | |
2209 "$ref": "ShortAnswerSubmission", | |
2210 "description": "Submission content when course_work_type is
SHORT_ANSWER_QUESTION." | |
2211 }, | |
2212 "updateTime": { | |
2213 "description": "Last update time of this submission.\nThis m
ay be unset if the student has not accessed this item.\n\nRead-only.", | |
2214 "format": "google-datetime", | |
2215 "type": "string" | |
2216 }, | |
2217 "alternateLink": { | |
2218 "description": "Absolute link to the submission in the Class
room web UI.\n\nRead-only.", | |
2219 "type": "string" | |
2220 }, | |
2221 "draftGrade": { | |
2222 "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.", | |
2223 "format": "double", | |
2224 "type": "number" | |
2225 }, | |
2226 "late": { | |
2227 "description": "Whether this submission is late.\n\nRead-onl
y.", | |
2228 "type": "boolean" | |
2229 }, | |
2230 "courseWorkType": { | |
2231 "description": "Type of course work this submission is for.\
n\nRead-only.", | |
2232 "enum": [ | |
2233 "COURSE_WORK_TYPE_UNSPECIFIED", | |
2234 "ASSIGNMENT", | |
2235 "SHORT_ANSWER_QUESTION", | |
2236 "MULTIPLE_CHOICE_QUESTION" | |
2237 ], | |
2238 "enumDescriptions": [ | |
2239 "No work type specified. This is never returned.", | |
2240 "An assignment.", | |
2241 "A short answer question.", | |
2242 "A multiple-choice question." | |
2243 ], | |
2244 "type": "string" | |
2245 }, | |
2246 "creationTime": { | |
2247 "description": "Creation time of this submission.\nThis may
be unset if the student has not accessed this item.\n\nRead-only.", | |
2248 "format": "google-datetime", | |
2249 "type": "string" | |
2250 } | 2129 } |
2251 }, | 2130 }, |
2252 "type": "object" | 2131 "type": "object" |
2253 }, | 2132 }, |
2254 "ListStudentSubmissionsResponse": { | 2133 "ListStudentSubmissionsResponse": { |
2255 "description": "Response when listing student submissions.", | 2134 "description": "Response when listing student submissions.", |
2256 "id": "ListStudentSubmissionsResponse", | 2135 "id": "ListStudentSubmissionsResponse", |
2257 "properties": { | 2136 "properties": { |
2258 "nextPageToken": { | 2137 "nextPageToken": { |
2259 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | 2138 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
(...skipping 44 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2304 }, | 2183 }, |
2305 "type": "array" | 2184 "type": "array" |
2306 } | 2185 } |
2307 }, | 2186 }, |
2308 "type": "object" | 2187 "type": "object" |
2309 }, | 2188 }, |
2310 "YouTubeVideo": { | 2189 "YouTubeVideo": { |
2311 "description": "YouTube video item.", | 2190 "description": "YouTube video item.", |
2312 "id": "YouTubeVideo", | 2191 "id": "YouTubeVideo", |
2313 "properties": { | 2192 "properties": { |
| 2193 "id": { |
| 2194 "description": "YouTube API resource ID.", |
| 2195 "type": "string" |
| 2196 }, |
2314 "title": { | 2197 "title": { |
2315 "description": "Title of the YouTube video.\n\nRead-only.", | 2198 "description": "Title of the YouTube video.\n\nRead-only.", |
2316 "type": "string" | 2199 "type": "string" |
2317 }, | 2200 }, |
2318 "alternateLink": { | 2201 "alternateLink": { |
2319 "description": "URL that can be used to view the YouTube vid
eo.\n\nRead-only.", | 2202 "description": "URL that can be used to view the YouTube vid
eo.\n\nRead-only.", |
2320 "type": "string" | 2203 "type": "string" |
2321 }, | 2204 }, |
2322 "thumbnailUrl": { | 2205 "thumbnailUrl": { |
2323 "description": "URL of a thumbnail image of the YouTube vide
o.\n\nRead-only.", | 2206 "description": "URL of a thumbnail image of the YouTube vide
o.\n\nRead-only.", |
2324 "type": "string" | 2207 "type": "string" |
2325 }, | |
2326 "id": { | |
2327 "description": "YouTube API resource ID.", | |
2328 "type": "string" | |
2329 } | 2208 } |
2330 }, | 2209 }, |
2331 "type": "object" | 2210 "type": "object" |
2332 }, | 2211 }, |
2333 "ListInvitationsResponse": { | 2212 "ListInvitationsResponse": { |
2334 "description": "Response when listing invitations.", | 2213 "description": "Response when listing invitations.", |
2335 "id": "ListInvitationsResponse", | 2214 "id": "ListInvitationsResponse", |
2336 "properties": { | 2215 "properties": { |
2337 "nextPageToken": { | 2216 "nextPageToken": { |
2338 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | 2217 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
2339 "type": "string" | 2218 "type": "string" |
2340 }, | 2219 }, |
2341 "invitations": { | 2220 "invitations": { |
2342 "description": "Invitations that match the list request.", | 2221 "description": "Invitations that match the list request.", |
2343 "items": { | 2222 "items": { |
2344 "$ref": "Invitation" | 2223 "$ref": "Invitation" |
2345 }, | 2224 }, |
2346 "type": "array" | 2225 "type": "array" |
2347 } | 2226 } |
2348 }, | 2227 }, |
2349 "type": "object" | 2228 "type": "object" |
2350 }, | 2229 }, |
| 2230 "Attachment": { |
| 2231 "description": "Attachment added to student assignment work.\n\nWhen
creating attachments, setting the `form` field is not supported.", |
| 2232 "id": "Attachment", |
| 2233 "properties": { |
| 2234 "youTubeVideo": { |
| 2235 "$ref": "YouTubeVideo", |
| 2236 "description": "Youtube video attachment." |
| 2237 }, |
| 2238 "driveFile": { |
| 2239 "$ref": "DriveFile", |
| 2240 "description": "Google Drive file attachment." |
| 2241 }, |
| 2242 "form": { |
| 2243 "$ref": "Form", |
| 2244 "description": "Google Forms attachment." |
| 2245 }, |
| 2246 "link": { |
| 2247 "$ref": "Link", |
| 2248 "description": "Link attachment." |
| 2249 } |
| 2250 }, |
| 2251 "type": "object" |
| 2252 }, |
2351 "GuardianInvitation": { | 2253 "GuardianInvitation": { |
2352 "description": "An invitation to become the guardian of a specified
user, sent to a specified\nemail address.", | 2254 "description": "An invitation to become the guardian of a specified
user, sent to a specified\nemail address.", |
2353 "id": "GuardianInvitation", | 2255 "id": "GuardianInvitation", |
2354 "properties": { | 2256 "properties": { |
2355 "invitedEmailAddress": { | |
2356 "description": "Email address that the invitation was sent t
o.\nThis field is only visible to domain administrators.", | |
2357 "type": "string" | |
2358 }, | |
2359 "creationTime": { | 2257 "creationTime": { |
2360 "description": "The time that this invitation was created.\n
\nRead-only.", | 2258 "description": "The time that this invitation was created.\n
\nRead-only.", |
2361 "format": "google-datetime", | 2259 "format": "google-datetime", |
2362 "type": "string" | 2260 "type": "string" |
2363 }, | 2261 }, |
2364 "invitationId": { | 2262 "invitationId": { |
2365 "description": "Unique identifier for this invitation.\n\nRe
ad-only.", | 2263 "description": "Unique identifier for this invitation.\n\nRe
ad-only.", |
2366 "type": "string" | 2264 "type": "string" |
2367 }, | 2265 }, |
2368 "state": { | 2266 "state": { |
2369 "description": "The state that this invitation is in.", | 2267 "description": "The state that this invitation is in.", |
2370 "enum": [ | 2268 "enum": [ |
2371 "GUARDIAN_INVITATION_STATE_UNSPECIFIED", | 2269 "GUARDIAN_INVITATION_STATE_UNSPECIFIED", |
2372 "PENDING", | 2270 "PENDING", |
2373 "COMPLETE" | 2271 "COMPLETE" |
2374 ], | 2272 ], |
2375 "enumDescriptions": [ | 2273 "enumDescriptions": [ |
2376 "Should never be returned.", | 2274 "Should never be returned.", |
2377 "The invitation is active and awaiting a response.", | 2275 "The invitation is active and awaiting a response.", |
2378 "The invitation is no longer active. It may have been ac
cepted, declined,\nwithdrawn or it may have expired." | 2276 "The invitation is no longer active. It may have been ac
cepted, declined,\nwithdrawn or it may have expired." |
2379 ], | 2277 ], |
2380 "type": "string" | 2278 "type": "string" |
2381 }, | 2279 }, |
2382 "studentId": { | 2280 "studentId": { |
2383 "description": "ID of the student (in standard format)", | 2281 "description": "ID of the student (in standard format)", |
2384 "type": "string" | 2282 "type": "string" |
| 2283 }, |
| 2284 "invitedEmailAddress": { |
| 2285 "description": "Email address that the invitation was sent t
o.\nThis field is only visible to domain administrators.", |
| 2286 "type": "string" |
2385 } | 2287 } |
2386 }, | 2288 }, |
2387 "type": "object" | 2289 "type": "object" |
2388 }, | 2290 }, |
2389 "Attachment": { | 2291 "StateHistory": { |
2390 "description": "Attachment added to student assignment work.\n\nWhen
creating attachments, setting the `form` field is not supported.", | 2292 "description": "The history of each state this submission has been i
n.", |
2391 "id": "Attachment", | 2293 "id": "StateHistory", |
2392 "properties": { | 2294 "properties": { |
2393 "youTubeVideo": { | 2295 "state": { |
2394 "$ref": "YouTubeVideo", | 2296 "description": "The workflow pipeline stage.", |
2395 "description": "Youtube video attachment." | 2297 "enum": [ |
| 2298 "STATE_UNSPECIFIED", |
| 2299 "CREATED", |
| 2300 "TURNED_IN", |
| 2301 "RETURNED", |
| 2302 "RECLAIMED_BY_STUDENT", |
| 2303 "STUDENT_EDITED_AFTER_TURN_IN" |
| 2304 ], |
| 2305 "enumDescriptions": [ |
| 2306 "No state specified. This should never be returned.", |
| 2307 "The Submission has been created.", |
| 2308 "The student has turned in an assigned document, which m
ay or may not be\na template.", |
| 2309 "The teacher has returned the assigned document to the s
tudent.", |
| 2310 "The student turned in the assigned document, and then c
hose to\n\"unsubmit\" the assignment, giving the student control again as the\no
wner.", |
| 2311 "The student edited their submission after turning it in
. Currently,\nonly used by Questions, when the student edits their answer." |
| 2312 ], |
| 2313 "type": "string" |
2396 }, | 2314 }, |
2397 "driveFile": { | 2315 "stateTimestamp": { |
2398 "$ref": "DriveFile", | 2316 "description": "When the submission entered this state.", |
2399 "description": "Google Drive file attachment." | 2317 "format": "google-datetime", |
| 2318 "type": "string" |
2400 }, | 2319 }, |
2401 "form": { | 2320 "actorUserId": { |
2402 "$ref": "Form", | 2321 "description": "The teacher or student who made the change", |
2403 "description": "Google Forms attachment." | 2322 "type": "string" |
2404 }, | |
2405 "link": { | |
2406 "$ref": "Link", | |
2407 "description": "Link attachment." | |
2408 } | 2323 } |
2409 }, | 2324 }, |
2410 "type": "object" | 2325 "type": "object" |
2411 }, | 2326 }, |
2412 "CourseMaterialSet": { | 2327 "CourseMaterialSet": { |
2413 "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.", | 2328 "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.", |
2414 "id": "CourseMaterialSet", | 2329 "id": "CourseMaterialSet", |
2415 "properties": { | 2330 "properties": { |
2416 "materials": { | 2331 "materials": { |
2417 "description": "Materials attached to this set.", | 2332 "description": "Materials attached to this set.", |
2418 "items": { | 2333 "items": { |
2419 "$ref": "CourseMaterial" | 2334 "$ref": "CourseMaterial" |
2420 }, | 2335 }, |
2421 "type": "array" | 2336 "type": "array" |
2422 }, | 2337 }, |
2423 "title": { | 2338 "title": { |
2424 "description": "Title for this set.", | 2339 "description": "Title for this set.", |
2425 "type": "string" | 2340 "type": "string" |
2426 } | 2341 } |
2427 }, | 2342 }, |
2428 "type": "object" | 2343 "type": "object" |
2429 }, | 2344 }, |
2430 "TimeOfDay": { | 2345 "TimeOfDay": { |
2431 "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
`.", | 2346 "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
`.", |
2432 "id": "TimeOfDay", | 2347 "id": "TimeOfDay", |
2433 "properties": { | 2348 "properties": { |
| 2349 "minutes": { |
| 2350 "description": "Minutes of hour of day. Must be from 0 to 59
.", |
| 2351 "format": "int32", |
| 2352 "type": "integer" |
| 2353 }, |
| 2354 "hours": { |
| 2355 "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.", |
| 2356 "format": "int32", |
| 2357 "type": "integer" |
| 2358 }, |
2434 "nanos": { | 2359 "nanos": { |
2435 "description": "Fractions of seconds in nanoseconds. Must be
from 0 to 999,999,999.", | 2360 "description": "Fractions of seconds in nanoseconds. Must be
from 0 to 999,999,999.", |
2436 "format": "int32", | 2361 "format": "int32", |
2437 "type": "integer" | 2362 "type": "integer" |
2438 }, | 2363 }, |
2439 "seconds": { | 2364 "seconds": { |
2440 "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.", | 2365 "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.", |
2441 "format": "int32", | 2366 "format": "int32", |
2442 "type": "integer" | 2367 "type": "integer" |
2443 }, | |
2444 "minutes": { | |
2445 "description": "Minutes of hour of day. Must be from 0 to 59
.", | |
2446 "format": "int32", | |
2447 "type": "integer" | |
2448 }, | |
2449 "hours": { | |
2450 "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.", | |
2451 "format": "int32", | |
2452 "type": "integer" | |
2453 } | 2368 } |
2454 }, | 2369 }, |
2455 "type": "object" | 2370 "type": "object" |
2456 }, | 2371 }, |
2457 "ListCoursesResponse": { | 2372 "ListCoursesResponse": { |
2458 "description": "Response when listing courses.", | 2373 "description": "Response when listing courses.", |
2459 "id": "ListCoursesResponse", | 2374 "id": "ListCoursesResponse", |
2460 "properties": { | 2375 "properties": { |
| 2376 "nextPageToken": { |
| 2377 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
| 2378 "type": "string" |
| 2379 }, |
2461 "courses": { | 2380 "courses": { |
2462 "description": "Courses that match the list request.", | 2381 "description": "Courses that match the list request.", |
2463 "items": { | 2382 "items": { |
2464 "$ref": "Course" | 2383 "$ref": "Course" |
2465 }, | 2384 }, |
2466 "type": "array" | 2385 "type": "array" |
2467 }, | |
2468 "nextPageToken": { | |
2469 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | |
2470 "type": "string" | |
2471 } | 2386 } |
2472 }, | 2387 }, |
2473 "type": "object" | 2388 "type": "object" |
2474 }, | 2389 }, |
2475 "Form": { | 2390 "Form": { |
2476 "description": "Google Forms item.", | 2391 "description": "Google Forms item.", |
2477 "id": "Form", | 2392 "id": "Form", |
2478 "properties": { | 2393 "properties": { |
2479 "thumbnailUrl": { | 2394 "thumbnailUrl": { |
2480 "description": "URL of a thumbnail image of the Form.\n\nRea
d-only.", | 2395 "description": "URL of a thumbnail image of the Form.\n\nRea
d-only.", |
(...skipping 29 matching lines...) Expand all Loading... |
2510 }, | 2425 }, |
2511 "type": "array" | 2426 "type": "array" |
2512 } | 2427 } |
2513 }, | 2428 }, |
2514 "type": "object" | 2429 "type": "object" |
2515 }, | 2430 }, |
2516 "Link": { | 2431 "Link": { |
2517 "description": "URL item.", | 2432 "description": "URL item.", |
2518 "id": "Link", | 2433 "id": "Link", |
2519 "properties": { | 2434 "properties": { |
| 2435 "url": { |
| 2436 "description": "URL to link to.\nThis must be a valid UTF-8
string containing between 1 and 2024 characters.", |
| 2437 "type": "string" |
| 2438 }, |
2520 "title": { | 2439 "title": { |
2521 "description": "Title of the target of the URL.\n\nRead-only
.", | 2440 "description": "Title of the target of the URL.\n\nRead-only
.", |
2522 "type": "string" | 2441 "type": "string" |
2523 }, | 2442 }, |
2524 "thumbnailUrl": { | 2443 "thumbnailUrl": { |
2525 "description": "URL of a thumbnail image of the target URL.\
n\nRead-only.", | 2444 "description": "URL of a thumbnail image of the target URL.\
n\nRead-only.", |
2526 "type": "string" | 2445 "type": "string" |
2527 }, | |
2528 "url": { | |
2529 "description": "URL to link to.\nThis must be a valid UTF-8
string containing between 1 and 2024 characters.", | |
2530 "type": "string" | |
2531 } | 2446 } |
2532 }, | 2447 }, |
2533 "type": "object" | 2448 "type": "object" |
2534 }, | 2449 }, |
2535 "ListGuardiansResponse": { | 2450 "ListGuardiansResponse": { |
2536 "description": "Response when listing guardians.", | 2451 "description": "Response when listing guardians.", |
2537 "id": "ListGuardiansResponse", | 2452 "id": "ListGuardiansResponse", |
2538 "properties": { | 2453 "properties": { |
| 2454 "nextPageToken": { |
| 2455 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
| 2456 "type": "string" |
| 2457 }, |
2539 "guardians": { | 2458 "guardians": { |
2540 "description": "Guardians on this page of results that met t
he criteria specified in\nthe request.", | 2459 "description": "Guardians on this page of results that met t
he criteria specified in\nthe request.", |
2541 "items": { | 2460 "items": { |
2542 "$ref": "Guardian" | 2461 "$ref": "Guardian" |
2543 }, | 2462 }, |
2544 "type": "array" | 2463 "type": "array" |
2545 }, | |
2546 "nextPageToken": { | |
2547 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | |
2548 "type": "string" | |
2549 } | 2464 } |
2550 }, | 2465 }, |
2551 "type": "object" | 2466 "type": "object" |
2552 }, | 2467 }, |
2553 "ListCourseAliasesResponse": { | 2468 "ListGuardianInvitationsResponse": { |
2554 "description": "Response when listing course aliases.", | 2469 "description": "Response when listing guardian invitations.", |
2555 "id": "ListCourseAliasesResponse", | 2470 "id": "ListGuardianInvitationsResponse", |
2556 "properties": { | 2471 "properties": { |
2557 "aliases": { | 2472 "guardianInvitations": { |
2558 "description": "The course aliases.", | 2473 "description": "Guardian invitations that matched the list r
equest.", |
2559 "items": { | 2474 "items": { |
2560 "$ref": "CourseAlias" | 2475 "$ref": "GuardianInvitation" |
2561 }, | 2476 }, |
2562 "type": "array" | 2477 "type": "array" |
2563 }, | 2478 }, |
2564 "nextPageToken": { | 2479 "nextPageToken": { |
2565 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | 2480 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
2566 "type": "string" | 2481 "type": "string" |
2567 } | 2482 } |
2568 }, | 2483 }, |
2569 "type": "object" | 2484 "type": "object" |
2570 }, | 2485 }, |
2571 "ListGuardianInvitationsResponse": { | 2486 "ListCourseAliasesResponse": { |
2572 "description": "Response when listing guardian invitations.", | 2487 "description": "Response when listing course aliases.", |
2573 "id": "ListGuardianInvitationsResponse", | 2488 "id": "ListCourseAliasesResponse", |
2574 "properties": { | 2489 "properties": { |
2575 "guardianInvitations": { | 2490 "aliases": { |
2576 "description": "Guardian invitations that matched the list r
equest.", | 2491 "description": "The course aliases.", |
2577 "items": { | 2492 "items": { |
2578 "$ref": "GuardianInvitation" | 2493 "$ref": "CourseAlias" |
2579 }, | 2494 }, |
2580 "type": "array" | 2495 "type": "array" |
2581 }, | 2496 }, |
2582 "nextPageToken": { | 2497 "nextPageToken": { |
2583 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | 2498 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
2584 "type": "string" | 2499 "type": "string" |
2585 } | 2500 } |
2586 }, | 2501 }, |
2587 "type": "object" | 2502 "type": "object" |
2588 }, | 2503 }, |
(...skipping 38 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2627 "description": "Student's select choice.", | 2542 "description": "Student's select choice.", |
2628 "type": "string" | 2543 "type": "string" |
2629 } | 2544 } |
2630 }, | 2545 }, |
2631 "type": "object" | 2546 "type": "object" |
2632 }, | 2547 }, |
2633 "Name": { | 2548 "Name": { |
2634 "description": "Details of the user's name.", | 2549 "description": "Details of the user's name.", |
2635 "id": "Name", | 2550 "id": "Name", |
2636 "properties": { | 2551 "properties": { |
| 2552 "fullName": { |
| 2553 "description": "The user's full name formed by concatenating
the first and last name\nvalues.\n\nRead-only.", |
| 2554 "type": "string" |
| 2555 }, |
2637 "familyName": { | 2556 "familyName": { |
2638 "description": "The user's last name.\n\nRead-only.", | 2557 "description": "The user's last name.\n\nRead-only.", |
2639 "type": "string" | 2558 "type": "string" |
2640 }, | 2559 }, |
2641 "givenName": { | 2560 "givenName": { |
2642 "description": "The user's first name.\n\nRead-only.", | 2561 "description": "The user's first name.\n\nRead-only.", |
2643 "type": "string" | 2562 "type": "string" |
2644 }, | |
2645 "fullName": { | |
2646 "description": "The user's full name formed by concatenating
the first and last name\nvalues.\n\nRead-only.", | |
2647 "type": "string" | |
2648 } | 2563 } |
2649 }, | 2564 }, |
2650 "type": "object" | 2565 "type": "object" |
2651 }, | 2566 }, |
2652 "CourseMaterial": { | 2567 "CourseMaterial": { |
2653 "description": "A material attached to a course as part of a materia
l set.", | 2568 "description": "A material attached to a course as part of a materia
l set.", |
2654 "id": "CourseMaterial", | 2569 "id": "CourseMaterial", |
2655 "properties": { | 2570 "properties": { |
2656 "youTubeVideo": { | 2571 "youTubeVideo": { |
2657 "$ref": "YouTubeVideo", | 2572 "$ref": "YouTubeVideo", |
(...skipping 44 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2702 "Students have a personal copy of the shared file." | 2617 "Students have a personal copy of the shared file." |
2703 ], | 2618 ], |
2704 "type": "string" | 2619 "type": "string" |
2705 }, | 2620 }, |
2706 "driveFile": { | 2621 "driveFile": { |
2707 "$ref": "DriveFile", | 2622 "$ref": "DriveFile", |
2708 "description": "Drive file details." | 2623 "description": "Drive file details." |
2709 } | 2624 } |
2710 }, | 2625 }, |
2711 "type": "object" | 2626 "type": "object" |
| 2627 }, |
| 2628 "Empty": { |
| 2629 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
| 2630 "id": "Empty", |
| 2631 "properties": {}, |
| 2632 "type": "object" |
| 2633 }, |
| 2634 "MultipleChoiceQuestion": { |
| 2635 "description": "Additional details for multiple-choice questions.", |
| 2636 "id": "MultipleChoiceQuestion", |
| 2637 "properties": { |
| 2638 "choices": { |
| 2639 "description": "Possible choices.", |
| 2640 "items": { |
| 2641 "type": "string" |
| 2642 }, |
| 2643 "type": "array" |
| 2644 } |
| 2645 }, |
| 2646 "type": "object" |
| 2647 }, |
| 2648 "Course": { |
| 2649 "description": "A Course in Classroom.", |
| 2650 "id": "Course", |
| 2651 "properties": { |
| 2652 "courseGroupEmail": { |
| 2653 "description": "The email address of a Google group containi
ng all members of the course.\nThis group does not accept email and can only be
used for permissions.\n\nRead-only.", |
| 2654 "type": "string" |
| 2655 }, |
| 2656 "courseMaterialSets": { |
| 2657 "description": "Sets of materials that appear on the \"about
\" page of this course.\n\nRead-only.", |
| 2658 "items": { |
| 2659 "$ref": "CourseMaterialSet" |
| 2660 }, |
| 2661 "type": "array" |
| 2662 }, |
| 2663 "enrollmentCode": { |
| 2664 "description": "Enrollment code to use when joining this cou
rse.\nSpecifying this field in a course update mask results in an error.\n\nRead
-only.", |
| 2665 "type": "string" |
| 2666 }, |
| 2667 "descriptionHeading": { |
| 2668 "description": "Optional heading for the description.\nFor e
xample, \"Welcome to 10th Grade Biology.\"\nIf set, this field must be a valid U
TF-8 string and no longer than 3600\ncharacters.", |
| 2669 "type": "string" |
| 2670 }, |
| 2671 "calendarId": { |
| 2672 "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.", |
| 2673 "type": "string" |
| 2674 }, |
| 2675 "updateTime": { |
| 2676 "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.", |
| 2677 "format": "google-datetime", |
| 2678 "type": "string" |
| 2679 }, |
| 2680 "alternateLink": { |
| 2681 "description": "Absolute link to this course in the Classroo
m web UI.\n\nRead-only.", |
| 2682 "type": "string" |
| 2683 }, |
| 2684 "guardiansEnabled": { |
| 2685 "description": "Whether or not guardian notifications are en
abled for this course.\n\nRead-only.", |
| 2686 "type": "boolean" |
| 2687 }, |
| 2688 "ownerId": { |
| 2689 "description": "The identifier of the owner of a course.\n\n
When specified as a parameter of a\ncreate course request, this\nfield is requir
ed.\nThe identifier can be one of the following:\n\n* the numeric identifier for
the user\n* the email address of the user\n* the string literal `\"me\"`, indic
ating the requesting user\n\nThis must be set in a create request. Admins can al
so specify this field\nin a patch course request to\ntransfer ownership. In othe
r contexts, it is read-only.", |
| 2690 "type": "string" |
| 2691 }, |
| 2692 "courseState": { |
| 2693 "description": "State of the course.\nIf unspecified, the de
fault state is `PROVISIONED`.", |
| 2694 "enum": [ |
| 2695 "COURSE_STATE_UNSPECIFIED", |
| 2696 "ACTIVE", |
| 2697 "ARCHIVED", |
| 2698 "PROVISIONED", |
| 2699 "DECLINED", |
| 2700 "SUSPENDED" |
| 2701 ], |
| 2702 "enumDescriptions": [ |
| 2703 "No course state. No returned Course message will use th
is value.", |
| 2704 "The course is active.", |
| 2705 "The course has been archived. You cannot modify it exce
pt to change it\nto a different state.", |
| 2706 "The course has been created, but not yet activated. It
is accessible by\nthe primary teacher and domain administrators, who may modify
it or\nchange it to the `ACTIVE` or `DECLINED` states.\nA course may only be cha
nged to `PROVISIONED` if it is in the `DECLINED`\nstate.", |
| 2707 "The course has been created, but declined. It is access
ible by the\ncourse owner and domain administrators, though it will not be\ndisp
layed in the web UI. You cannot modify the course except to change it\nto the `P
ROVISIONED` state.\nA course may only be changed to `DECLINED` if it is in the `
PROVISIONED`\nstate.", |
| 2708 "The course has been suspended. You cannot modify the co
urse, and only the\nuser identified by the `owner_id` can view the course.\nA co
urse may be placed in this state if it potentially violates the\nTerms of Servic
e." |
| 2709 ], |
| 2710 "type": "string" |
| 2711 }, |
| 2712 "description": { |
| 2713 "description": "Optional description.\nFor example, \"We'll
be learning about the structure of living\ncreatures from a combination of textb
ooks, guest lectures, and lab work.\nExpect to be excited!\"\nIf set, this field
must be a valid UTF-8 string and no longer than 30,000\ncharacters.", |
| 2714 "type": "string" |
| 2715 }, |
| 2716 "teacherGroupEmail": { |
| 2717 "description": "The email address of a Google group containi
ng all teachers of the course.\nThis group does not accept email and can only be
used for permissions.\n\nRead-only.", |
| 2718 "type": "string" |
| 2719 }, |
| 2720 "creationTime": { |
| 2721 "description": "Creation time of the course.\nSpecifying thi
s field in a course update mask results in an error.\n\nRead-only.", |
| 2722 "format": "google-datetime", |
| 2723 "type": "string" |
| 2724 }, |
| 2725 "teacherFolder": { |
| 2726 "$ref": "DriveFolder", |
| 2727 "description": "Information about a Drive Folder that is sha
red with all teachers of the\ncourse.\n\nThis field will only be set for teacher
s of the course and domain administrators.\n\nRead-only." |
| 2728 }, |
| 2729 "name": { |
| 2730 "description": "Name of the course.\nFor example, \"10th Gra
de Biology\".\nThe name is required. It must be between 1 and 750 characters and
a valid\nUTF-8 string.", |
| 2731 "type": "string" |
| 2732 }, |
| 2733 "section": { |
| 2734 "description": "Section of the course.\nFor example, \"Perio
d 2\".\nIf set, this field must be a valid UTF-8 string and no longer than 2800\
ncharacters.", |
| 2735 "type": "string" |
| 2736 }, |
| 2737 "id": { |
| 2738 "description": "Identifier for this course assigned by Class
room.\n\nWhen\ncreating a course,\nyou may optionally set this identifier to an\
nalias string in the\nrequest to create a corresponding alias. The `id` is still
assigned by\nClassroom and cannot be updated after the course is created.\n\nSp
ecifying this field in a course update mask results in an error.", |
| 2739 "type": "string" |
| 2740 }, |
| 2741 "room": { |
| 2742 "description": "Optional room location.\nFor example, \"301\
".\nIf set, this field must be a valid UTF-8 string and no longer than 650\nchar
acters.", |
| 2743 "type": "string" |
| 2744 } |
| 2745 }, |
| 2746 "type": "object" |
| 2747 }, |
| 2748 "DriveFile": { |
| 2749 "description": "Representation of a Google Drive file.", |
| 2750 "id": "DriveFile", |
| 2751 "properties": { |
| 2752 "alternateLink": { |
| 2753 "description": "URL that can be used to access the Drive ite
m.\n\nRead-only.", |
| 2754 "type": "string" |
| 2755 }, |
| 2756 "thumbnailUrl": { |
| 2757 "description": "URL of a thumbnail image of the Drive item.\
n\nRead-only.", |
| 2758 "type": "string" |
| 2759 }, |
| 2760 "id": { |
| 2761 "description": "Drive API resource ID.", |
| 2762 "type": "string" |
| 2763 }, |
| 2764 "title": { |
| 2765 "description": "Title of the Drive item.\n\nRead-only.", |
| 2766 "type": "string" |
| 2767 } |
| 2768 }, |
| 2769 "type": "object" |
| 2770 }, |
| 2771 "GlobalPermission": { |
| 2772 "description": "Global user permission description.", |
| 2773 "id": "GlobalPermission", |
| 2774 "properties": { |
| 2775 "permission": { |
| 2776 "description": "Permission value.", |
| 2777 "enum": [ |
| 2778 "PERMISSION_UNSPECIFIED", |
| 2779 "CREATE_COURSE" |
| 2780 ], |
| 2781 "enumDescriptions": [ |
| 2782 "No permission is specified. This is not returned and is
not a\nvalid value.", |
| 2783 "User is permitted to create a course." |
| 2784 ], |
| 2785 "type": "string" |
| 2786 } |
| 2787 }, |
| 2788 "type": "object" |
| 2789 }, |
| 2790 "ReturnStudentSubmissionRequest": { |
| 2791 "description": "Request to return a student submission.", |
| 2792 "id": "ReturnStudentSubmissionRequest", |
| 2793 "properties": {}, |
| 2794 "type": "object" |
| 2795 }, |
| 2796 "Teacher": { |
| 2797 "description": "Teacher of a course.", |
| 2798 "id": "Teacher", |
| 2799 "properties": { |
| 2800 "profile": { |
| 2801 "$ref": "UserProfile", |
| 2802 "description": "Global user information for the teacher.\n\n
Read-only." |
| 2803 }, |
| 2804 "userId": { |
| 2805 "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", |
| 2806 "type": "string" |
| 2807 }, |
| 2808 "courseId": { |
| 2809 "description": "Identifier of the course.\n\nRead-only.", |
| 2810 "type": "string" |
| 2811 } |
| 2812 }, |
| 2813 "type": "object" |
2712 } | 2814 } |
2713 }, | 2815 }, |
2714 "servicePath": "", | 2816 "servicePath": "", |
2715 "title": "Google Classroom API", | 2817 "title": "Google Classroom API", |
2716 "version": "v1" | 2818 "version": "v1" |
2717 } | 2819 } |
OLD | NEW |