Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(179)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: discovery/googleapis/classroom__v1.json

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

Powered by Google App Engine
This is Rietveld 408576698