OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/classroom.rosters": { | 5 "https://www.googleapis.com/auth/classroom.profile.photos": { |
6 "description": "Manage your Google Classroom class rosters" | 6 "description": "View the profile photos of people in your cl
asses" |
7 }, | |
8 "https://www.googleapis.com/auth/classroom.student-submissions.s
tudents.readonly": { | |
9 "description": "View course work and grades for students in
the Google Classroom classes you teach or administer" | |
10 }, | |
11 "https://www.googleapis.com/auth/classroom.guardianlinks.student
s.readonly": { | |
12 "description": "View guardians for students in your Google C
lassroom classes" | |
13 }, | |
14 "https://www.googleapis.com/auth/classroom.courses": { | |
15 "description": "Manage your Google Classroom classes" | |
16 }, | |
17 "https://www.googleapis.com/auth/classroom.courses.readonly": { | |
18 "description": "View your Google Classroom classes" | |
19 }, | 7 }, |
20 "https://www.googleapis.com/auth/classroom.rosters.readonly": { | 8 "https://www.googleapis.com/auth/classroom.rosters.readonly": { |
21 "description": "View your Google Classroom class rosters" | 9 "description": "View your Google Classroom class rosters" |
22 }, | 10 }, |
23 "https://www.googleapis.com/auth/classroom.profile.photos": { | |
24 "description": "View the profile photos of people in your cl
asses" | |
25 }, | |
26 "https://www.googleapis.com/auth/classroom.guardianlinks.student
s": { | 11 "https://www.googleapis.com/auth/classroom.guardianlinks.student
s": { |
27 "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" |
28 }, | 13 }, |
29 "https://www.googleapis.com/auth/classroom.student-submissions.m
e.readonly": { | 14 "https://www.googleapis.com/auth/classroom.student-submissions.m
e.readonly": { |
30 "description": "View your course work and grades in Google C
lassroom" | 15 "description": "View your course work and grades in Google C
lassroom" |
31 }, | 16 }, |
32 "https://www.googleapis.com/auth/classroom.coursework.students":
{ | 17 "https://www.googleapis.com/auth/classroom.coursework.students":
{ |
33 "description": "Manage course work and grades for students i
n the Google Classroom classes you teach and view the course work and grades for
classes you administer" | 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" |
34 }, | 19 }, |
35 "https://www.googleapis.com/auth/classroom.coursework.students.r
eadonly": { | 20 "https://www.googleapis.com/auth/classroom.coursework.students.r
eadonly": { |
36 "description": "View course work and grades for students in
the Google Classroom classes you teach or administer" | 21 "description": "View course work and grades for students in
the Google Classroom classes you teach or administer" |
37 }, | 22 }, |
38 "https://www.googleapis.com/auth/classroom.guardianlinks.me.read
only": { | 23 "https://www.googleapis.com/auth/classroom.guardianlinks.me.read
only": { |
39 "description": "View your Google Classroom guardians" | 24 "description": "View your Google Classroom guardians" |
40 }, | 25 }, |
41 "https://www.googleapis.com/auth/classroom.coursework.me.readonl
y": { | 26 "https://www.googleapis.com/auth/classroom.coursework.me.readonl
y": { |
42 "description": "View your course work and grades in Google C
lassroom" | 27 "description": "View your course work and grades in Google C
lassroom" |
43 }, | 28 }, |
44 "https://www.googleapis.com/auth/classroom.profile.emails": { | 29 "https://www.googleapis.com/auth/classroom.profile.emails": { |
45 "description": "View the email addresses of people in your c
lasses" | 30 "description": "View the email addresses of people in your c
lasses" |
46 }, | 31 }, |
47 "https://www.googleapis.com/auth/classroom.coursework.me": { | 32 "https://www.googleapis.com/auth/classroom.coursework.me": { |
48 "description": "Manage your course work and view your grades
in Google Classroom" | 33 "description": "Manage your course work and view your grades
in Google Classroom" |
| 34 }, |
| 35 "https://www.googleapis.com/auth/classroom.rosters": { |
| 36 "description": "Manage your Google Classroom class rosters" |
| 37 }, |
| 38 "https://www.googleapis.com/auth/classroom.student-submissions.s
tudents.readonly": { |
| 39 "description": "View course work and grades for students in
the Google Classroom classes you teach or administer" |
| 40 }, |
| 41 "https://www.googleapis.com/auth/classroom.guardianlinks.student
s.readonly": { |
| 42 "description": "View guardians for students in your Google C
lassroom classes" |
| 43 }, |
| 44 "https://www.googleapis.com/auth/classroom.courses": { |
| 45 "description": "Manage your Google Classroom classes" |
| 46 }, |
| 47 "https://www.googleapis.com/auth/classroom.courses.readonly": { |
| 48 "description": "View your Google Classroom classes" |
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 "pp": { |
| 70 "default": "true", |
| 71 "description": "Pretty-print response.", |
| 72 "location": "query", |
| 73 "type": "boolean" |
| 74 }, |
| 75 "bearer_token": { |
| 76 "description": "OAuth bearer token.", |
| 77 "location": "query", |
| 78 "type": "string" |
| 79 }, |
| 80 "oauth_token": { |
| 81 "description": "OAuth 2.0 token for the current user.", |
| 82 "location": "query", |
| 83 "type": "string" |
| 84 }, |
69 "upload_protocol": { | 85 "upload_protocol": { |
70 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 86 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
71 "location": "query", | 87 "location": "query", |
72 "type": "string" | 88 "type": "string" |
73 }, | 89 }, |
74 "prettyPrint": { | 90 "prettyPrint": { |
75 "default": "true", | 91 "default": "true", |
76 "description": "Returns response with indentations and line breaks."
, | 92 "description": "Returns response with indentations and line breaks."
, |
77 "location": "query", | 93 "location": "query", |
78 "type": "boolean" | 94 "type": "boolean" |
79 }, | 95 }, |
80 "uploadType": { | 96 "uploadType": { |
81 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 97 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
82 "location": "query", | 98 "location": "query", |
83 "type": "string" | 99 "type": "string" |
84 }, | 100 }, |
85 "fields": { | 101 "fields": { |
86 "description": "Selector specifying which fields to include in a par
tial response.", | 102 "description": "Selector specifying which fields to include in a par
tial response.", |
87 "location": "query", | 103 "location": "query", |
88 "type": "string" | 104 "type": "string" |
89 }, | 105 }, |
90 "callback": { | |
91 "description": "JSONP", | |
92 "location": "query", | |
93 "type": "string" | |
94 }, | |
95 "$.xgafv": { | 106 "$.xgafv": { |
96 "description": "V1 error format.", | 107 "description": "V1 error format.", |
97 "enum": [ | 108 "enum": [ |
98 "1", | 109 "1", |
99 "2" | 110 "2" |
100 ], | 111 ], |
101 "enumDescriptions": [ | 112 "enumDescriptions": [ |
102 "v1 error format", | 113 "v1 error format", |
103 "v2 error format" | 114 "v2 error format" |
104 ], | 115 ], |
105 "location": "query", | 116 "location": "query", |
106 "type": "string" | 117 "type": "string" |
107 }, | 118 }, |
| 119 "callback": { |
| 120 "description": "JSONP", |
| 121 "location": "query", |
| 122 "type": "string" |
| 123 }, |
108 "alt": { | 124 "alt": { |
109 "default": "json", | 125 "default": "json", |
110 "description": "Data format for response.", | 126 "description": "Data format for response.", |
111 "enum": [ | 127 "enum": [ |
112 "json", | 128 "json", |
113 "media", | 129 "media", |
114 "proto" | 130 "proto" |
115 ], | 131 ], |
116 "enumDescriptions": [ | 132 "enumDescriptions": [ |
117 "Responses with Content-Type of application/json", | 133 "Responses with Content-Type of application/json", |
(...skipping 10 matching lines...) Expand all Loading... |
128 }, | 144 }, |
129 "key": { | 145 "key": { |
130 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | 146 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
131 "location": "query", | 147 "location": "query", |
132 "type": "string" | 148 "type": "string" |
133 }, | 149 }, |
134 "quotaUser": { | 150 "quotaUser": { |
135 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | 151 "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", | 152 "location": "query", |
137 "type": "string" | 153 "type": "string" |
138 }, | |
139 "pp": { | |
140 "default": "true", | |
141 "description": "Pretty-print response.", | |
142 "location": "query", | |
143 "type": "boolean" | |
144 }, | |
145 "oauth_token": { | |
146 "description": "OAuth 2.0 token for the current user.", | |
147 "location": "query", | |
148 "type": "string" | |
149 }, | |
150 "bearer_token": { | |
151 "description": "OAuth bearer token.", | |
152 "location": "query", | |
153 "type": "string" | |
154 } | 154 } |
155 }, | 155 }, |
156 "protocol": "rest", | 156 "protocol": "rest", |
157 "resources": { | 157 "resources": { |
158 "userProfiles": { | 158 "userProfiles": { |
159 "methods": { | 159 "methods": { |
160 "get": { | 160 "get": { |
161 "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.", | 161 "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.", |
162 "httpMethod": "GET", | 162 "httpMethod": "GET", |
163 "id": "classroom.userProfiles.get", | 163 "id": "classroom.userProfiles.get", |
(...skipping 14 matching lines...) Expand all Loading... |
178 }, | 178 }, |
179 "scopes": [ | 179 "scopes": [ |
180 "https://www.googleapis.com/auth/classroom.profile.email
s", | 180 "https://www.googleapis.com/auth/classroom.profile.email
s", |
181 "https://www.googleapis.com/auth/classroom.profile.photo
s", | 181 "https://www.googleapis.com/auth/classroom.profile.photo
s", |
182 "https://www.googleapis.com/auth/classroom.rosters", | 182 "https://www.googleapis.com/auth/classroom.rosters", |
183 "https://www.googleapis.com/auth/classroom.rosters.reado
nly" | 183 "https://www.googleapis.com/auth/classroom.rosters.reado
nly" |
184 ] | 184 ] |
185 } | 185 } |
186 }, | 186 }, |
187 "resources": { | 187 "resources": { |
188 "guardians": { | 188 "guardianInvitations": { |
189 "methods": { | 189 "methods": { |
190 "delete": { | 190 "create": { |
191 "description": "Deletes a guardian.\n\nThe guardian
will no longer receive guardian notifications and the guardian\nwill no longer b
e accessible via the API.\n\nThis method returns the following error codes:\n\n*
`PERMISSION_DENIED` if no user that matches the provided `student_id`\n is vis
ible to the requesting user, if the requesting user is not\n permitted to manag
e guardians for the student identified by the\n `student_id`, if guardians are
not enabled for the domain in question,\n or for other access errors.\n* `INVAL
ID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recogni
zed (it is not an email address, nor a `student_id` from the\n API).\n* `NOT_FO
UND` if the requesting user is permitted to modify guardians for\n the requeste
d `student_id`, but no `Guardian` record exists for that\n student with the pro
vided `guardian_id`.", | 191 "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.", |
192 "httpMethod": "DELETE", | 192 "httpMethod": "POST", |
193 "id": "classroom.userProfiles.guardians.delete", | 193 "id": "classroom.userProfiles.guardianInvitations.cr
eate", |
194 "parameterOrder": [ | 194 "parameterOrder": [ |
195 "studentId", | 195 "studentId" |
196 "guardianId" | |
197 ], | 196 ], |
198 "parameters": { | 197 "parameters": { |
199 "studentId": { | 198 "studentId": { |
200 "description": "The student whose guardian i
s to be deleted. One of the following:\n\n* the numeric identifier for the user\
n* the email address of the user\n* the string literal `\"me\"`, indicating the
requesting user", | 199 "description": "ID of the student (in standa
rd format)", |
201 "location": "path", | |
202 "required": true, | |
203 "type": "string" | |
204 }, | |
205 "guardianId": { | |
206 "description": "The `id` field from a `Guard
ian`.", | |
207 "location": "path", | 200 "location": "path", |
208 "required": true, | 201 "required": true, |
209 "type": "string" | 202 "type": "string" |
210 } | 203 } |
211 }, | 204 }, |
212 "path": "v1/userProfiles/{studentId}/guardians/{guar
dianId}", | 205 "path": "v1/userProfiles/{studentId}/guardianInvitat
ions", |
| 206 "request": { |
| 207 "$ref": "GuardianInvitation" |
| 208 }, |
213 "response": { | 209 "response": { |
214 "$ref": "Empty" | 210 "$ref": "GuardianInvitation" |
| 211 }, |
| 212 "scopes": [ |
| 213 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students" |
| 214 ] |
| 215 }, |
| 216 "patch": { |
| 217 "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.", |
| 218 "httpMethod": "PATCH", |
| 219 "id": "classroom.userProfiles.guardianInvitations.pa
tch", |
| 220 "parameterOrder": [ |
| 221 "studentId", |
| 222 "invitationId" |
| 223 ], |
| 224 "parameters": { |
| 225 "updateMask": { |
| 226 "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>,...`", |
| 227 "format": "google-fieldmask", |
| 228 "location": "query", |
| 229 "type": "string" |
| 230 }, |
| 231 "invitationId": { |
| 232 "description": "The `id` field of the `Guard
ianInvitation` to be modified.", |
| 233 "location": "path", |
| 234 "required": true, |
| 235 "type": "string" |
| 236 }, |
| 237 "studentId": { |
| 238 "description": "The ID of the student whose
guardian invitation is to be modified.", |
| 239 "location": "path", |
| 240 "required": true, |
| 241 "type": "string" |
| 242 } |
| 243 }, |
| 244 "path": "v1/userProfiles/{studentId}/guardianInvitat
ions/{invitationId}", |
| 245 "request": { |
| 246 "$ref": "GuardianInvitation" |
| 247 }, |
| 248 "response": { |
| 249 "$ref": "GuardianInvitation" |
215 }, | 250 }, |
216 "scopes": [ | 251 "scopes": [ |
217 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students" | 252 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students" |
218 ] | 253 ] |
219 }, | 254 }, |
220 "get": { | 255 "get": { |
221 "description": "Returns a specific guardian.\n\nThis
method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user t
hat matches the provided `student_id`\n is visible to the requesting user, if t
he requesting user is not\n permitted to view guardian information for the stud
ent identified by the\n `student_id`, if guardians are not enabled for the doma
in in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `stude
nt_id` is specified, but its format cannot\n be recognized (it is not an email
address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `N
OT_FOUND` if the requesting user is permitted to view guardians for\n the reque
sted `student_id`, but no `Guardian` record exists for that\n student that matc
hes the provided `guardian_id`.", | 256 "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.", |
222 "httpMethod": "GET", | 257 "httpMethod": "GET", |
223 "id": "classroom.userProfiles.guardians.get", | 258 "id": "classroom.userProfiles.guardianInvitations.ge
t", |
224 "parameterOrder": [ | 259 "parameterOrder": [ |
225 "studentId", | 260 "studentId", |
226 "guardianId" | 261 "invitationId" |
227 ], | 262 ], |
228 "parameters": { | 263 "parameters": { |
229 "studentId": { | 264 "invitationId": { |
230 "description": "The student whose guardian i
s being requested. One of the following:\n\n* the numeric identifier for the use
r\n* the email address of the user\n* the string literal `\"me\"`, indicating th
e requesting user", | 265 "description": "The `id` field of the `Guard
ianInvitation` being requested.", |
231 "location": "path", | 266 "location": "path", |
232 "required": true, | 267 "required": true, |
233 "type": "string" | 268 "type": "string" |
234 }, | 269 }, |
235 "guardianId": { | 270 "studentId": { |
236 "description": "The `id` field from a `Guard
ian`.", | 271 "description": "The ID of the student whose
guardian invitation is being requested.", |
237 "location": "path", | 272 "location": "path", |
238 "required": true, | 273 "required": true, |
239 "type": "string" | 274 "type": "string" |
240 } | 275 } |
241 }, | 276 }, |
242 "path": "v1/userProfiles/{studentId}/guardians/{guar
dianId}", | 277 "path": "v1/userProfiles/{studentId}/guardianInvitat
ions/{invitationId}", |
243 "response": { | 278 "response": { |
244 "$ref": "Guardian" | 279 "$ref": "GuardianInvitation" |
245 }, | 280 }, |
246 "scopes": [ | 281 "scopes": [ |
247 "https://www.googleapis.com/auth/classroom.guard
ianlinks.me.readonly", | |
248 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students", | 282 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students", |
249 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students.readonly" | 283 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students.readonly" |
250 ] | 284 ] |
251 }, | 285 }, |
252 "list": { | 286 "list": { |
253 "description": "Returns a list of guardians that the
requesting user is permitted to\nview, restricted to those that match the reque
st.\n\nTo list guardians for any student that the requesting user may view\nguar
dians for, use the literal character `-` for the student ID.\n\nThis method retu
rns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is spe
cified, and the requesting\n user is not permitted to view guardian information
for that student, if\n `\"-\"` is specified as the `student_id` and the user i
s not a domain\n administrator, if guardians are not enabled for the domain in
question,\n if the `invited_email_address` filter is set by a user who is not a
\n domain administrator, or for other access errors.\n* `INVALID_ARGUMENT` if a
`student_id` is specified, but its format cannot\n be recognized (it is not an
email address, nor a `student_id` from the\n API, nor the literal string `me`)
. May also be returned if an invalid\n `page_token` is provided.\n* `NOT_FOUND`
if a `student_id` is specified, and its format can be\n recognized, but Classr
oom has no record of that student.", | 287 "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.", |
254 "httpMethod": "GET", | 288 "httpMethod": "GET", |
255 "id": "classroom.userProfiles.guardians.list", | 289 "id": "classroom.userProfiles.guardianInvitations.li
st", |
256 "parameterOrder": [ | 290 "parameterOrder": [ |
257 "studentId" | 291 "studentId" |
258 ], | 292 ], |
259 "parameters": { | 293 "parameters": { |
260 "studentId": { | 294 "studentId": { |
261 "description": "Filter results by the studen
t who the guardian is linked to.\nThe identifier can be one of the following:\n\
n* the numeric identifier for the user\n* the email address of the user\n* the s
tring literal `\"me\"`, indicating the requesting user\n* the string literal `\"
-\"`, indicating that results should be returned for\n all students that the re
questing user has access to view.", | 295 "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.", |
262 "location": "path", | 296 "location": "path", |
263 "required": true, | 297 "required": true, |
264 "type": "string" | 298 "type": "string" |
265 }, | 299 }, |
266 "pageToken": { | 300 "pageToken": { |
267 "description": "nextPageToken\nvalue returne
d from a previous\nlist call,\nindicating that the subsequent page of results sh
ould be returned.\n\nThe list request\nmust be otherwise identical to the one th
at resulted in this token.", | 301 "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.", |
268 "location": "query", | 302 "location": "query", |
269 "type": "string" | 303 "type": "string" |
270 }, | 304 }, |
271 "pageSize": { | 305 "pageSize": { |
272 "description": "Maximum number of items to r
eturn. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nT
he server may return fewer than the specified number of results.", | 306 "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.", |
273 "format": "int32", | 307 "format": "int32", |
274 "location": "query", | 308 "location": "query", |
275 "type": "integer" | 309 "type": "integer" |
276 }, | 310 }, |
| 311 "states": { |
| 312 "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.", |
| 313 "enum": [ |
| 314 "GUARDIAN_INVITATION_STATE_UNSPECIFIED", |
| 315 "PENDING", |
| 316 "COMPLETE" |
| 317 ], |
| 318 "location": "query", |
| 319 "repeated": true, |
| 320 "type": "string" |
| 321 }, |
| 322 "invitedEmailAddress": { |
| 323 "description": "If specified, only results w
ith the specified `invited_email_address`\nwill be returned.", |
| 324 "location": "query", |
| 325 "type": "string" |
| 326 } |
| 327 }, |
| 328 "path": "v1/userProfiles/{studentId}/guardianInvitat
ions", |
| 329 "response": { |
| 330 "$ref": "ListGuardianInvitationsResponse" |
| 331 }, |
| 332 "scopes": [ |
| 333 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students", |
| 334 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students.readonly" |
| 335 ] |
| 336 } |
| 337 } |
| 338 }, |
| 339 "guardians": { |
| 340 "methods": { |
| 341 "delete": { |
| 342 "description": "Deletes a guardian.\n\nThe guardian
will no longer receive guardian notifications and the guardian\nwill no longer b
e accessible via the API.\n\nThis method returns the following error codes:\n\n*
`PERMISSION_DENIED` if no user that matches the provided `student_id`\n is vis
ible to the requesting user, if the requesting user is not\n permitted to manag
e guardians for the student identified by the\n `student_id`, if guardians are
not enabled for the domain in question,\n or for other access errors.\n* `INVAL
ID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recogni
zed (it is not an email address, nor a `student_id` from the\n API).\n* `NOT_FO
UND` if the requesting user is permitted to modify guardians for\n the requeste
d `student_id`, but no `Guardian` record exists for that\n student with the pro
vided `guardian_id`.", |
| 343 "httpMethod": "DELETE", |
| 344 "id": "classroom.userProfiles.guardians.delete", |
| 345 "parameterOrder": [ |
| 346 "studentId", |
| 347 "guardianId" |
| 348 ], |
| 349 "parameters": { |
| 350 "guardianId": { |
| 351 "description": "The `id` field from a `Guard
ian`.", |
| 352 "location": "path", |
| 353 "required": true, |
| 354 "type": "string" |
| 355 }, |
| 356 "studentId": { |
| 357 "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", |
| 358 "location": "path", |
| 359 "required": true, |
| 360 "type": "string" |
| 361 } |
| 362 }, |
| 363 "path": "v1/userProfiles/{studentId}/guardians/{guar
dianId}", |
| 364 "response": { |
| 365 "$ref": "Empty" |
| 366 }, |
| 367 "scopes": [ |
| 368 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students" |
| 369 ] |
| 370 }, |
| 371 "get": { |
| 372 "description": "Returns a specific guardian.\n\nThis
method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user t
hat matches the provided `student_id`\n is visible to the requesting user, if t
he requesting user is not\n permitted to view guardian information for the stud
ent identified by the\n `student_id`, if guardians are not enabled for the doma
in in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `stude
nt_id` is specified, but its format cannot\n be recognized (it is not an email
address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `N
OT_FOUND` if the requesting user is permitted to view guardians for\n the reque
sted `student_id`, but no `Guardian` record exists for that\n student that matc
hes the provided `guardian_id`.", |
| 373 "httpMethod": "GET", |
| 374 "id": "classroom.userProfiles.guardians.get", |
| 375 "parameterOrder": [ |
| 376 "studentId", |
| 377 "guardianId" |
| 378 ], |
| 379 "parameters": { |
| 380 "studentId": { |
| 381 "description": "The student whose guardian i
s being requested. One of the following:\n\n* the numeric identifier for the use
r\n* the email address of the user\n* the string literal `\"me\"`, indicating th
e requesting user", |
| 382 "location": "path", |
| 383 "required": true, |
| 384 "type": "string" |
| 385 }, |
| 386 "guardianId": { |
| 387 "description": "The `id` field from a `Guard
ian`.", |
| 388 "location": "path", |
| 389 "required": true, |
| 390 "type": "string" |
| 391 } |
| 392 }, |
| 393 "path": "v1/userProfiles/{studentId}/guardians/{guar
dianId}", |
| 394 "response": { |
| 395 "$ref": "Guardian" |
| 396 }, |
| 397 "scopes": [ |
| 398 "https://www.googleapis.com/auth/classroom.guard
ianlinks.me.readonly", |
| 399 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students", |
| 400 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students.readonly" |
| 401 ] |
| 402 }, |
| 403 "list": { |
| 404 "description": "Returns a list of guardians that the
requesting user is permitted to\nview, restricted to those that match the reque
st.\n\nTo list guardians for any student that the requesting user may view\nguar
dians for, use the literal character `-` for the student ID.\n\nThis method retu
rns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is spe
cified, and the requesting\n user is not permitted to view guardian information
for that student, if\n `\"-\"` is specified as the `student_id` and the user i
s not a domain\n administrator, if guardians are not enabled for the domain in
question,\n if the `invited_email_address` filter is set by a user who is not a
\n domain administrator, or for other access errors.\n* `INVALID_ARGUMENT` if a
`student_id` is specified, but its format cannot\n be recognized (it is not an
email address, nor a `student_id` from the\n API, nor the literal string `me`)
. May also be returned if an invalid\n `page_token` is provided.\n* `NOT_FOUND`
if a `student_id` is specified, and its format can be\n recognized, but Classr
oom has no record of that student.", |
| 405 "httpMethod": "GET", |
| 406 "id": "classroom.userProfiles.guardians.list", |
| 407 "parameterOrder": [ |
| 408 "studentId" |
| 409 ], |
| 410 "parameters": { |
| 411 "studentId": { |
| 412 "description": "Filter results by the studen
t who the guardian is linked to.\nThe identifier can be one of the following:\n\
n* the numeric identifier for the user\n* the email address of the user\n* the s
tring literal `\"me\"`, indicating the requesting user\n* the string literal `\"
-\"`, indicating that results should be returned for\n all students that the re
questing user has access to view.", |
| 413 "location": "path", |
| 414 "required": true, |
| 415 "type": "string" |
| 416 }, |
| 417 "pageToken": { |
| 418 "description": "nextPageToken\nvalue returne
d from a previous\nlist call,\nindicating that the subsequent page of results sh
ould be returned.\n\nThe list request\nmust be otherwise identical to the one th
at resulted in this token.", |
| 419 "location": "query", |
| 420 "type": "string" |
| 421 }, |
| 422 "pageSize": { |
| 423 "description": "Maximum number of items to r
eturn. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nT
he server may return fewer than the specified number of results.", |
| 424 "format": "int32", |
| 425 "location": "query", |
| 426 "type": "integer" |
| 427 }, |
277 "invitedEmailAddress": { | 428 "invitedEmailAddress": { |
278 "description": "Filter results by the email
address that the original invitation was sent\nto, resulting in this guardian li
nk.\nThis filter can only be used by domain administrators.", | 429 "description": "Filter results by the email
address that the original invitation was sent\nto, resulting in this guardian li
nk.\nThis filter can only be used by domain administrators.", |
279 "location": "query", | 430 "location": "query", |
280 "type": "string" | 431 "type": "string" |
281 } | 432 } |
282 }, | 433 }, |
283 "path": "v1/userProfiles/{studentId}/guardians", | 434 "path": "v1/userProfiles/{studentId}/guardians", |
284 "response": { | 435 "response": { |
285 "$ref": "ListGuardiansResponse" | 436 "$ref": "ListGuardiansResponse" |
286 }, | 437 }, |
287 "scopes": [ | 438 "scopes": [ |
288 "https://www.googleapis.com/auth/classroom.guard
ianlinks.me.readonly", | 439 "https://www.googleapis.com/auth/classroom.guard
ianlinks.me.readonly", |
289 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students", | 440 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students", |
290 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students.readonly" | 441 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students.readonly" |
291 ] | 442 ] |
292 } | 443 } |
293 } | 444 } |
294 }, | |
295 "guardianInvitations": { | |
296 "methods": { | |
297 "patch": { | |
298 "description": "Modifies a guardian invitation.\n\nC
urrently, the only valid modification is to change the `state` from\n`PENDING` t
o `COMPLETE`. This has the effect of withdrawing the invitation.\n\nThis method
returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user
does not have permission to\n manage guardians, if guardians are not enabled fo
r the domain in question\n or for other access errors.\n* `FAILED_PRECONDITION`
if the guardian link is not in the `PENDING` state.\n* `INVALID_ARGUMENT` if th
e format of the student ID provided\n cannot be recognized (it is not an email
address, nor a `user_id` from\n this API), or if the passed `GuardianInvitation
` has a `state` other than\n `COMPLETE`, or if it modifies fields other than `s
tate`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n C
lassroom has no record of that student, or if the `id` field does not\n refer t
o a guardian invitation known to Classroom.", | |
299 "httpMethod": "PATCH", | |
300 "id": "classroom.userProfiles.guardianInvitations.pa
tch", | |
301 "parameterOrder": [ | |
302 "studentId", | |
303 "invitationId" | |
304 ], | |
305 "parameters": { | |
306 "studentId": { | |
307 "description": "The ID of the student whose
guardian invitation is to be modified.", | |
308 "location": "path", | |
309 "required": true, | |
310 "type": "string" | |
311 }, | |
312 "updateMask": { | |
313 "description": "Mask that identifies which f
ields on the course to update.\nThis field is required to do an update. The upda
te will fail if invalid\nfields are specified. The following fields are valid:\n
\n* `state`\n\nWhen set in a query parameter, this field should be specified as\
n\n`updateMask=<field1>,<field2>,...`", | |
314 "format": "google-fieldmask", | |
315 "location": "query", | |
316 "type": "string" | |
317 }, | |
318 "invitationId": { | |
319 "description": "The `id` field of the `Guard
ianInvitation` to be modified.", | |
320 "location": "path", | |
321 "required": true, | |
322 "type": "string" | |
323 } | |
324 }, | |
325 "path": "v1/userProfiles/{studentId}/guardianInvitat
ions/{invitationId}", | |
326 "request": { | |
327 "$ref": "GuardianInvitation" | |
328 }, | |
329 "response": { | |
330 "$ref": "GuardianInvitation" | |
331 }, | |
332 "scopes": [ | |
333 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students" | |
334 ] | |
335 }, | |
336 "get": { | |
337 "description": "Returns a specific guardian invitati
on.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` i
f the requesting user is not permitted to view\n guardian invitations for the s
tudent identified by the `student_id`, if\n guardians are not enabled for the d
omain in question, or for other\n access errors.\n* `INVALID_ARGUMENT` if a `st
udent_id` is specified, but its format cannot\n be recognized (it is not an ema
il address, nor a `student_id` from the\n API, nor the literal string `me`).\n*
`NOT_FOUND` if Classroom cannot find any record of the given student or\n `inv
itation_id`. May also be returned if the student exists, but the\n requesting u
ser does not have access to see that student.", | |
338 "httpMethod": "GET", | |
339 "id": "classroom.userProfiles.guardianInvitations.ge
t", | |
340 "parameterOrder": [ | |
341 "studentId", | |
342 "invitationId" | |
343 ], | |
344 "parameters": { | |
345 "invitationId": { | |
346 "description": "The `id` field of the `Guard
ianInvitation` being requested.", | |
347 "location": "path", | |
348 "required": true, | |
349 "type": "string" | |
350 }, | |
351 "studentId": { | |
352 "description": "The ID of the student whose
guardian invitation is being requested.", | |
353 "location": "path", | |
354 "required": true, | |
355 "type": "string" | |
356 } | |
357 }, | |
358 "path": "v1/userProfiles/{studentId}/guardianInvitat
ions/{invitationId}", | |
359 "response": { | |
360 "$ref": "GuardianInvitation" | |
361 }, | |
362 "scopes": [ | |
363 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students", | |
364 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students.readonly" | |
365 ] | |
366 }, | |
367 "list": { | |
368 "description": "Returns a list of guardian invitatio
ns that the requesting user is\npermitted to view, filtered by the parameters pr
ovided.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIE
D` if a `student_id` is specified, and the requesting\n user is not permitted t
o view guardian invitations for that student, if\n `\"-\"` is specified as the
`student_id` and the user is not a domain\n administrator, if guardians are not
enabled for the domain in question,\n or for other access errors.\n* `INVALID_
ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized
(it is not an email address, nor a `student_id` from the\n API, nor the litera
l string `me`). May also be returned if an invalid\n `page_token` or `state` is
provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\
n recognized, but Classroom has no record of that student.", | |
369 "httpMethod": "GET", | |
370 "id": "classroom.userProfiles.guardianInvitations.li
st", | |
371 "parameterOrder": [ | |
372 "studentId" | |
373 ], | |
374 "parameters": { | |
375 "pageSize": { | |
376 "description": "Maximum number of items to r
eturn. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nT
he server may return fewer than the specified number of results.", | |
377 "format": "int32", | |
378 "location": "query", | |
379 "type": "integer" | |
380 }, | |
381 "states": { | |
382 "description": "If specified, only results w
ith the specified `state` values will be\nreturned. Otherwise, results with a `s
tate` of `PENDING` will be returned.", | |
383 "enum": [ | |
384 "GUARDIAN_INVITATION_STATE_UNSPECIFIED", | |
385 "PENDING", | |
386 "COMPLETE" | |
387 ], | |
388 "location": "query", | |
389 "repeated": true, | |
390 "type": "string" | |
391 }, | |
392 "invitedEmailAddress": { | |
393 "description": "If specified, only results w
ith the specified `invited_email_address`\nwill be returned.", | |
394 "location": "query", | |
395 "type": "string" | |
396 }, | |
397 "studentId": { | |
398 "description": "The ID of the student whose
guardian invitations are to be returned.\nThe identifier can be one of the follo
wing:\n\n* the numeric identifier for the user\n* the email address of the user\
n* the string literal `\"me\"`, indicating the requesting user\n* the string lit
eral `\"-\"`, indicating that results should be returned for\n all students tha
t the requesting user is permitted to view guardian\n invitations.", | |
399 "location": "path", | |
400 "required": true, | |
401 "type": "string" | |
402 }, | |
403 "pageToken": { | |
404 "description": "nextPageToken\nvalue returne
d from a previous\nlist call,\nindicating that the subsequent page of results sh
ould be returned.\n\nThe list request\nmust be otherwise identical to the one th
at resulted in this token.", | |
405 "location": "query", | |
406 "type": "string" | |
407 } | |
408 }, | |
409 "path": "v1/userProfiles/{studentId}/guardianInvitat
ions", | |
410 "response": { | |
411 "$ref": "ListGuardianInvitationsResponse" | |
412 }, | |
413 "scopes": [ | |
414 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students", | |
415 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students.readonly" | |
416 ] | |
417 }, | |
418 "create": { | |
419 "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.", | |
420 "httpMethod": "POST", | |
421 "id": "classroom.userProfiles.guardianInvitations.cr
eate", | |
422 "parameterOrder": [ | |
423 "studentId" | |
424 ], | |
425 "parameters": { | |
426 "studentId": { | |
427 "description": "ID of the student (in standa
rd format)", | |
428 "location": "path", | |
429 "required": true, | |
430 "type": "string" | |
431 } | |
432 }, | |
433 "path": "v1/userProfiles/{studentId}/guardianInvitat
ions", | |
434 "request": { | |
435 "$ref": "GuardianInvitation" | |
436 }, | |
437 "response": { | |
438 "$ref": "GuardianInvitation" | |
439 }, | |
440 "scopes": [ | |
441 "https://www.googleapis.com/auth/classroom.guard
ianlinks.students" | |
442 ] | |
443 } | |
444 } | |
445 } | 445 } |
446 } | 446 } |
447 }, | 447 }, |
448 "courses": { | 448 "courses": { |
449 "methods": { | 449 "methods": { |
450 "delete": { | |
451 "description": "Deletes a course.\n\nThis method returns the
following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not p
ermitted to delete the\nrequested course or for access errors.\n* `NOT_FOUND` if
no course exists with the requested ID.", | |
452 "httpMethod": "DELETE", | |
453 "id": "classroom.courses.delete", | |
454 "parameterOrder": [ | |
455 "id" | |
456 ], | |
457 "parameters": { | |
458 "id": { | |
459 "description": "Identifier of the course to delete.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", | |
460 "location": "path", | |
461 "required": true, | |
462 "type": "string" | |
463 } | |
464 }, | |
465 "path": "v1/courses/{id}", | |
466 "response": { | |
467 "$ref": "Empty" | |
468 }, | |
469 "scopes": [ | |
470 "https://www.googleapis.com/auth/classroom.courses" | |
471 ] | |
472 }, | |
473 "list": { | 450 "list": { |
474 "description": "Returns a list of courses that the requestin
g user is permitted to view,\nrestricted to those that match the request. Return
ed courses are ordered by\ncreation time, with the most recently created coming
first.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED
` for access errors.\n* `INVALID_ARGUMENT` if the query argument is malformed.\n
* `NOT_FOUND` if any users specified in the query arguments do not exist.", | 451 "description": "Returns a list of courses that the requestin
g user is permitted to view,\nrestricted to those that match the request. Return
ed courses are ordered by\ncreation time, with the most recently created coming
first.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED
` for access errors.\n* `INVALID_ARGUMENT` if the query argument is malformed.\n
* `NOT_FOUND` if any users specified in the query arguments do not exist.", |
475 "httpMethod": "GET", | 452 "httpMethod": "GET", |
476 "id": "classroom.courses.list", | 453 "id": "classroom.courses.list", |
477 "parameterOrder": [], | 454 "parameterOrder": [], |
478 "parameters": { | 455 "parameters": { |
| 456 "studentId": { |
| 457 "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", |
| 458 "location": "query", |
| 459 "type": "string" |
| 460 }, |
| 461 "pageToken": { |
| 462 "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.", |
| 463 "location": "query", |
| 464 "type": "string" |
| 465 }, |
| 466 "pageSize": { |
| 467 "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.", |
| 468 "format": "int32", |
| 469 "location": "query", |
| 470 "type": "integer" |
| 471 }, |
479 "courseStates": { | 472 "courseStates": { |
480 "description": "Restricts returned courses to those
in one of the specified states\nThe default value is ACTIVE, ARCHIVED, PROVISION
ED, DECLINED.", | 473 "description": "Restricts returned courses to those
in one of the specified states\nThe default value is ACTIVE, ARCHIVED, PROVISION
ED, DECLINED.", |
481 "enum": [ | 474 "enum": [ |
482 "COURSE_STATE_UNSPECIFIED", | 475 "COURSE_STATE_UNSPECIFIED", |
483 "ACTIVE", | 476 "ACTIVE", |
484 "ARCHIVED", | 477 "ARCHIVED", |
485 "PROVISIONED", | 478 "PROVISIONED", |
486 "DECLINED", | 479 "DECLINED", |
487 "SUSPENDED" | 480 "SUSPENDED" |
488 ], | 481 ], |
489 "location": "query", | 482 "location": "query", |
490 "repeated": true, | 483 "repeated": true, |
491 "type": "string" | 484 "type": "string" |
492 }, | 485 }, |
493 "teacherId": { | 486 "teacherId": { |
494 "description": "Restricts returned courses to those
having a teacher with the specified\nidentifier. The identifier can be one of th
e following:\n\n* the numeric identifier for the user\n* the email address of th
e user\n* the string literal `\"me\"`, indicating the requesting user", | 487 "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", |
495 "location": "query", | 488 "location": "query", |
496 "type": "string" | 489 "type": "string" |
497 }, | |
498 "studentId": { | |
499 "description": "Restricts returned courses to those
having a student with the specified\nidentifier. The identifier can be one of th
e following:\n\n* the numeric identifier for the user\n* the email address of th
e user\n* the string literal `\"me\"`, indicating the requesting user", | |
500 "location": "query", | |
501 "type": "string" | |
502 }, | |
503 "pageToken": { | |
504 "description": "nextPageToken\nvalue returned from a
previous\nlist call,\nindicating that the subsequent page of results should be
returned.\n\nThe list request must be\notherwise identical to the one that resul
ted in this token.", | |
505 "location": "query", | |
506 "type": "string" | |
507 }, | |
508 "pageSize": { | |
509 "description": "Maximum number of items to return. Z
ero or unspecified indicates that the\nserver may assign a maximum.\n\nThe serve
r may return fewer than the specified number of results.", | |
510 "format": "int32", | |
511 "location": "query", | |
512 "type": "integer" | |
513 } | 490 } |
514 }, | 491 }, |
515 "path": "v1/courses", | 492 "path": "v1/courses", |
516 "response": { | 493 "response": { |
517 "$ref": "ListCoursesResponse" | 494 "$ref": "ListCoursesResponse" |
518 }, | 495 }, |
519 "scopes": [ | 496 "scopes": [ |
520 "https://www.googleapis.com/auth/classroom.courses", | 497 "https://www.googleapis.com/auth/classroom.courses", |
521 "https://www.googleapis.com/auth/classroom.courses.reado
nly" | 498 "https://www.googleapis.com/auth/classroom.courses.reado
nly" |
522 ] | 499 ] |
523 }, | 500 }, |
524 "create": { | 501 "create": { |
525 "description": "Creates a course.\n\nThe user specified in `
ownerId` is the owner of the created course\nand added as a teacher.\n\nThis met
hod returns the following error codes:\n\n* `PERMISSION_DENIED` if the requestin
g user is not permitted to create\ncourses or for access errors.\n* `NOT_FOUND`
if the primary teacher is not a valid user.\n* `FAILED_PRECONDITION` if the cour
se owner's account is disabled or for\nthe following request errors:\n * User
GroupsMembershipLimitReached\n* `ALREADY_EXISTS` if an alias was specified in th
e `id` and\nalready exists.", | 502 "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.", |
526 "httpMethod": "POST", | 503 "httpMethod": "POST", |
527 "id": "classroom.courses.create", | 504 "id": "classroom.courses.create", |
528 "parameterOrder": [], | 505 "parameterOrder": [], |
529 "parameters": {}, | 506 "parameters": {}, |
530 "path": "v1/courses", | 507 "path": "v1/courses", |
531 "request": { | 508 "request": { |
532 "$ref": "Course" | 509 "$ref": "Course" |
533 }, | 510 }, |
534 "response": { | 511 "response": { |
535 "$ref": "Course" | 512 "$ref": "Course" |
536 }, | 513 }, |
537 "scopes": [ | 514 "scopes": [ |
538 "https://www.googleapis.com/auth/classroom.courses" | 515 "https://www.googleapis.com/auth/classroom.courses" |
539 ] | 516 ] |
540 }, | 517 }, |
| 518 "get": { |
| 519 "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.", |
| 520 "httpMethod": "GET", |
| 521 "id": "classroom.courses.get", |
| 522 "parameterOrder": [ |
| 523 "id" |
| 524 ], |
| 525 "parameters": { |
| 526 "id": { |
| 527 "description": "Identifier of the course to return.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", |
| 528 "location": "path", |
| 529 "required": true, |
| 530 "type": "string" |
| 531 } |
| 532 }, |
| 533 "path": "v1/courses/{id}", |
| 534 "response": { |
| 535 "$ref": "Course" |
| 536 }, |
| 537 "scopes": [ |
| 538 "https://www.googleapis.com/auth/classroom.courses", |
| 539 "https://www.googleapis.com/auth/classroom.courses.reado
nly" |
| 540 ] |
| 541 }, |
541 "patch": { | 542 "patch": { |
542 "description": "Updates one or more fields in a course.\n\nT
his method returns the following error codes:\n\n* `PERMISSION_DENIED` if the re
questing user is not permitted to modify the\nrequested course or for access err
ors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `INVALID_ARGUM
ENT` if invalid fields are specified in the update mask or\nif no update mask is
supplied.\n* `FAILED_PRECONDITION` for the following request errors:\n * Cou
rseNotModifiable", | 543 "description": "Updates one or more fields in a course.\n\nT
his method returns the following error codes:\n\n* `PERMISSION_DENIED` if the re
questing user is not permitted to modify the\nrequested course or for access err
ors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `INVALID_ARGUM
ENT` if invalid fields are specified in the update mask or\nif no update mask is
supplied.\n* `FAILED_PRECONDITION` for the following request errors:\n * Cou
rseNotModifiable", |
543 "httpMethod": "PATCH", | 544 "httpMethod": "PATCH", |
544 "id": "classroom.courses.patch", | 545 "id": "classroom.courses.patch", |
545 "parameterOrder": [ | 546 "parameterOrder": [ |
546 "id" | 547 "id" |
547 ], | 548 ], |
548 "parameters": { | 549 "parameters": { |
549 "id": { | 550 "id": { |
550 "description": "Identifier of the course to update.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", | 551 "description": "Identifier of the course to update.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", |
(...skipping 12 matching lines...) Expand all Loading... |
563 "request": { | 564 "request": { |
564 "$ref": "Course" | 565 "$ref": "Course" |
565 }, | 566 }, |
566 "response": { | 567 "response": { |
567 "$ref": "Course" | 568 "$ref": "Course" |
568 }, | 569 }, |
569 "scopes": [ | 570 "scopes": [ |
570 "https://www.googleapis.com/auth/classroom.courses" | 571 "https://www.googleapis.com/auth/classroom.courses" |
571 ] | 572 ] |
572 }, | 573 }, |
573 "get": { | |
574 "description": "Returns a course.\n\nThis method returns the
following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not p
ermitted to access the\nrequested course or for access errors.\n* `NOT_FOUND` if
no course exists with the requested ID.", | |
575 "httpMethod": "GET", | |
576 "id": "classroom.courses.get", | |
577 "parameterOrder": [ | |
578 "id" | |
579 ], | |
580 "parameters": { | |
581 "id": { | |
582 "description": "Identifier of the course to return.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", | |
583 "location": "path", | |
584 "required": true, | |
585 "type": "string" | |
586 } | |
587 }, | |
588 "path": "v1/courses/{id}", | |
589 "response": { | |
590 "$ref": "Course" | |
591 }, | |
592 "scopes": [ | |
593 "https://www.googleapis.com/auth/classroom.courses", | |
594 "https://www.googleapis.com/auth/classroom.courses.reado
nly" | |
595 ] | |
596 }, | |
597 "update": { | 574 "update": { |
598 "description": "Updates a course.\n\nThis method returns the
following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not p
ermitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if
no course exists with the requested ID.\n* `FAILED_PRECONDITION` for the follow
ing request errors:\n * CourseNotModifiable", | 575 "description": "Updates a course.\n\nThis method returns the
following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not p
ermitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if
no course exists with the requested ID.\n* `FAILED_PRECONDITION` for the follow
ing request errors:\n * CourseNotModifiable", |
599 "httpMethod": "PUT", | 576 "httpMethod": "PUT", |
600 "id": "classroom.courses.update", | 577 "id": "classroom.courses.update", |
601 "parameterOrder": [ | 578 "parameterOrder": [ |
602 "id" | 579 "id" |
603 ], | 580 ], |
604 "parameters": { | 581 "parameters": { |
605 "id": { | 582 "id": { |
606 "description": "Identifier of the course to update.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", | 583 "description": "Identifier of the course to update.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", |
607 "location": "path", | 584 "location": "path", |
608 "required": true, | 585 "required": true, |
609 "type": "string" | 586 "type": "string" |
610 } | 587 } |
611 }, | 588 }, |
612 "path": "v1/courses/{id}", | 589 "path": "v1/courses/{id}", |
613 "request": { | 590 "request": { |
614 "$ref": "Course" | 591 "$ref": "Course" |
615 }, | 592 }, |
616 "response": { | 593 "response": { |
617 "$ref": "Course" | 594 "$ref": "Course" |
618 }, | 595 }, |
619 "scopes": [ | 596 "scopes": [ |
620 "https://www.googleapis.com/auth/classroom.courses" | 597 "https://www.googleapis.com/auth/classroom.courses" |
| 598 ] |
| 599 }, |
| 600 "delete": { |
| 601 "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.", |
| 602 "httpMethod": "DELETE", |
| 603 "id": "classroom.courses.delete", |
| 604 "parameterOrder": [ |
| 605 "id" |
| 606 ], |
| 607 "parameters": { |
| 608 "id": { |
| 609 "description": "Identifier of the course to delete.\
nThis identifier can be either the Classroom-assigned identifier or an\nalias.", |
| 610 "location": "path", |
| 611 "required": true, |
| 612 "type": "string" |
| 613 } |
| 614 }, |
| 615 "path": "v1/courses/{id}", |
| 616 "response": { |
| 617 "$ref": "Empty" |
| 618 }, |
| 619 "scopes": [ |
| 620 "https://www.googleapis.com/auth/classroom.courses" |
621 ] | 621 ] |
622 } | 622 } |
623 }, | 623 }, |
624 "resources": { | 624 "resources": { |
625 "aliases": { | 625 "aliases": { |
626 "methods": { | 626 "methods": { |
627 "delete": { | |
628 "description": "Deletes an alias of a course.\n\nThi
s method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requ
esting user is not permitted to remove the\nalias or for access errors.\n* `NOT_
FOUND` if the alias does not exist.\n* `FAILED_PRECONDITION` if the alias reques
ted does not make sense for the\n requesting user or course (for example, if a
user not in a domain\n attempts to delete a domain-scoped alias).", | |
629 "httpMethod": "DELETE", | |
630 "id": "classroom.courses.aliases.delete", | |
631 "parameterOrder": [ | |
632 "courseId", | |
633 "alias" | |
634 ], | |
635 "parameters": { | |
636 "alias": { | |
637 "description": "Alias to delete.\nThis may n
ot be the Classroom-assigned identifier.", | |
638 "location": "path", | |
639 "required": true, | |
640 "type": "string" | |
641 }, | |
642 "courseId": { | |
643 "description": "Identifier of the course who
se alias should be deleted.\nThis identifier can be either the Classroom-assigne
d identifier or an\nalias.", | |
644 "location": "path", | |
645 "required": true, | |
646 "type": "string" | |
647 } | |
648 }, | |
649 "path": "v1/courses/{courseId}/aliases/{alias}", | |
650 "response": { | |
651 "$ref": "Empty" | |
652 }, | |
653 "scopes": [ | |
654 "https://www.googleapis.com/auth/classroom.cours
es" | |
655 ] | |
656 }, | |
657 "list": { | 627 "list": { |
658 "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.", | 628 "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.", |
659 "httpMethod": "GET", | 629 "httpMethod": "GET", |
660 "id": "classroom.courses.aliases.list", | 630 "id": "classroom.courses.aliases.list", |
661 "parameterOrder": [ | 631 "parameterOrder": [ |
662 "courseId" | 632 "courseId" |
663 ], | 633 ], |
664 "parameters": { | 634 "parameters": { |
| 635 "courseId": { |
| 636 "description": "The identifier of the course
.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.
", |
| 637 "location": "path", |
| 638 "required": true, |
| 639 "type": "string" |
| 640 }, |
665 "pageToken": { | 641 "pageToken": { |
666 "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.", | 642 "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.", |
667 "location": "query", | 643 "location": "query", |
668 "type": "string" | 644 "type": "string" |
669 }, | 645 }, |
670 "pageSize": { | 646 "pageSize": { |
671 "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.", | 647 "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.", |
672 "format": "int32", | 648 "format": "int32", |
673 "location": "query", | 649 "location": "query", |
674 "type": "integer" | 650 "type": "integer" |
675 }, | |
676 "courseId": { | |
677 "description": "The identifier of the course
.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.
", | |
678 "location": "path", | |
679 "required": true, | |
680 "type": "string" | |
681 } | 651 } |
682 }, | 652 }, |
683 "path": "v1/courses/{courseId}/aliases", | 653 "path": "v1/courses/{courseId}/aliases", |
684 "response": { | 654 "response": { |
685 "$ref": "ListCourseAliasesResponse" | 655 "$ref": "ListCourseAliasesResponse" |
686 }, | 656 }, |
687 "scopes": [ | 657 "scopes": [ |
688 "https://www.googleapis.com/auth/classroom.cours
es", | 658 "https://www.googleapis.com/auth/classroom.cours
es", |
689 "https://www.googleapis.com/auth/classroom.cours
es.readonly" | 659 "https://www.googleapis.com/auth/classroom.cours
es.readonly" |
690 ] | 660 ] |
(...skipping 16 matching lines...) Expand all Loading... |
707 "path": "v1/courses/{courseId}/aliases", | 677 "path": "v1/courses/{courseId}/aliases", |
708 "request": { | 678 "request": { |
709 "$ref": "CourseAlias" | 679 "$ref": "CourseAlias" |
710 }, | 680 }, |
711 "response": { | 681 "response": { |
712 "$ref": "CourseAlias" | 682 "$ref": "CourseAlias" |
713 }, | 683 }, |
714 "scopes": [ | 684 "scopes": [ |
715 "https://www.googleapis.com/auth/classroom.cours
es" | 685 "https://www.googleapis.com/auth/classroom.cours
es" |
716 ] | 686 ] |
| 687 }, |
| 688 "delete": { |
| 689 "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).", |
| 690 "httpMethod": "DELETE", |
| 691 "id": "classroom.courses.aliases.delete", |
| 692 "parameterOrder": [ |
| 693 "courseId", |
| 694 "alias" |
| 695 ], |
| 696 "parameters": { |
| 697 "alias": { |
| 698 "description": "Alias to delete.\nThis may n
ot be the Classroom-assigned identifier.", |
| 699 "location": "path", |
| 700 "required": true, |
| 701 "type": "string" |
| 702 }, |
| 703 "courseId": { |
| 704 "description": "Identifier of the course who
se alias should be deleted.\nThis identifier can be either the Classroom-assigne
d identifier or an\nalias.", |
| 705 "location": "path", |
| 706 "required": true, |
| 707 "type": "string" |
| 708 } |
| 709 }, |
| 710 "path": "v1/courses/{courseId}/aliases/{alias}", |
| 711 "response": { |
| 712 "$ref": "Empty" |
| 713 }, |
| 714 "scopes": [ |
| 715 "https://www.googleapis.com/auth/classroom.cours
es" |
| 716 ] |
717 } | 717 } |
718 } | 718 } |
719 }, | 719 }, |
720 "students": { | 720 "students": { |
721 "methods": { | 721 "methods": { |
722 "delete": { | |
723 "description": "Deletes a student of a course.\n\nTh
is method returns the following error codes:\n\n* `PERMISSION_DENIED` if the req
uesting user is not permitted to delete\nstudents of this course or for access e
rrors.\n* `NOT_FOUND` if no student of this course has the requested ID or if th
e\ncourse does not exist.", | |
724 "httpMethod": "DELETE", | |
725 "id": "classroom.courses.students.delete", | |
726 "parameterOrder": [ | |
727 "courseId", | |
728 "userId" | |
729 ], | |
730 "parameters": { | |
731 "courseId": { | |
732 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | |
733 "location": "path", | |
734 "required": true, | |
735 "type": "string" | |
736 }, | |
737 "userId": { | |
738 "description": "Identifier of the student to
delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifie
r for the user\n* the email address of the user\n* the string literal `\"me\"`,
indicating the requesting user", | |
739 "location": "path", | |
740 "required": true, | |
741 "type": "string" | |
742 } | |
743 }, | |
744 "path": "v1/courses/{courseId}/students/{userId}", | |
745 "response": { | |
746 "$ref": "Empty" | |
747 }, | |
748 "scopes": [ | |
749 "https://www.googleapis.com/auth/classroom.roste
rs" | |
750 ] | |
751 }, | |
752 "list": { | 722 "list": { |
753 "description": "Returns a list of students of this c
ourse that the requester\nis permitted to view.\n\nThis method returns the follo
wing error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_
DENIED` for access errors.", | 723 "description": "Returns a list of students of this c
ourse that the requester\nis permitted to view.\n\nThis method returns the follo
wing error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_
DENIED` for access errors.", |
754 "httpMethod": "GET", | 724 "httpMethod": "GET", |
755 "id": "classroom.courses.students.list", | 725 "id": "classroom.courses.students.list", |
756 "parameterOrder": [ | 726 "parameterOrder": [ |
757 "courseId" | 727 "courseId" |
758 ], | 728 ], |
759 "parameters": { | 729 "parameters": { |
| 730 "courseId": { |
| 731 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
| 732 "location": "path", |
| 733 "required": true, |
| 734 "type": "string" |
| 735 }, |
760 "pageToken": { | 736 "pageToken": { |
761 "description": "nextPageToken\nvalue returne
d from a previous\nlist call, indicating that\nthe subsequent page of results sh
ould be returned.\n\nThe list request must be\notherwise identical to the one th
at resulted in this token.", | 737 "description": "nextPageToken\nvalue returne
d from a previous\nlist call, indicating that\nthe subsequent page of results sh
ould be returned.\n\nThe list request must be\notherwise identical to the one th
at resulted in this token.", |
762 "location": "query", | 738 "location": "query", |
763 "type": "string" | 739 "type": "string" |
764 }, | 740 }, |
765 "pageSize": { | 741 "pageSize": { |
766 "description": "Maximum number of items to r
eturn. Zero means no maximum.\n\nThe server may return fewer than the specified
number of results.", | 742 "description": "Maximum number of items to r
eturn. Zero means no maximum.\n\nThe server may return fewer than the specified
number of results.", |
767 "format": "int32", | 743 "format": "int32", |
768 "location": "query", | 744 "location": "query", |
769 "type": "integer" | 745 "type": "integer" |
770 }, | |
771 "courseId": { | |
772 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | |
773 "location": "path", | |
774 "required": true, | |
775 "type": "string" | |
776 } | 746 } |
777 }, | 747 }, |
778 "path": "v1/courses/{courseId}/students", | 748 "path": "v1/courses/{courseId}/students", |
779 "response": { | 749 "response": { |
780 "$ref": "ListStudentsResponse" | 750 "$ref": "ListStudentsResponse" |
781 }, | 751 }, |
782 "scopes": [ | 752 "scopes": [ |
783 "https://www.googleapis.com/auth/classroom.profi
le.emails", | 753 "https://www.googleapis.com/auth/classroom.profi
le.emails", |
784 "https://www.googleapis.com/auth/classroom.profi
le.photos", | 754 "https://www.googleapis.com/auth/classroom.profi
le.photos", |
785 "https://www.googleapis.com/auth/classroom.roste
rs", | 755 "https://www.googleapis.com/auth/classroom.roste
rs", |
(...skipping 34 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
820 ] | 790 ] |
821 }, | 791 }, |
822 "create": { | 792 "create": { |
823 "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.", | 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.", |
824 "httpMethod": "POST", | 794 "httpMethod": "POST", |
825 "id": "classroom.courses.students.create", | 795 "id": "classroom.courses.students.create", |
826 "parameterOrder": [ | 796 "parameterOrder": [ |
827 "courseId" | 797 "courseId" |
828 ], | 798 ], |
829 "parameters": { | 799 "parameters": { |
830 "enrollmentCode": { | |
831 "description": "Enrollment code of the cours
e to create the student in.\nThis code is required if userId\ncorresponds to the
requesting user; it may be omitted if the requesting\nuser has administrative p
ermissions to create students for any user.", | |
832 "location": "query", | |
833 "type": "string" | |
834 }, | |
835 "courseId": { | 800 "courseId": { |
836 "description": "Identifier of the course to
create the student in.\nThis identifier can be either the Classroom-assigned ide
ntifier or an\nalias.", | 801 "description": "Identifier of the course to
create the student in.\nThis identifier can be either the Classroom-assigned ide
ntifier or an\nalias.", |
837 "location": "path", | 802 "location": "path", |
838 "required": true, | 803 "required": true, |
839 "type": "string" | 804 "type": "string" |
| 805 }, |
| 806 "enrollmentCode": { |
| 807 "description": "Enrollment code of the cours
e to create the student in.\nThis code is required if userId\ncorresponds to the
requesting user; it may be omitted if the requesting\nuser has administrative p
ermissions to create students for any user.", |
| 808 "location": "query", |
| 809 "type": "string" |
840 } | 810 } |
841 }, | 811 }, |
842 "path": "v1/courses/{courseId}/students", | 812 "path": "v1/courses/{courseId}/students", |
843 "request": { | 813 "request": { |
844 "$ref": "Student" | 814 "$ref": "Student" |
845 }, | 815 }, |
846 "response": { | 816 "response": { |
847 "$ref": "Student" | 817 "$ref": "Student" |
848 }, | 818 }, |
849 "scopes": [ | 819 "scopes": [ |
850 "https://www.googleapis.com/auth/classroom.profi
le.emails", | 820 "https://www.googleapis.com/auth/classroom.profi
le.emails", |
851 "https://www.googleapis.com/auth/classroom.profi
le.photos", | 821 "https://www.googleapis.com/auth/classroom.profi
le.photos", |
852 "https://www.googleapis.com/auth/classroom.roste
rs" | 822 "https://www.googleapis.com/auth/classroom.roste
rs" |
853 ] | 823 ] |
| 824 }, |
| 825 "delete": { |
| 826 "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.", |
| 827 "httpMethod": "DELETE", |
| 828 "id": "classroom.courses.students.delete", |
| 829 "parameterOrder": [ |
| 830 "courseId", |
| 831 "userId" |
| 832 ], |
| 833 "parameters": { |
| 834 "courseId": { |
| 835 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
| 836 "location": "path", |
| 837 "required": true, |
| 838 "type": "string" |
| 839 }, |
| 840 "userId": { |
| 841 "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", |
| 842 "location": "path", |
| 843 "required": true, |
| 844 "type": "string" |
| 845 } |
| 846 }, |
| 847 "path": "v1/courses/{courseId}/students/{userId}", |
| 848 "response": { |
| 849 "$ref": "Empty" |
| 850 }, |
| 851 "scopes": [ |
| 852 "https://www.googleapis.com/auth/classroom.roste
rs" |
| 853 ] |
854 } | 854 } |
855 } | 855 } |
856 }, | 856 }, |
857 "courseWork": { | 857 "courseWork": { |
858 "methods": { | 858 "methods": { |
859 "delete": { | 859 "delete": { |
860 "description": "Deletes a course work.\n\nThis reque
st must be made by the Developer Console project of the\n[OAuth client ID](https
://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding co
urse work item.\n\nThis method returns the following error codes:\n\n* `PERMISSI
ON_DENIED` if the requesting developer project did not create\nthe corresponding
course work, if the requesting user is not permitted\nto delete the requested c
ourse or for access errors.\n* `FAILED_PRECONDITION` if the requested course wor
k has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the request
ed ID.", | 860 "description": "Deletes a course work.\n\nThis reque
st must be made by the Developer Console project of the\n[OAuth client ID](https
://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding co
urse work item.\n\nThis method returns the following error codes:\n\n* `PERMISSI
ON_DENIED` if the requesting developer project did not create\nthe corresponding
course work, if the requesting user is not permitted\nto delete the requested c
ourse or for access errors.\n* `FAILED_PRECONDITION` if the requested course wor
k has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the request
ed ID.", |
861 "httpMethod": "DELETE", | 861 "httpMethod": "DELETE", |
862 "id": "classroom.courses.courseWork.delete", | 862 "id": "classroom.courses.courseWork.delete", |
863 "parameterOrder": [ | 863 "parameterOrder": [ |
864 "courseId", | 864 "courseId", |
865 "id" | 865 "id" |
866 ], | 866 ], |
867 "parameters": { | 867 "parameters": { |
| 868 "courseId": { |
| 869 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
| 870 "location": "path", |
| 871 "required": true, |
| 872 "type": "string" |
| 873 }, |
868 "id": { | 874 "id": { |
869 "description": "Identifier of the course wor
k to delete.\nThis identifier is a Classroom-assigned identifier.", | 875 "description": "Identifier of the course wor
k to delete.\nThis identifier is a Classroom-assigned identifier.", |
870 "location": "path", | 876 "location": "path", |
871 "required": true, | 877 "required": true, |
872 "type": "string" | 878 "type": "string" |
873 }, | |
874 "courseId": { | |
875 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | |
876 "location": "path", | |
877 "required": true, | |
878 "type": "string" | |
879 } | 879 } |
880 }, | 880 }, |
881 "path": "v1/courses/{courseId}/courseWork/{id}", | 881 "path": "v1/courses/{courseId}/courseWork/{id}", |
882 "response": { | 882 "response": { |
883 "$ref": "Empty" | 883 "$ref": "Empty" |
884 }, | 884 }, |
885 "scopes": [ | 885 "scopes": [ |
886 "https://www.googleapis.com/auth/classroom.cours
ework.students" | 886 "https://www.googleapis.com/auth/classroom.cours
ework.students" |
887 ] | 887 ] |
888 }, | 888 }, |
(...skipping 53 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
942 }, | 942 }, |
943 "get": { | 943 "get": { |
944 "description": "Returns course work.\n\nThis method
returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting us
er is not permitted to access the\nrequested course or course work, or for acces
s errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if t
he requested course or course work does not exist.", | 944 "description": "Returns course work.\n\nThis method
returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting us
er is not permitted to access the\nrequested course or course work, or for acces
s errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if t
he requested course or course work does not exist.", |
945 "httpMethod": "GET", | 945 "httpMethod": "GET", |
946 "id": "classroom.courses.courseWork.get", | 946 "id": "classroom.courses.courseWork.get", |
947 "parameterOrder": [ | 947 "parameterOrder": [ |
948 "courseId", | 948 "courseId", |
949 "id" | 949 "id" |
950 ], | 950 ], |
951 "parameters": { | 951 "parameters": { |
| 952 "courseId": { |
| 953 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
| 954 "location": "path", |
| 955 "required": true, |
| 956 "type": "string" |
| 957 }, |
952 "id": { | 958 "id": { |
953 "description": "Identifier of the course wor
k.", | 959 "description": "Identifier of the course wor
k.", |
954 "location": "path", | 960 "location": "path", |
955 "required": true, | 961 "required": true, |
956 "type": "string" | 962 "type": "string" |
957 }, | |
958 "courseId": { | |
959 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | |
960 "location": "path", | |
961 "required": true, | |
962 "type": "string" | |
963 } | 963 } |
964 }, | 964 }, |
965 "path": "v1/courses/{courseId}/courseWork/{id}", | 965 "path": "v1/courses/{courseId}/courseWork/{id}", |
966 "response": { | 966 "response": { |
967 "$ref": "CourseWork" | 967 "$ref": "CourseWork" |
968 }, | 968 }, |
969 "scopes": [ | 969 "scopes": [ |
970 "https://www.googleapis.com/auth/classroom.cours
ework.me", | 970 "https://www.googleapis.com/auth/classroom.cours
ework.me", |
971 "https://www.googleapis.com/auth/classroom.cours
ework.me.readonly", | 971 "https://www.googleapis.com/auth/classroom.cours
ework.me.readonly", |
972 "https://www.googleapis.com/auth/classroom.cours
ework.students", | 972 "https://www.googleapis.com/auth/classroom.cours
ework.students", |
(...skipping 62 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1035 "$ref": "CourseWork" | 1035 "$ref": "CourseWork" |
1036 }, | 1036 }, |
1037 "scopes": [ | 1037 "scopes": [ |
1038 "https://www.googleapis.com/auth/classroom.cours
ework.students" | 1038 "https://www.googleapis.com/auth/classroom.cours
ework.students" |
1039 ] | 1039 ] |
1040 } | 1040 } |
1041 }, | 1041 }, |
1042 "resources": { | 1042 "resources": { |
1043 "studentSubmissions": { | 1043 "studentSubmissions": { |
1044 "methods": { | 1044 "methods": { |
1045 "get": { | 1045 "patch": { |
1046 "description": "Returns a student submission
.\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the
\nrequested course, course work, or student submission or for\naccess errors.\n*
`INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested
course, course work, or student submission\ndoes not exist.", | 1046 "description": "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.", |
1047 "httpMethod": "GET", | 1047 "httpMethod": "PATCH", |
1048 "id": "classroom.courses.courseWork.studentS
ubmissions.get", | 1048 "id": "classroom.courses.courseWork.studentS
ubmissions.patch", |
1049 "parameterOrder": [ | 1049 "parameterOrder": [ |
1050 "courseId", | 1050 "courseId", |
1051 "courseWorkId", | 1051 "courseWorkId", |
1052 "id" | 1052 "id" |
1053 ], | 1053 ], |
1054 "parameters": { | 1054 "parameters": { |
1055 "id": { | |
1056 "description": "Identifier of the st
udent submission.", | |
1057 "location": "path", | |
1058 "required": true, | |
1059 "type": "string" | |
1060 }, | |
1061 "courseWorkId": { | 1055 "courseWorkId": { |
1062 "description": "Identifier of the co
urse work.", | 1056 "description": "Identifier of the co
urse work.", |
1063 "location": "path", | 1057 "location": "path", |
1064 "required": true, | 1058 "required": true, |
1065 "type": "string" | 1059 "type": "string" |
1066 }, | 1060 }, |
1067 "courseId": { | 1061 "courseId": { |
1068 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", | 1062 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", |
1069 "location": "path", | 1063 "location": "path", |
1070 "required": true, | 1064 "required": true, |
1071 "type": "string" | 1065 "type": "string" |
1072 } | |
1073 }, | |
1074 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}", | |
1075 "response": { | |
1076 "$ref": "StudentSubmission" | |
1077 }, | |
1078 "scopes": [ | |
1079 "https://www.googleapis.com/auth/classro
om.coursework.me", | |
1080 "https://www.googleapis.com/auth/classro
om.coursework.me.readonly", | |
1081 "https://www.googleapis.com/auth/classro
om.coursework.students", | |
1082 "https://www.googleapis.com/auth/classro
om.coursework.students.readonly", | |
1083 "https://www.googleapis.com/auth/classro
om.student-submissions.me.readonly", | |
1084 "https://www.googleapis.com/auth/classro
om.student-submissions.students.readonly" | |
1085 ] | |
1086 }, | |
1087 "patch": { | |
1088 "description": "Updates one or more fields o
f a student submission.\n\nSee google.classroom.v1.StudentSubmission for details
\nof which fields may be updated and who may change them.\n\nThis request must b
e made by the Developer Console project of the\n[OAuth client ID](https://suppor
t.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work
item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED
` if the requesting developer project did not create\nthe corresponding course w
ork, if the user is not permitted to make the\nrequested modification to the stu
dent submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is
malformed.\n* `NOT_FOUND` if the requested course, course work, or student submi
ssion\ndoes not exist.", | |
1089 "httpMethod": "PATCH", | |
1090 "id": "classroom.courses.courseWork.studentS
ubmissions.patch", | |
1091 "parameterOrder": [ | |
1092 "courseId", | |
1093 "courseWorkId", | |
1094 "id" | |
1095 ], | |
1096 "parameters": { | |
1097 "courseWorkId": { | |
1098 "description": "Identifier of the co
urse work.", | |
1099 "location": "path", | |
1100 "required": true, | |
1101 "type": "string" | |
1102 }, | |
1103 "courseId": { | |
1104 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", | |
1105 "location": "path", | |
1106 "required": true, | |
1107 "type": "string" | |
1108 }, | 1066 }, |
1109 "id": { | 1067 "id": { |
1110 "description": "Identifier of the st
udent submission.", | 1068 "description": "Identifier of the st
udent submission.", |
1111 "location": "path", | 1069 "location": "path", |
1112 "required": true, | 1070 "required": true, |
1113 "type": "string" | 1071 "type": "string" |
1114 }, | 1072 }, |
1115 "updateMask": { | 1073 "updateMask": { |
1116 "description": "Mask that identifies
which fields on the student submission to update.\nThis field is required to do
an update. The update fails if invalid\nfields are specified.\n\nThe following
fields may be specified by teachers:\n* `draft_grade`\n* `assigned_grade`", | 1074 "description": "Mask that identifies
which fields on the student submission to update.\nThis field is required to do
an update. The update fails if invalid\nfields are specified.\n\nThe following
fields may be specified by teachers:\n* `draft_grade`\n* `assigned_grade`", |
1117 "format": "google-fieldmask", | 1075 "format": "google-fieldmask", |
1118 "location": "query", | 1076 "location": "query", |
1119 "type": "string" | 1077 "type": "string" |
1120 } | 1078 } |
1121 }, | 1079 }, |
1122 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}", | 1080 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}", |
1123 "request": { | 1081 "request": { |
1124 "$ref": "StudentSubmission" | 1082 "$ref": "StudentSubmission" |
1125 }, | 1083 }, |
1126 "response": { | 1084 "response": { |
1127 "$ref": "StudentSubmission" | 1085 "$ref": "StudentSubmission" |
1128 }, | 1086 }, |
1129 "scopes": [ | 1087 "scopes": [ |
1130 "https://www.googleapis.com/auth/classro
om.coursework.me", | 1088 "https://www.googleapis.com/auth/classro
om.coursework.me", |
1131 "https://www.googleapis.com/auth/classro
om.coursework.students" | 1089 "https://www.googleapis.com/auth/classro
om.coursework.students" |
1132 ] | 1090 ] |
1133 }, | 1091 }, |
| 1092 "get": { |
| 1093 "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.", |
| 1094 "httpMethod": "GET", |
| 1095 "id": "classroom.courses.courseWork.studentS
ubmissions.get", |
| 1096 "parameterOrder": [ |
| 1097 "courseId", |
| 1098 "courseWorkId", |
| 1099 "id" |
| 1100 ], |
| 1101 "parameters": { |
| 1102 "id": { |
| 1103 "description": "Identifier of the st
udent submission.", |
| 1104 "location": "path", |
| 1105 "required": true, |
| 1106 "type": "string" |
| 1107 }, |
| 1108 "courseWorkId": { |
| 1109 "description": "Identifier of the co
urse work.", |
| 1110 "location": "path", |
| 1111 "required": true, |
| 1112 "type": "string" |
| 1113 }, |
| 1114 "courseId": { |
| 1115 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", |
| 1116 "location": "path", |
| 1117 "required": true, |
| 1118 "type": "string" |
| 1119 } |
| 1120 }, |
| 1121 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}", |
| 1122 "response": { |
| 1123 "$ref": "StudentSubmission" |
| 1124 }, |
| 1125 "scopes": [ |
| 1126 "https://www.googleapis.com/auth/classro
om.coursework.me", |
| 1127 "https://www.googleapis.com/auth/classro
om.coursework.me.readonly", |
| 1128 "https://www.googleapis.com/auth/classro
om.coursework.students", |
| 1129 "https://www.googleapis.com/auth/classro
om.coursework.students.readonly", |
| 1130 "https://www.googleapis.com/auth/classro
om.student-submissions.me.readonly", |
| 1131 "https://www.googleapis.com/auth/classro
om.student-submissions.students.readonly" |
| 1132 ] |
| 1133 }, |
1134 "return": { | 1134 "return": { |
1135 "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.", | 1135 "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.", |
1136 "httpMethod": "POST", | 1136 "httpMethod": "POST", |
1137 "id": "classroom.courses.courseWork.studentS
ubmissions.return", | 1137 "id": "classroom.courses.courseWork.studentS
ubmissions.return", |
1138 "parameterOrder": [ | 1138 "parameterOrder": [ |
1139 "courseId", | 1139 "courseId", |
1140 "courseWorkId", | 1140 "courseWorkId", |
1141 "id" | 1141 "id" |
1142 ], | 1142 ], |
1143 "parameters": { | 1143 "parameters": { |
| 1144 "id": { |
| 1145 "description": "Identifier of the st
udent submission.", |
| 1146 "location": "path", |
| 1147 "required": true, |
| 1148 "type": "string" |
| 1149 }, |
1144 "courseWorkId": { | 1150 "courseWorkId": { |
1145 "description": "Identifier of the co
urse work.", | 1151 "description": "Identifier of the co
urse work.", |
1146 "location": "path", | 1152 "location": "path", |
1147 "required": true, | 1153 "required": true, |
1148 "type": "string" | 1154 "type": "string" |
1149 }, | 1155 }, |
1150 "courseId": { | 1156 "courseId": { |
1151 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", | 1157 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", |
1152 "location": "path", | 1158 "location": "path", |
1153 "required": true, | 1159 "required": true, |
1154 "type": "string" | 1160 "type": "string" |
1155 }, | |
1156 "id": { | |
1157 "description": "Identifier of the st
udent submission.", | |
1158 "location": "path", | |
1159 "required": true, | |
1160 "type": "string" | |
1161 } | 1161 } |
1162 }, | 1162 }, |
1163 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}:return", | 1163 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}:return", |
1164 "request": { | 1164 "request": { |
1165 "$ref": "ReturnStudentSubmissionRequest" | 1165 "$ref": "ReturnStudentSubmissionRequest" |
1166 }, | 1166 }, |
1167 "response": { | 1167 "response": { |
1168 "$ref": "Empty" | 1168 "$ref": "Empty" |
1169 }, | 1169 }, |
1170 "scopes": [ | 1170 "scopes": [ |
1171 "https://www.googleapis.com/auth/classro
om.coursework.students" | 1171 "https://www.googleapis.com/auth/classro
om.coursework.students" |
1172 ] | 1172 ] |
1173 }, | 1173 }, |
1174 "reclaim": { | 1174 "reclaim": { |
1175 "description": "Reclaims a student submissio
n on behalf of the student that owns it.\n\nReclaiming a student submission tran
sfers ownership of attached Drive\nfiles to the student and update the submissio
n state.\n\nOnly the student that owns the requested student submission may call
this\nmethod, and only for a student submission that has been turned in.\n\nThi
s request must be made by the Developer Console project of the\n[OAuth client ID
](https://support.google.com/cloud/answer/6158849) used to\ncreate the correspon
ding course work item.\n\nThis method returns the following error codes:\n\n* `P
ERMISSION_DENIED` if the requesting user is not permitted to access the\nrequest
ed course or course work, unsubmit the requested student submission,\nor for acc
ess errors.\n* `FAILED_PRECONDITION` if the student submission has not been turn
ed in.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the
requested course, course work, or student submission\ndoes not exist.", | 1175 "description": "Reclaims a student submissio
n on behalf of the student that owns it.\n\nReclaiming a student submission tran
sfers ownership of attached Drive\nfiles to the student and update the submissio
n state.\n\nOnly the student that owns the requested student submission may call
this\nmethod, and only for a student submission that has been turned in.\n\nThi
s request must be made by the Developer Console project of the\n[OAuth client ID
](https://support.google.com/cloud/answer/6158849) used to\ncreate the correspon
ding course work item.\n\nThis method returns the following error codes:\n\n* `P
ERMISSION_DENIED` if the requesting user is not permitted to access the\nrequest
ed course or course work, unsubmit the requested student submission,\nor for acc
ess errors.\n* `FAILED_PRECONDITION` if the student submission has not been turn
ed in.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the
requested course, course work, or student submission\ndoes not exist.", |
1176 "httpMethod": "POST", | 1176 "httpMethod": "POST", |
1177 "id": "classroom.courses.courseWork.studentS
ubmissions.reclaim", | 1177 "id": "classroom.courses.courseWork.studentS
ubmissions.reclaim", |
1178 "parameterOrder": [ | 1178 "parameterOrder": [ |
1179 "courseId", | 1179 "courseId", |
1180 "courseWorkId", | 1180 "courseWorkId", |
1181 "id" | 1181 "id" |
1182 ], | 1182 ], |
1183 "parameters": { | 1183 "parameters": { |
| 1184 "courseId": { |
| 1185 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", |
| 1186 "location": "path", |
| 1187 "required": true, |
| 1188 "type": "string" |
| 1189 }, |
1184 "id": { | 1190 "id": { |
1185 "description": "Identifier of the st
udent submission.", | 1191 "description": "Identifier of the st
udent submission.", |
1186 "location": "path", | 1192 "location": "path", |
1187 "required": true, | 1193 "required": true, |
1188 "type": "string" | 1194 "type": "string" |
1189 }, | 1195 }, |
1190 "courseWorkId": { | 1196 "courseWorkId": { |
1191 "description": "Identifier of the co
urse work.", | 1197 "description": "Identifier of the co
urse work.", |
1192 "location": "path", | 1198 "location": "path", |
1193 "required": true, | 1199 "required": true, |
1194 "type": "string" | 1200 "type": "string" |
1195 }, | |
1196 "courseId": { | |
1197 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", | |
1198 "location": "path", | |
1199 "required": true, | |
1200 "type": "string" | |
1201 } | 1201 } |
1202 }, | 1202 }, |
1203 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}:reclaim", | 1203 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}:reclaim", |
1204 "request": { | 1204 "request": { |
1205 "$ref": "ReclaimStudentSubmissionRequest
" | 1205 "$ref": "ReclaimStudentSubmissionRequest
" |
1206 }, | 1206 }, |
1207 "response": { | 1207 "response": { |
1208 "$ref": "Empty" | 1208 "$ref": "Empty" |
1209 }, | 1209 }, |
1210 "scopes": [ | 1210 "scopes": [ |
(...skipping 57 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1268 "NOT_LATE_ONLY" | 1268 "NOT_LATE_ONLY" |
1269 ], | 1269 ], |
1270 "location": "query", | 1270 "location": "query", |
1271 "type": "string" | 1271 "type": "string" |
1272 }, | 1272 }, |
1273 "pageToken": { | 1273 "pageToken": { |
1274 "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.", | 1274 "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.", |
1275 "location": "query", | 1275 "location": "query", |
1276 "type": "string" | 1276 "type": "string" |
1277 }, | 1277 }, |
| 1278 "pageSize": { |
| 1279 "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.", |
| 1280 "format": "int32", |
| 1281 "location": "query", |
| 1282 "type": "integer" |
| 1283 }, |
1278 "states": { | 1284 "states": { |
1279 "description": "Requested submission
states. If specified, returned student submissions\nmatch one of the specified
submission states.", | 1285 "description": "Requested submission
states. If specified, returned student submissions\nmatch one of the specified
submission states.", |
1280 "enum": [ | 1286 "enum": [ |
1281 "SUBMISSION_STATE_UNSPECIFIED", | 1287 "SUBMISSION_STATE_UNSPECIFIED", |
1282 "NEW", | 1288 "NEW", |
1283 "CREATED", | 1289 "CREATED", |
1284 "TURNED_IN", | 1290 "TURNED_IN", |
1285 "RETURNED", | 1291 "RETURNED", |
1286 "RECLAIMED_BY_STUDENT" | 1292 "RECLAIMED_BY_STUDENT" |
1287 ], | 1293 ], |
1288 "location": "query", | 1294 "location": "query", |
1289 "repeated": true, | 1295 "repeated": true, |
1290 "type": "string" | 1296 "type": "string" |
1291 }, | 1297 }, |
1292 "pageSize": { | |
1293 "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.", | |
1294 "format": "int32", | |
1295 "location": "query", | |
1296 "type": "integer" | |
1297 }, | |
1298 "userId": { | 1298 "userId": { |
1299 "description": "Optional argument to
restrict returned student work to those owned by the\nstudent with the specifie
d identifier. The identifier can be one of the\nfollowing:\n\n* the numeric iden
tifier for the user\n* the email address of the user\n* the string literal `\"me
\"`, indicating the requesting user", | 1299 "description": "Optional argument to
restrict returned student work to those owned by the\nstudent with the specifie
d identifier. The identifier can be one of the\nfollowing:\n\n* the numeric iden
tifier for the user\n* the email address of the user\n* the string literal `\"me
\"`, indicating the requesting user", |
1300 "location": "query", | 1300 "location": "query", |
1301 "type": "string" | 1301 "type": "string" |
1302 }, | 1302 }, |
1303 "courseWorkId": { | 1303 "courseWorkId": { |
1304 "description": "Identifier of the st
udent work to request.\nThis may be set to the string literal `\"-\"` to request
student work for\nall course work in the specified course.", | 1304 "description": "Identifier of the st
udent work to request.\nThis may be set to the string literal `\"-\"` to request
student work for\nall course work in the specified course.", |
1305 "location": "path", | 1305 "location": "path", |
1306 "required": true, | 1306 "required": true, |
1307 "type": "string" | 1307 "type": "string" |
(...skipping 21 matching lines...) Expand all Loading... |
1329 "modifyAttachments": { | 1329 "modifyAttachments": { |
1330 "description": "Modifies attachments of stud
ent submission.\n\nAttachments may only be added to student submissions belongin
g to course\nwork objects with a `workType` of `ASSIGNMENT`.\n\nThis request mus
t be made by the Developer Console project of the\n[OAuth client ID](https://sup
port.google.com/cloud/answer/6158849) used to\ncreate the corresponding course w
ork item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DEN
IED` if the requesting user is not permitted to access the\nrequested course or
course work, if the user is not permitted to modify\nattachments on the requeste
d student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the reques
t is malformed.\n* `NOT_FOUND` if the requested course, course work, or student
submission\ndoes not exist.", | 1330 "description": "Modifies attachments of stud
ent submission.\n\nAttachments may only be added to student submissions belongin
g to course\nwork objects with a `workType` of `ASSIGNMENT`.\n\nThis request mus
t be made by the Developer Console project of the\n[OAuth client ID](https://sup
port.google.com/cloud/answer/6158849) used to\ncreate the corresponding course w
ork item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DEN
IED` if the requesting user is not permitted to access the\nrequested course or
course work, if the user is not permitted to modify\nattachments on the requeste
d student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the reques
t is malformed.\n* `NOT_FOUND` if the requested course, course work, or student
submission\ndoes not exist.", |
1331 "httpMethod": "POST", | 1331 "httpMethod": "POST", |
1332 "id": "classroom.courses.courseWork.studentS
ubmissions.modifyAttachments", | 1332 "id": "classroom.courses.courseWork.studentS
ubmissions.modifyAttachments", |
1333 "parameterOrder": [ | 1333 "parameterOrder": [ |
1334 "courseId", | 1334 "courseId", |
1335 "courseWorkId", | 1335 "courseWorkId", |
1336 "id" | 1336 "id" |
1337 ], | 1337 ], |
1338 "parameters": { | 1338 "parameters": { |
1339 "courseWorkId": { | |
1340 "description": "Identifier of the co
urse work.", | |
1341 "location": "path", | |
1342 "required": true, | |
1343 "type": "string" | |
1344 }, | |
1345 "courseId": { | 1339 "courseId": { |
1346 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", | 1340 "description": "Identifier of the co
urse.\nThis identifier can be either the Classroom-assigned identifier or an\nal
ias.", |
1347 "location": "path", | 1341 "location": "path", |
1348 "required": true, | 1342 "required": true, |
1349 "type": "string" | 1343 "type": "string" |
1350 }, | 1344 }, |
1351 "id": { | 1345 "id": { |
1352 "description": "Identifier of the st
udent submission.", | 1346 "description": "Identifier of the st
udent submission.", |
1353 "location": "path", | 1347 "location": "path", |
1354 "required": true, | 1348 "required": true, |
1355 "type": "string" | 1349 "type": "string" |
| 1350 }, |
| 1351 "courseWorkId": { |
| 1352 "description": "Identifier of the co
urse work.", |
| 1353 "location": "path", |
| 1354 "required": true, |
| 1355 "type": "string" |
1356 } | 1356 } |
1357 }, | 1357 }, |
1358 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}:modifyAttachments", | 1358 "path": "v1/courses/{courseId}/courseWork/{c
ourseWorkId}/studentSubmissions/{id}:modifyAttachments", |
1359 "request": { | 1359 "request": { |
1360 "$ref": "ModifyAttachmentsRequest" | 1360 "$ref": "ModifyAttachmentsRequest" |
1361 }, | 1361 }, |
1362 "response": { | 1362 "response": { |
1363 "$ref": "StudentSubmission" | 1363 "$ref": "StudentSubmission" |
1364 }, | 1364 }, |
1365 "scopes": [ | 1365 "scopes": [ |
1366 "https://www.googleapis.com/auth/classro
om.coursework.me", | 1366 "https://www.googleapis.com/auth/classro
om.coursework.me", |
1367 "https://www.googleapis.com/auth/classro
om.coursework.students" | 1367 "https://www.googleapis.com/auth/classro
om.coursework.students" |
1368 ] | 1368 ] |
1369 } | 1369 } |
1370 } | 1370 } |
1371 } | 1371 } |
1372 } | 1372 } |
1373 }, | 1373 }, |
1374 "teachers": { | 1374 "teachers": { |
1375 "methods": { | 1375 "methods": { |
| 1376 "delete": { |
| 1377 "description": "Deletes a teacher of a course.\n\nTh
is method returns the following error codes:\n\n* `PERMISSION_DENIED` if the req
uesting user is not permitted to delete\nteachers of this course or for access e
rrors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if th
e\ncourse does not exist.\n* `FAILED_PRECONDITION` if the requested ID belongs t
o the primary teacher\nof this course.", |
| 1378 "httpMethod": "DELETE", |
| 1379 "id": "classroom.courses.teachers.delete", |
| 1380 "parameterOrder": [ |
| 1381 "courseId", |
| 1382 "userId" |
| 1383 ], |
| 1384 "parameters": { |
| 1385 "courseId": { |
| 1386 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", |
| 1387 "location": "path", |
| 1388 "required": true, |
| 1389 "type": "string" |
| 1390 }, |
| 1391 "userId": { |
| 1392 "description": "Identifier of the teacher to
delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifie
r for the user\n* the email address of the user\n* the string literal `\"me\"`,
indicating the requesting user", |
| 1393 "location": "path", |
| 1394 "required": true, |
| 1395 "type": "string" |
| 1396 } |
| 1397 }, |
| 1398 "path": "v1/courses/{courseId}/teachers/{userId}", |
| 1399 "response": { |
| 1400 "$ref": "Empty" |
| 1401 }, |
| 1402 "scopes": [ |
| 1403 "https://www.googleapis.com/auth/classroom.roste
rs" |
| 1404 ] |
| 1405 }, |
1376 "list": { | 1406 "list": { |
1377 "description": "Returns a list of teachers of this c
ourse that the requester\nis permitted to view.\n\nThis method returns the follo
wing error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_
DENIED` for access errors.", | 1407 "description": "Returns a list of teachers of this c
ourse that the requester\nis permitted to view.\n\nThis method returns the follo
wing error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_
DENIED` for access errors.", |
1378 "httpMethod": "GET", | 1408 "httpMethod": "GET", |
1379 "id": "classroom.courses.teachers.list", | 1409 "id": "classroom.courses.teachers.list", |
1380 "parameterOrder": [ | 1410 "parameterOrder": [ |
1381 "courseId" | 1411 "courseId" |
1382 ], | 1412 ], |
1383 "parameters": { | 1413 "parameters": { |
1384 "pageToken": { | 1414 "pageToken": { |
1385 "description": "nextPageToken\nvalue returne
d from a previous\nlist call, indicating that\nthe subsequent page of results sh
ould be returned.\n\nThe list request must be\notherwise identical to the one th
at resulted in this token.", | 1415 "description": "nextPageToken\nvalue returne
d from a previous\nlist call, indicating that\nthe subsequent page of results sh
ould be returned.\n\nThe list request must be\notherwise identical to the one th
at resulted in this token.", |
(...skipping 77 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1463 "$ref": "Teacher" | 1493 "$ref": "Teacher" |
1464 }, | 1494 }, |
1465 "response": { | 1495 "response": { |
1466 "$ref": "Teacher" | 1496 "$ref": "Teacher" |
1467 }, | 1497 }, |
1468 "scopes": [ | 1498 "scopes": [ |
1469 "https://www.googleapis.com/auth/classroom.profi
le.emails", | 1499 "https://www.googleapis.com/auth/classroom.profi
le.emails", |
1470 "https://www.googleapis.com/auth/classroom.profi
le.photos", | 1500 "https://www.googleapis.com/auth/classroom.profi
le.photos", |
1471 "https://www.googleapis.com/auth/classroom.roste
rs" | 1501 "https://www.googleapis.com/auth/classroom.roste
rs" |
1472 ] | 1502 ] |
1473 }, | |
1474 "delete": { | |
1475 "description": "Deletes a teacher of a course.\n\nTh
is method returns the following error codes:\n\n* `PERMISSION_DENIED` if the req
uesting user is not permitted to delete\nteachers of this course or for access e
rrors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if th
e\ncourse does not exist.\n* `FAILED_PRECONDITION` if the requested ID belongs t
o the primary teacher\nof this course.", | |
1476 "httpMethod": "DELETE", | |
1477 "id": "classroom.courses.teachers.delete", | |
1478 "parameterOrder": [ | |
1479 "courseId", | |
1480 "userId" | |
1481 ], | |
1482 "parameters": { | |
1483 "userId": { | |
1484 "description": "Identifier of the teacher to
delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifie
r for the user\n* the email address of the user\n* the string literal `\"me\"`,
indicating the requesting user", | |
1485 "location": "path", | |
1486 "required": true, | |
1487 "type": "string" | |
1488 }, | |
1489 "courseId": { | |
1490 "description": "Identifier of the course.\nT
his identifier can be either the Classroom-assigned identifier or an\nalias.", | |
1491 "location": "path", | |
1492 "required": true, | |
1493 "type": "string" | |
1494 } | |
1495 }, | |
1496 "path": "v1/courses/{courseId}/teachers/{userId}", | |
1497 "response": { | |
1498 "$ref": "Empty" | |
1499 }, | |
1500 "scopes": [ | |
1501 "https://www.googleapis.com/auth/classroom.roste
rs" | |
1502 ] | |
1503 } | 1503 } |
1504 } | 1504 } |
1505 } | 1505 } |
1506 } | 1506 } |
1507 }, | 1507 }, |
1508 "invitations": { | 1508 "invitations": { |
1509 "methods": { | 1509 "methods": { |
1510 "delete": { | |
1511 "description": "Deletes an invitation.\n\nThis method return
s the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is
not permitted to delete the\nrequested invitation or for access errors.\n* `NOT_
FOUND` if no invitation exists with the requested ID.", | |
1512 "httpMethod": "DELETE", | |
1513 "id": "classroom.invitations.delete", | |
1514 "parameterOrder": [ | |
1515 "id" | |
1516 ], | |
1517 "parameters": { | |
1518 "id": { | |
1519 "description": "Identifier of the invitation to dele
te.", | |
1520 "location": "path", | |
1521 "required": true, | |
1522 "type": "string" | |
1523 } | |
1524 }, | |
1525 "path": "v1/invitations/{id}", | |
1526 "response": { | |
1527 "$ref": "Empty" | |
1528 }, | |
1529 "scopes": [ | |
1530 "https://www.googleapis.com/auth/classroom.rosters" | |
1531 ] | |
1532 }, | |
1533 "list": { | 1510 "list": { |
1534 "description": "Returns a list of invitations that the reque
sting user is permitted to\nview, restricted to those that match the list reques
t.\n\n*Note:* At least one of `user_id` or `course_id` must be supplied. Both\nf
ields can be supplied.\n\nThis method returns the following error codes:\n\n* `P
ERMISSION_DENIED` for access errors.", | 1511 "description": "Returns a list of invitations that the reque
sting user is permitted to\nview, restricted to those that match the list reques
t.\n\n*Note:* At least one of `user_id` or `course_id` must be supplied. Both\nf
ields can be supplied.\n\nThis method returns the following error codes:\n\n* `P
ERMISSION_DENIED` for access errors.", |
1535 "httpMethod": "GET", | 1512 "httpMethod": "GET", |
1536 "id": "classroom.invitations.list", | 1513 "id": "classroom.invitations.list", |
1537 "parameterOrder": [], | 1514 "parameterOrder": [], |
1538 "parameters": { | 1515 "parameters": { |
1539 "pageToken": { | 1516 "pageToken": { |
1540 "description": "nextPageToken\nvalue returned from a
previous\nlist call, indicating\nthat the subsequent page of results should be
returned.\n\nThe list request must be\notherwise identical to the one that resul
ted in this token.", | 1517 "description": "nextPageToken\nvalue returned from a
previous\nlist call, indicating\nthat the subsequent page of results should be
returned.\n\nThe list request must be\notherwise identical to the one that resul
ted in this token.", |
1541 "location": "query", | 1518 "location": "query", |
1542 "type": "string" | 1519 "type": "string" |
(...skipping 80 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1623 "type": "string" | 1600 "type": "string" |
1624 } | 1601 } |
1625 }, | 1602 }, |
1626 "path": "v1/invitations/{id}:accept", | 1603 "path": "v1/invitations/{id}:accept", |
1627 "response": { | 1604 "response": { |
1628 "$ref": "Empty" | 1605 "$ref": "Empty" |
1629 }, | 1606 }, |
1630 "scopes": [ | 1607 "scopes": [ |
1631 "https://www.googleapis.com/auth/classroom.rosters" | 1608 "https://www.googleapis.com/auth/classroom.rosters" |
1632 ] | 1609 ] |
| 1610 }, |
| 1611 "delete": { |
| 1612 "description": "Deletes an invitation.\n\nThis method return
s the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is
not permitted to delete the\nrequested invitation or for access errors.\n* `NOT_
FOUND` if no invitation exists with the requested ID.", |
| 1613 "httpMethod": "DELETE", |
| 1614 "id": "classroom.invitations.delete", |
| 1615 "parameterOrder": [ |
| 1616 "id" |
| 1617 ], |
| 1618 "parameters": { |
| 1619 "id": { |
| 1620 "description": "Identifier of the invitation to dele
te.", |
| 1621 "location": "path", |
| 1622 "required": true, |
| 1623 "type": "string" |
| 1624 } |
| 1625 }, |
| 1626 "path": "v1/invitations/{id}", |
| 1627 "response": { |
| 1628 "$ref": "Empty" |
| 1629 }, |
| 1630 "scopes": [ |
| 1631 "https://www.googleapis.com/auth/classroom.rosters" |
| 1632 ] |
1633 } | 1633 } |
1634 } | 1634 } |
1635 } | 1635 } |
1636 }, | 1636 }, |
1637 "revision": "20170818", | 1637 "revision": "20170905", |
1638 "rootUrl": "https://classroom.googleapis.com/", | 1638 "rootUrl": "https://classroom.googleapis.com/", |
1639 "schemas": { | 1639 "schemas": { |
| 1640 "ListCoursesResponse": { |
| 1641 "description": "Response when listing courses.", |
| 1642 "id": "ListCoursesResponse", |
| 1643 "properties": { |
| 1644 "courses": { |
| 1645 "description": "Courses that match the list request.", |
| 1646 "items": { |
| 1647 "$ref": "Course" |
| 1648 }, |
| 1649 "type": "array" |
| 1650 }, |
| 1651 "nextPageToken": { |
| 1652 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
| 1653 "type": "string" |
| 1654 } |
| 1655 }, |
| 1656 "type": "object" |
| 1657 }, |
| 1658 "Form": { |
| 1659 "description": "Google Forms item.", |
| 1660 "id": "Form", |
| 1661 "properties": { |
| 1662 "title": { |
| 1663 "description": "Title of the Form.\n\nRead-only.", |
| 1664 "type": "string" |
| 1665 }, |
| 1666 "thumbnailUrl": { |
| 1667 "description": "URL of a thumbnail image of the Form.\n\nRea
d-only.", |
| 1668 "type": "string" |
| 1669 }, |
| 1670 "responseUrl": { |
| 1671 "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.", |
| 1672 "type": "string" |
| 1673 }, |
| 1674 "formUrl": { |
| 1675 "description": "URL of the form.", |
| 1676 "type": "string" |
| 1677 } |
| 1678 }, |
| 1679 "type": "object" |
| 1680 }, |
| 1681 "ListTeachersResponse": { |
| 1682 "description": "Response when listing teachers.", |
| 1683 "id": "ListTeachersResponse", |
| 1684 "properties": { |
| 1685 "teachers": { |
| 1686 "description": "Teachers who match the list request.", |
| 1687 "items": { |
| 1688 "$ref": "Teacher" |
| 1689 }, |
| 1690 "type": "array" |
| 1691 }, |
| 1692 "nextPageToken": { |
| 1693 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
| 1694 "type": "string" |
| 1695 } |
| 1696 }, |
| 1697 "type": "object" |
| 1698 }, |
| 1699 "Link": { |
| 1700 "description": "URL item.", |
| 1701 "id": "Link", |
| 1702 "properties": { |
| 1703 "title": { |
| 1704 "description": "Title of the target of the URL.\n\nRead-only
.", |
| 1705 "type": "string" |
| 1706 }, |
| 1707 "thumbnailUrl": { |
| 1708 "description": "URL of a thumbnail image of the target URL.\
n\nRead-only.", |
| 1709 "type": "string" |
| 1710 }, |
| 1711 "url": { |
| 1712 "description": "URL to link to.\nThis must be a valid UTF-8
string containing between 1 and 2024 characters.", |
| 1713 "type": "string" |
| 1714 } |
| 1715 }, |
| 1716 "type": "object" |
| 1717 }, |
| 1718 "ListGuardiansResponse": { |
| 1719 "description": "Response when listing guardians.", |
| 1720 "id": "ListGuardiansResponse", |
| 1721 "properties": { |
| 1722 "nextPageToken": { |
| 1723 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
| 1724 "type": "string" |
| 1725 }, |
| 1726 "guardians": { |
| 1727 "description": "Guardians on this page of results that met t
he criteria specified in\nthe request.", |
| 1728 "items": { |
| 1729 "$ref": "Guardian" |
| 1730 }, |
| 1731 "type": "array" |
| 1732 } |
| 1733 }, |
| 1734 "type": "object" |
| 1735 }, |
| 1736 "ListGuardianInvitationsResponse": { |
| 1737 "description": "Response when listing guardian invitations.", |
| 1738 "id": "ListGuardianInvitationsResponse", |
| 1739 "properties": { |
| 1740 "nextPageToken": { |
| 1741 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
| 1742 "type": "string" |
| 1743 }, |
| 1744 "guardianInvitations": { |
| 1745 "description": "Guardian invitations that matched the list r
equest.", |
| 1746 "items": { |
| 1747 "$ref": "GuardianInvitation" |
| 1748 }, |
| 1749 "type": "array" |
| 1750 } |
| 1751 }, |
| 1752 "type": "object" |
| 1753 }, |
| 1754 "ListCourseAliasesResponse": { |
| 1755 "description": "Response when listing course aliases.", |
| 1756 "id": "ListCourseAliasesResponse", |
| 1757 "properties": { |
| 1758 "aliases": { |
| 1759 "description": "The course aliases.", |
| 1760 "items": { |
| 1761 "$ref": "CourseAlias" |
| 1762 }, |
| 1763 "type": "array" |
| 1764 }, |
| 1765 "nextPageToken": { |
| 1766 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
| 1767 "type": "string" |
| 1768 } |
| 1769 }, |
| 1770 "type": "object" |
| 1771 }, |
| 1772 "CourseAlias": { |
| 1773 "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.", |
| 1774 "id": "CourseAlias", |
| 1775 "properties": { |
| 1776 "alias": { |
| 1777 "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.", |
| 1778 "type": "string" |
| 1779 } |
| 1780 }, |
| 1781 "type": "object" |
| 1782 }, |
| 1783 "Date": { |
| 1784 "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`.", |
| 1785 "id": "Date", |
| 1786 "properties": { |
| 1787 "day": { |
| 1788 "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.", |
| 1789 "format": "int32", |
| 1790 "type": "integer" |
| 1791 }, |
| 1792 "year": { |
| 1793 "description": "Year of date. Must be from 1 to 9999, or 0 i
f specifying a date without\na year.", |
| 1794 "format": "int32", |
| 1795 "type": "integer" |
| 1796 }, |
| 1797 "month": { |
| 1798 "description": "Month of year. Must be from 1 to 12.", |
| 1799 "format": "int32", |
| 1800 "type": "integer" |
| 1801 } |
| 1802 }, |
| 1803 "type": "object" |
| 1804 }, |
| 1805 "MultipleChoiceSubmission": { |
| 1806 "description": "Student work for a multiple-choice question.", |
| 1807 "id": "MultipleChoiceSubmission", |
| 1808 "properties": { |
| 1809 "answer": { |
| 1810 "description": "Student's select choice.", |
| 1811 "type": "string" |
| 1812 } |
| 1813 }, |
| 1814 "type": "object" |
| 1815 }, |
| 1816 "CourseMaterial": { |
| 1817 "description": "A material attached to a course as part of a materia
l set.", |
| 1818 "id": "CourseMaterial", |
| 1819 "properties": { |
| 1820 "youTubeVideo": { |
| 1821 "$ref": "YouTubeVideo", |
| 1822 "description": "Youtube video attachment." |
| 1823 }, |
| 1824 "driveFile": { |
| 1825 "$ref": "DriveFile", |
| 1826 "description": "Google Drive file attachment." |
| 1827 }, |
| 1828 "form": { |
| 1829 "$ref": "Form", |
| 1830 "description": "Google Forms attachment." |
| 1831 }, |
| 1832 "link": { |
| 1833 "$ref": "Link", |
| 1834 "description": "Link atatchment." |
| 1835 } |
| 1836 }, |
| 1837 "type": "object" |
| 1838 }, |
| 1839 "Name": { |
| 1840 "description": "Details of the user's name.", |
| 1841 "id": "Name", |
| 1842 "properties": { |
| 1843 "fullName": { |
| 1844 "description": "The user's full name formed by concatenating
the first and last name\nvalues.\n\nRead-only.", |
| 1845 "type": "string" |
| 1846 }, |
| 1847 "familyName": { |
| 1848 "description": "The user's last name.\n\nRead-only.", |
| 1849 "type": "string" |
| 1850 }, |
| 1851 "givenName": { |
| 1852 "description": "The user's first name.\n\nRead-only.", |
| 1853 "type": "string" |
| 1854 } |
| 1855 }, |
| 1856 "type": "object" |
| 1857 }, |
| 1858 "Assignment": { |
| 1859 "description": "Additional details for assignments.", |
| 1860 "id": "Assignment", |
| 1861 "properties": { |
| 1862 "studentWorkFolder": { |
| 1863 "$ref": "DriveFolder", |
| 1864 "description": "Drive folder where attachments from student
submissions are placed.\nThis is only populated for course teachers and administ
rators." |
| 1865 } |
| 1866 }, |
| 1867 "type": "object" |
| 1868 }, |
| 1869 "SharedDriveFile": { |
| 1870 "description": "Drive file that is used as material for course work.
", |
| 1871 "id": "SharedDriveFile", |
| 1872 "properties": { |
| 1873 "shareMode": { |
| 1874 "description": "Mechanism by which students access the Drive
item.", |
| 1875 "enum": [ |
| 1876 "UNKNOWN_SHARE_MODE", |
| 1877 "VIEW", |
| 1878 "EDIT", |
| 1879 "STUDENT_COPY" |
| 1880 ], |
| 1881 "enumDescriptions": [ |
| 1882 "No sharing mode specified. This should never be returne
d.", |
| 1883 "Students can view the shared file.", |
| 1884 "Students can edit the shared file.", |
| 1885 "Students have a personal copy of the shared file." |
| 1886 ], |
| 1887 "type": "string" |
| 1888 }, |
| 1889 "driveFile": { |
| 1890 "$ref": "DriveFile", |
| 1891 "description": "Drive file details." |
| 1892 } |
| 1893 }, |
| 1894 "type": "object" |
| 1895 }, |
| 1896 "Empty": { |
| 1897 "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 `{}`.", |
| 1898 "id": "Empty", |
| 1899 "properties": {}, |
| 1900 "type": "object" |
| 1901 }, |
| 1902 "MultipleChoiceQuestion": { |
| 1903 "description": "Additional details for multiple-choice questions.", |
| 1904 "id": "MultipleChoiceQuestion", |
| 1905 "properties": { |
| 1906 "choices": { |
| 1907 "description": "Possible choices.", |
| 1908 "items": { |
| 1909 "type": "string" |
| 1910 }, |
| 1911 "type": "array" |
| 1912 } |
| 1913 }, |
| 1914 "type": "object" |
| 1915 }, |
| 1916 "Course": { |
| 1917 "description": "A Course in Classroom.", |
| 1918 "id": "Course", |
| 1919 "properties": { |
| 1920 "section": { |
| 1921 "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.", |
| 1922 "type": "string" |
| 1923 }, |
| 1924 "id": { |
| 1925 "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.", |
| 1926 "type": "string" |
| 1927 }, |
| 1928 "room": { |
| 1929 "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.", |
| 1930 "type": "string" |
| 1931 }, |
| 1932 "courseGroupEmail": { |
| 1933 "description": "The email address of a Google group containi
ng all members of the course.\nThis group does not accept email and can only be
used for permissions.\n\nRead-only.", |
| 1934 "type": "string" |
| 1935 }, |
| 1936 "enrollmentCode": { |
| 1937 "description": "Enrollment code to use when joining this cou
rse.\nSpecifying this field in a course update mask results in an error.\n\nRead
-only.", |
| 1938 "type": "string" |
| 1939 }, |
| 1940 "courseMaterialSets": { |
| 1941 "description": "Sets of materials that appear on the \"about
\" page of this course.\n\nRead-only.", |
| 1942 "items": { |
| 1943 "$ref": "CourseMaterialSet" |
| 1944 }, |
| 1945 "type": "array" |
| 1946 }, |
| 1947 "descriptionHeading": { |
| 1948 "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.", |
| 1949 "type": "string" |
| 1950 }, |
| 1951 "calendarId": { |
| 1952 "description": "The Calendar ID for a calendar that all cour
se members can see, to which\nClassroom adds events for course work and announce
ments in the course.\n\nRead-only.", |
| 1953 "type": "string" |
| 1954 }, |
| 1955 "updateTime": { |
| 1956 "description": "Time of the most recent update to this cours
e.\nSpecifying this field in a course update mask results in an error.\n\nRead-o
nly.", |
| 1957 "format": "google-datetime", |
| 1958 "type": "string" |
| 1959 }, |
| 1960 "alternateLink": { |
| 1961 "description": "Absolute link to this course in the Classroo
m web UI.\n\nRead-only.", |
| 1962 "type": "string" |
| 1963 }, |
| 1964 "guardiansEnabled": { |
| 1965 "description": "Whether or not guardian notifications are en
abled for this course.\n\nRead-only.", |
| 1966 "type": "boolean" |
| 1967 }, |
| 1968 "courseState": { |
| 1969 "description": "State of the course.\nIf unspecified, the de
fault state is `PROVISIONED`.", |
| 1970 "enum": [ |
| 1971 "COURSE_STATE_UNSPECIFIED", |
| 1972 "ACTIVE", |
| 1973 "ARCHIVED", |
| 1974 "PROVISIONED", |
| 1975 "DECLINED", |
| 1976 "SUSPENDED" |
| 1977 ], |
| 1978 "enumDescriptions": [ |
| 1979 "No course state. No returned Course message will use th
is value.", |
| 1980 "The course is active.", |
| 1981 "The course has been archived. You cannot modify it exce
pt to change it\nto a different state.", |
| 1982 "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.", |
| 1983 "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.", |
| 1984 "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." |
| 1985 ], |
| 1986 "type": "string" |
| 1987 }, |
| 1988 "ownerId": { |
| 1989 "description": "The identifier of the owner of a course.\n\n
When specified as a parameter of a\ncreate course request, this\nfield is requir
ed.\nThe identifier can be one of the following:\n\n* the numeric identifier for
the user\n* the email address of the user\n* the string literal `\"me\"`, indic
ating the requesting user\n\nThis must be set in a create request. Admins can al
so specify this field\nin a patch course request to\ntransfer ownership. In othe
r contexts, it is read-only.", |
| 1990 "type": "string" |
| 1991 }, |
| 1992 "description": { |
| 1993 "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.", |
| 1994 "type": "string" |
| 1995 }, |
| 1996 "teacherGroupEmail": { |
| 1997 "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.", |
| 1998 "type": "string" |
| 1999 }, |
| 2000 "creationTime": { |
| 2001 "description": "Creation time of the course.\nSpecifying thi
s field in a course update mask results in an error.\n\nRead-only.", |
| 2002 "format": "google-datetime", |
| 2003 "type": "string" |
| 2004 }, |
| 2005 "name": { |
| 2006 "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.", |
| 2007 "type": "string" |
| 2008 }, |
| 2009 "teacherFolder": { |
| 2010 "$ref": "DriveFolder", |
| 2011 "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." |
| 2012 } |
| 2013 }, |
| 2014 "type": "object" |
| 2015 }, |
| 2016 "DriveFile": { |
| 2017 "description": "Representation of a Google Drive file.", |
| 2018 "id": "DriveFile", |
| 2019 "properties": { |
| 2020 "alternateLink": { |
| 2021 "description": "URL that can be used to access the Drive ite
m.\n\nRead-only.", |
| 2022 "type": "string" |
| 2023 }, |
| 2024 "thumbnailUrl": { |
| 2025 "description": "URL of a thumbnail image of the Drive item.\
n\nRead-only.", |
| 2026 "type": "string" |
| 2027 }, |
| 2028 "id": { |
| 2029 "description": "Drive API resource ID.", |
| 2030 "type": "string" |
| 2031 }, |
| 2032 "title": { |
| 2033 "description": "Title of the Drive item.\n\nRead-only.", |
| 2034 "type": "string" |
| 2035 } |
| 2036 }, |
| 2037 "type": "object" |
| 2038 }, |
| 2039 "GlobalPermission": { |
| 2040 "description": "Global user permission description.", |
| 2041 "id": "GlobalPermission", |
| 2042 "properties": { |
| 2043 "permission": { |
| 2044 "description": "Permission value.", |
| 2045 "enum": [ |
| 2046 "PERMISSION_UNSPECIFIED", |
| 2047 "CREATE_COURSE" |
| 2048 ], |
| 2049 "enumDescriptions": [ |
| 2050 "No permission is specified. This is not returned and is
not a\nvalid value.", |
| 2051 "User is permitted to create a course." |
| 2052 ], |
| 2053 "type": "string" |
| 2054 } |
| 2055 }, |
| 2056 "type": "object" |
| 2057 }, |
| 2058 "ReturnStudentSubmissionRequest": { |
| 2059 "description": "Request to return a student submission.", |
| 2060 "id": "ReturnStudentSubmissionRequest", |
| 2061 "properties": {}, |
| 2062 "type": "object" |
| 2063 }, |
| 2064 "Teacher": { |
| 2065 "description": "Teacher of a course.", |
| 2066 "id": "Teacher", |
| 2067 "properties": { |
| 2068 "userId": { |
| 2069 "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", |
| 2070 "type": "string" |
| 2071 }, |
| 2072 "courseId": { |
| 2073 "description": "Identifier of the course.\n\nRead-only.", |
| 2074 "type": "string" |
| 2075 }, |
| 2076 "profile": { |
| 2077 "$ref": "UserProfile", |
| 2078 "description": "Global user information for the teacher.\n\n
Read-only." |
| 2079 } |
| 2080 }, |
| 2081 "type": "object" |
| 2082 }, |
1640 "ReclaimStudentSubmissionRequest": { | 2083 "ReclaimStudentSubmissionRequest": { |
1641 "description": "Request to reclaim a student submission.", | 2084 "description": "Request to reclaim a student submission.", |
1642 "id": "ReclaimStudentSubmissionRequest", | 2085 "id": "ReclaimStudentSubmissionRequest", |
1643 "properties": {}, | 2086 "properties": {}, |
1644 "type": "object" | 2087 "type": "object" |
1645 }, | 2088 }, |
1646 "GradeHistory": { | 2089 "GradeHistory": { |
1647 "description": "The history of each grade on this submission.", | 2090 "description": "The history of each grade on this submission.", |
1648 "id": "GradeHistory", | 2091 "id": "GradeHistory", |
1649 "properties": { | 2092 "properties": { |
(...skipping 46 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1696 }, | 2139 }, |
1697 "type": "array" | 2140 "type": "array" |
1698 } | 2141 } |
1699 }, | 2142 }, |
1700 "type": "object" | 2143 "type": "object" |
1701 }, | 2144 }, |
1702 "Material": { | 2145 "Material": { |
1703 "description": "Material attached to course work.\n\nWhen creating a
ttachments, setting the `form` field is not supported.", | 2146 "description": "Material attached to course work.\n\nWhen creating a
ttachments, setting the `form` field is not supported.", |
1704 "id": "Material", | 2147 "id": "Material", |
1705 "properties": { | 2148 "properties": { |
| 2149 "youtubeVideo": { |
| 2150 "$ref": "YouTubeVideo", |
| 2151 "description": "YouTube video material." |
| 2152 }, |
| 2153 "driveFile": { |
| 2154 "$ref": "SharedDriveFile", |
| 2155 "description": "Google Drive file material." |
| 2156 }, |
| 2157 "form": { |
| 2158 "$ref": "Form", |
| 2159 "description": "Google Forms material." |
| 2160 }, |
1706 "link": { | 2161 "link": { |
1707 "$ref": "Link", | 2162 "$ref": "Link", |
1708 "description": "Link material. On creation, will be upgraded
to a more appropriate type\nif possible, and this will be reflected in the resp
onse." | 2163 "description": "Link material. On creation, will be upgraded
to a more appropriate type\nif possible, and this will be reflected in the resp
onse." |
1709 }, | |
1710 "youtubeVideo": { | |
1711 "$ref": "YouTubeVideo", | |
1712 "description": "YouTube video material." | |
1713 }, | |
1714 "driveFile": { | |
1715 "$ref": "SharedDriveFile", | |
1716 "description": "Google Drive file material." | |
1717 }, | |
1718 "form": { | |
1719 "$ref": "Form", | |
1720 "description": "Google Forms material." | |
1721 } | 2164 } |
1722 }, | 2165 }, |
1723 "type": "object" | 2166 "type": "object" |
1724 }, | 2167 }, |
1725 "CourseWork": { | 2168 "CourseWork": { |
1726 "description": "Course work created by a teacher for students of the
course.", | 2169 "description": "Course work created by a teacher for students of the
course.", |
1727 "id": "CourseWork", | 2170 "id": "CourseWork", |
1728 "properties": { | 2171 "properties": { |
1729 "materials": { | |
1730 "description": "Additional materials.\n\nCourseWork must hav
e no more than 20 material items.", | |
1731 "items": { | |
1732 "$ref": "Material" | |
1733 }, | |
1734 "type": "array" | |
1735 }, | |
1736 "associatedWithDeveloper": { | |
1737 "description": "Whether this course work item is associated
with the Developer Console\nproject making the request.\n\nSee google.classroom.
Work.CreateCourseWork for more\ndetails.\n\nRead-only.", | |
1738 "type": "boolean" | |
1739 }, | |
1740 "updateTime": { | |
1741 "description": "Timestamp of the most recent change to this
course work.\n\nRead-only.", | |
1742 "format": "google-datetime", | |
1743 "type": "string" | |
1744 }, | |
1745 "alternateLink": { | |
1746 "description": "Absolute link to this course work in the Cla
ssroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only."
, | |
1747 "type": "string" | |
1748 }, | |
1749 "maxPoints": { | |
1750 "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.", | |
1751 "format": "double", | |
1752 "type": "number" | |
1753 }, | |
1754 "multipleChoiceQuestion": { | |
1755 "$ref": "MultipleChoiceQuestion", | |
1756 "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." | |
1757 }, | |
1758 "assignment": { | 2172 "assignment": { |
1759 "$ref": "Assignment", | 2173 "$ref": "Assignment", |
1760 "description": "Assignment details.\nThis is populated only
when `work_type` is `ASSIGNMENT`.\n\nRead-only." | 2174 "description": "Assignment details.\nThis is populated only
when `work_type` is `ASSIGNMENT`.\n\nRead-only." |
1761 }, | 2175 }, |
1762 "workType": { | 2176 "workType": { |
1763 "description": "Type of this course work.\n\nThe type is set
when the course work is created and cannot be changed.", | 2177 "description": "Type of this course work.\n\nThe type is set
when the course work is created and cannot be changed.", |
1764 "enum": [ | 2178 "enum": [ |
1765 "COURSE_WORK_TYPE_UNSPECIFIED", | 2179 "COURSE_WORK_TYPE_UNSPECIFIED", |
1766 "ASSIGNMENT", | 2180 "ASSIGNMENT", |
1767 "SHORT_ANSWER_QUESTION", | 2181 "SHORT_ANSWER_QUESTION", |
1768 "MULTIPLE_CHOICE_QUESTION" | 2182 "MULTIPLE_CHOICE_QUESTION" |
1769 ], | 2183 ], |
1770 "enumDescriptions": [ | 2184 "enumDescriptions": [ |
1771 "No work type specified. This is never returned.", | 2185 "No work type specified. This is never returned.", |
1772 "An assignment.", | 2186 "An assignment.", |
1773 "A short answer question.", | 2187 "A short answer question.", |
1774 "A multiple-choice question." | 2188 "A multiple-choice question." |
1775 ], | 2189 ], |
1776 "type": "string" | 2190 "type": "string" |
1777 }, | 2191 }, |
1778 "description": { | 2192 "multipleChoiceQuestion": { |
1779 "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.", | 2193 "$ref": "MultipleChoiceQuestion", |
1780 "type": "string" | 2194 "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." |
1781 }, | 2195 }, |
1782 "scheduledTime": { | 2196 "scheduledTime": { |
1783 "description": "Optional timestamp when this course work is
scheduled to be published.", | 2197 "description": "Optional timestamp when this course work is
scheduled to be published.", |
1784 "format": "google-datetime", | 2198 "format": "google-datetime", |
1785 "type": "string" | 2199 "type": "string" |
1786 }, | 2200 }, |
| 2201 "description": { |
| 2202 "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.", |
| 2203 "type": "string" |
| 2204 }, |
1787 "creationTime": { | 2205 "creationTime": { |
1788 "description": "Timestamp when this course work was created.
\n\nRead-only.", | 2206 "description": "Timestamp when this course work was created.
\n\nRead-only.", |
1789 "format": "google-datetime", | 2207 "format": "google-datetime", |
1790 "type": "string" | 2208 "type": "string" |
1791 }, | 2209 }, |
1792 "dueDate": { | 2210 "dueDate": { |
1793 "$ref": "Date", | 2211 "$ref": "Date", |
1794 "description": "Optional date, in UTC, that submissions for
this this course work are due.\nThis must be specified if `due_time` is specifie
d." | 2212 "description": "Optional date, in UTC, that submissions for
this this course work are due.\nThis must be specified if `due_time` is specifie
d." |
1795 }, | 2213 }, |
| 2214 "submissionModificationMode": { |
| 2215 "description": "Setting to determine when students are allow
ed to modify submissions.\nIf unspecified, the default value is `MODIFIABLE_UNTI
L_TURNED_IN`.", |
| 2216 "enum": [ |
| 2217 "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED", |
| 2218 "MODIFIABLE_UNTIL_TURNED_IN", |
| 2219 "MODIFIABLE" |
| 2220 ], |
| 2221 "enumDescriptions": [ |
| 2222 "No modification mode specified. This is never returned.
", |
| 2223 "Submisisons can be modified before being turned in.", |
| 2224 "Submisisons can be modified at any time." |
| 2225 ], |
| 2226 "type": "string" |
| 2227 }, |
1796 "state": { | 2228 "state": { |
1797 "description": "Status of this course work.\nIf unspecified,
the default state is `DRAFT`.", | 2229 "description": "Status of this course work.\nIf unspecified,
the default state is `DRAFT`.", |
1798 "enum": [ | 2230 "enum": [ |
1799 "COURSE_WORK_STATE_UNSPECIFIED", | 2231 "COURSE_WORK_STATE_UNSPECIFIED", |
1800 "PUBLISHED", | 2232 "PUBLISHED", |
1801 "DRAFT", | 2233 "DRAFT", |
1802 "DELETED" | 2234 "DELETED" |
1803 ], | 2235 ], |
1804 "enumDescriptions": [ | 2236 "enumDescriptions": [ |
1805 "No state specified. This is never returned.", | 2237 "No state specified. This is never returned.", |
1806 "Status for work that has been published.\nThis is the d
efault state.", | 2238 "Status for work that has been published.\nThis is the d
efault state.", |
1807 "Status for work that is not yet published.\nWork in thi
s state is visible only to course teachers and domain\nadministrators.", | 2239 "Status for work that is not yet published.\nWork in thi
s state is visible only to course teachers and domain\nadministrators.", |
1808 "Status for work that was published but is now deleted.\
nWork in this state is visible only to course teachers and domain\nadministrator
s.\nWork in this state is deleted after some time." | 2240 "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." |
1809 ], | 2241 ], |
1810 "type": "string" | 2242 "type": "string" |
1811 }, | 2243 }, |
1812 "submissionModificationMode": { | |
1813 "description": "Setting to determine when students are allow
ed to modify submissions.\nIf unspecified, the default value is `MODIFIABLE_UNTI
L_TURNED_IN`.", | |
1814 "enum": [ | |
1815 "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED", | |
1816 "MODIFIABLE_UNTIL_TURNED_IN", | |
1817 "MODIFIABLE" | |
1818 ], | |
1819 "enumDescriptions": [ | |
1820 "No modification mode specified. This is never returned.
", | |
1821 "Submisisons can be modified before being turned in.", | |
1822 "Submisisons can be modified at any time." | |
1823 ], | |
1824 "type": "string" | |
1825 }, | |
1826 "courseId": { | 2244 "courseId": { |
1827 "description": "Identifier of the course.\n\nRead-only.", | 2245 "description": "Identifier of the course.\n\nRead-only.", |
1828 "type": "string" | 2246 "type": "string" |
1829 }, | 2247 }, |
1830 "id": { | 2248 "id": { |
1831 "description": "Classroom-assigned identifier of this course
work, unique per course.\n\nRead-only.", | 2249 "description": "Classroom-assigned identifier of this course
work, unique per course.\n\nRead-only.", |
1832 "type": "string" | 2250 "type": "string" |
1833 }, | 2251 }, |
1834 "dueTime": { | 2252 "dueTime": { |
1835 "$ref": "TimeOfDay", | 2253 "$ref": "TimeOfDay", |
1836 "description": "Optional time of day, in UTC, that submissio
ns for this this course work\nare due.\nThis must be specified if `due_date` is
specified." | 2254 "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." |
1837 }, | 2255 }, |
1838 "title": { | 2256 "title": { |
1839 "description": "Title of this course work.\nThe title must b
e a valid UTF-8 string containing between 1 and 3000\ncharacters.", | 2257 "description": "Title of this course work.\nThe title must b
e a valid UTF-8 string containing between 1 and 3000\ncharacters.", |
1840 "type": "string" | 2258 "type": "string" |
| 2259 }, |
| 2260 "associatedWithDeveloper": { |
| 2261 "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.", |
| 2262 "type": "boolean" |
| 2263 }, |
| 2264 "materials": { |
| 2265 "description": "Additional materials.\n\nCourseWork must hav
e no more than 20 material items.", |
| 2266 "items": { |
| 2267 "$ref": "Material" |
| 2268 }, |
| 2269 "type": "array" |
| 2270 }, |
| 2271 "updateTime": { |
| 2272 "description": "Timestamp of the most recent change to this
course work.\n\nRead-only.", |
| 2273 "format": "google-datetime", |
| 2274 "type": "string" |
| 2275 }, |
| 2276 "alternateLink": { |
| 2277 "description": "Absolute link to this course work in the Cla
ssroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only."
, |
| 2278 "type": "string" |
| 2279 }, |
| 2280 "maxPoints": { |
| 2281 "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.", |
| 2282 "format": "double", |
| 2283 "type": "number" |
1841 } | 2284 } |
1842 }, | 2285 }, |
1843 "type": "object" | 2286 "type": "object" |
1844 }, | 2287 }, |
1845 "Guardian": { | 2288 "Guardian": { |
1846 "description": "Association between a student and a guardian of that
student. The guardian\nmay receive information about the student's course work.
", | 2289 "description": "Association between a student and a guardian of that
student. The guardian\nmay receive information about the student's course work.
", |
1847 "id": "Guardian", | 2290 "id": "Guardian", |
1848 "properties": { | 2291 "properties": { |
| 2292 "studentId": { |
| 2293 "description": "Identifier for the student to whom the guard
ian relationship applies.", |
| 2294 "type": "string" |
| 2295 }, |
| 2296 "invitedEmailAddress": { |
| 2297 "description": "The email address to which the initial guard
ian invitation was sent.\nThis field is only visible to domain administrators.", |
| 2298 "type": "string" |
| 2299 }, |
| 2300 "guardianId": { |
| 2301 "description": "Identifier for the guardian.", |
| 2302 "type": "string" |
| 2303 }, |
1849 "guardianProfile": { | 2304 "guardianProfile": { |
1850 "$ref": "UserProfile", | 2305 "$ref": "UserProfile", |
1851 "description": "User profile for the guardian." | 2306 "description": "User profile for the guardian." |
1852 }, | |
1853 "studentId": { | |
1854 "description": "Identifier for the student to whom the guard
ian relationship applies.", | |
1855 "type": "string" | |
1856 }, | |
1857 "invitedEmailAddress": { | |
1858 "description": "The email address to which the initial guard
ian invitation was sent.\nThis field is only visible to domain administrators.", | |
1859 "type": "string" | |
1860 }, | |
1861 "guardianId": { | |
1862 "description": "Identifier for the guardian.", | |
1863 "type": "string" | |
1864 } | 2307 } |
1865 }, | 2308 }, |
1866 "type": "object" | 2309 "type": "object" |
1867 }, | 2310 }, |
1868 "UserProfile": { | 2311 "UserProfile": { |
1869 "description": "Global information for a user.", | 2312 "description": "Global information for a user.", |
1870 "id": "UserProfile", | 2313 "id": "UserProfile", |
1871 "properties": { | 2314 "properties": { |
| 2315 "emailAddress": { |
| 2316 "description": "Email address of the user.\n\nRead-only.", |
| 2317 "type": "string" |
| 2318 }, |
| 2319 "permissions": { |
| 2320 "description": "Global permissions of the user.\n\nRead-only
.", |
| 2321 "items": { |
| 2322 "$ref": "GlobalPermission" |
| 2323 }, |
| 2324 "type": "array" |
| 2325 }, |
| 2326 "photoUrl": { |
| 2327 "description": "URL of user's profile photo.\n\nRead-only.", |
| 2328 "type": "string" |
| 2329 }, |
| 2330 "name": { |
| 2331 "$ref": "Name", |
| 2332 "description": "Name of the user.\n\nRead-only." |
| 2333 }, |
1872 "id": { | 2334 "id": { |
1873 "description": "Identifier of the user.\n\nRead-only.", | 2335 "description": "Identifier of the user.\n\nRead-only.", |
1874 "type": "string" | 2336 "type": "string" |
1875 }, | 2337 }, |
1876 "verifiedTeacher": { | 2338 "verifiedTeacher": { |
1877 "description": "Represents whether a G Suite for Education u
ser's domain administrator has\nexplicitly verified them as being a teacher. If
the user is not a member of\na G Suite for Education domain, than this field wil
l always be false.\n\nRead-only", | 2339 "description": "Represents whether a G Suite for Education u
ser's domain administrator has\nexplicitly verified them as being a teacher. If
the user is not a member of\na G Suite for Education domain, than this field wil
l always be false.\n\nRead-only", |
1878 "type": "boolean" | 2340 "type": "boolean" |
1879 }, | |
1880 "emailAddress": { | |
1881 "description": "Email address of the user.\n\nRead-only.", | |
1882 "type": "string" | |
1883 }, | |
1884 "photoUrl": { | |
1885 "description": "URL of user's profile photo.\n\nRead-only.", | |
1886 "type": "string" | |
1887 }, | |
1888 "permissions": { | |
1889 "description": "Global permissions of the user.\n\nRead-only
.", | |
1890 "items": { | |
1891 "$ref": "GlobalPermission" | |
1892 }, | |
1893 "type": "array" | |
1894 }, | |
1895 "name": { | |
1896 "$ref": "Name", | |
1897 "description": "Name of the user.\n\nRead-only." | |
1898 } | 2341 } |
1899 }, | 2342 }, |
1900 "type": "object" | 2343 "type": "object" |
1901 }, | 2344 }, |
1902 "ListStudentsResponse": { | 2345 "ListStudentsResponse": { |
1903 "description": "Response when listing students.", | 2346 "description": "Response when listing students.", |
1904 "id": "ListStudentsResponse", | 2347 "id": "ListStudentsResponse", |
1905 "properties": { | 2348 "properties": { |
1906 "nextPageToken": { | 2349 "nextPageToken": { |
1907 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | 2350 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
(...skipping 29 matching lines...) Expand all Loading... |
1937 "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 "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", |
1938 "type": "string" | 2381 "type": "string" |
1939 } | 2382 } |
1940 }, | 2383 }, |
1941 "type": "object" | 2384 "type": "object" |
1942 }, | 2385 }, |
1943 "Invitation": { | 2386 "Invitation": { |
1944 "description": "An invitation to join a course.", | 2387 "description": "An invitation to join a course.", |
1945 "id": "Invitation", | 2388 "id": "Invitation", |
1946 "properties": { | 2389 "properties": { |
1947 "courseId": { | |
1948 "description": "Identifier of the course to invite the user
to.", | |
1949 "type": "string" | |
1950 }, | |
1951 "id": { | 2390 "id": { |
1952 "description": "Identifier assigned by Classroom.\n\nRead-on
ly.", | 2391 "description": "Identifier assigned by Classroom.\n\nRead-on
ly.", |
1953 "type": "string" | 2392 "type": "string" |
1954 }, | 2393 }, |
1955 "role": { | 2394 "role": { |
1956 "description": "Role to invite the user to have.\nMust not b
e `COURSE_ROLE_UNSPECIFIED`.", | 2395 "description": "Role to invite the user to have.\nMust not b
e `COURSE_ROLE_UNSPECIFIED`.", |
1957 "enum": [ | 2396 "enum": [ |
1958 "COURSE_ROLE_UNSPECIFIED", | 2397 "COURSE_ROLE_UNSPECIFIED", |
1959 "STUDENT", | 2398 "STUDENT", |
1960 "TEACHER", | 2399 "TEACHER", |
1961 "OWNER" | 2400 "OWNER" |
1962 ], | 2401 ], |
1963 "enumDescriptions": [ | 2402 "enumDescriptions": [ |
1964 "No course role.", | 2403 "No course role.", |
1965 "Student in the course.", | 2404 "Student in the course.", |
1966 "Teacher of the course.", | 2405 "Teacher of the course.", |
1967 "Owner of the course." | 2406 "Owner of the course." |
1968 ], | 2407 ], |
1969 "type": "string" | 2408 "type": "string" |
1970 }, | 2409 }, |
1971 "userId": { | 2410 "userId": { |
1972 "description": "Identifier of the invited user.\n\nWhen spec
ified as a parameter of a request, this identifier can be set to\none of the fol
lowing:\n\n* the numeric identifier for the user\n* the email address of the use
r\n* the string literal `\"me\"`, indicating the requesting user", | 2411 "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", |
1973 "type": "string" | 2412 "type": "string" |
| 2413 }, |
| 2414 "courseId": { |
| 2415 "description": "Identifier of the course to invite the user
to.", |
| 2416 "type": "string" |
1974 } | 2417 } |
1975 }, | 2418 }, |
1976 "type": "object" | 2419 "type": "object" |
1977 }, | 2420 }, |
1978 "DriveFolder": { | 2421 "DriveFolder": { |
1979 "description": "Representation of a Google Drive folder.", | 2422 "description": "Representation of a Google Drive folder.", |
1980 "id": "DriveFolder", | 2423 "id": "DriveFolder", |
1981 "properties": { | 2424 "properties": { |
| 2425 "alternateLink": { |
| 2426 "description": "URL that can be used to access the Drive fol
der.\n\nRead-only.", |
| 2427 "type": "string" |
| 2428 }, |
| 2429 "id": { |
| 2430 "description": "Drive API resource ID.", |
| 2431 "type": "string" |
| 2432 }, |
1982 "title": { | 2433 "title": { |
1983 "description": "Title of the Drive folder.\n\nRead-only.", | 2434 "description": "Title of the Drive folder.\n\nRead-only.", |
1984 "type": "string" | 2435 "type": "string" |
1985 }, | |
1986 "alternateLink": { | |
1987 "description": "URL that can be used to access the Drive fol
der.\n\nRead-only.", | |
1988 "type": "string" | |
1989 }, | |
1990 "id": { | |
1991 "description": "Drive API resource ID.", | |
1992 "type": "string" | |
1993 } | 2436 } |
1994 }, | 2437 }, |
1995 "type": "object" | 2438 "type": "object" |
1996 }, | 2439 }, |
1997 "SubmissionHistory": { | 2440 "SubmissionHistory": { |
1998 "description": "The history of the submission. This currently includ
es state and grade\nhistories.", | 2441 "description": "The history of the submission. This currently includ
es state and grade\nhistories.", |
1999 "id": "SubmissionHistory", | 2442 "id": "SubmissionHistory", |
2000 "properties": { | 2443 "properties": { |
2001 "stateHistory": { | 2444 "stateHistory": { |
2002 "$ref": "StateHistory", | 2445 "$ref": "StateHistory", |
(...skipping 10 matching lines...) Expand all Loading... |
2013 "description": "Student work for a short answer question.", | 2456 "description": "Student work for a short answer question.", |
2014 "id": "ShortAnswerSubmission", | 2457 "id": "ShortAnswerSubmission", |
2015 "properties": { | 2458 "properties": { |
2016 "answer": { | 2459 "answer": { |
2017 "description": "Student response to a short-answer question.
", | 2460 "description": "Student response to a short-answer question.
", |
2018 "type": "string" | 2461 "type": "string" |
2019 } | 2462 } |
2020 }, | 2463 }, |
2021 "type": "object" | 2464 "type": "object" |
2022 }, | 2465 }, |
| 2466 "TurnInStudentSubmissionRequest": { |
| 2467 "description": "Request to turn in a student submission.", |
| 2468 "id": "TurnInStudentSubmissionRequest", |
| 2469 "properties": {}, |
| 2470 "type": "object" |
| 2471 }, |
| 2472 "ListStudentSubmissionsResponse": { |
| 2473 "description": "Response when listing student submissions.", |
| 2474 "id": "ListStudentSubmissionsResponse", |
| 2475 "properties": { |
| 2476 "nextPageToken": { |
| 2477 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
| 2478 "type": "string" |
| 2479 }, |
| 2480 "studentSubmissions": { |
| 2481 "description": "Student work that matches the request.", |
| 2482 "items": { |
| 2483 "$ref": "StudentSubmission" |
| 2484 }, |
| 2485 "type": "array" |
| 2486 } |
| 2487 }, |
| 2488 "type": "object" |
| 2489 }, |
2023 "StudentSubmission": { | 2490 "StudentSubmission": { |
2024 "description": "Student submission for course work.\n\nStudentSubmis
sion items are generated when a CourseWork item is created.\n\nStudentSubmission
s that have never been accessed (i.e. with `state` = NEW)\nmay not have a creati
on time or update time.", | 2491 "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.", |
2025 "id": "StudentSubmission", | 2492 "id": "StudentSubmission", |
2026 "properties": { | 2493 "properties": { |
| 2494 "assignmentSubmission": { |
| 2495 "$ref": "AssignmentSubmission", |
| 2496 "description": "Submission content when course_work_type is
ASSIGNMENT ." |
| 2497 }, |
2027 "shortAnswerSubmission": { | 2498 "shortAnswerSubmission": { |
2028 "$ref": "ShortAnswerSubmission", | 2499 "$ref": "ShortAnswerSubmission", |
2029 "description": "Submission content when course_work_type is
SHORT_ANSWER_QUESTION." | 2500 "description": "Submission content when course_work_type is
SHORT_ANSWER_QUESTION." |
2030 }, | 2501 }, |
2031 "associatedWithDeveloper": { | 2502 "associatedWithDeveloper": { |
2032 "description": "Whether this student submission is associate
d with the Developer Console\nproject making the request.\n\nSee google.classroo
m.Work.CreateCourseWork for more\ndetails.\n\nRead-only.", | 2503 "description": "Whether this student submission is associate
d with the Developer Console\nproject making the request.\n\nSee google.classroo
m.Work.CreateCourseWork for more\ndetails.\n\nRead-only.", |
2033 "type": "boolean" | 2504 "type": "boolean" |
2034 }, | 2505 }, |
2035 "updateTime": { | 2506 "updateTime": { |
2036 "description": "Last update time of this submission.\nThis m
ay be unset if the student has not accessed this item.\n\nRead-only.", | 2507 "description": "Last update time of this submission.\nThis m
ay be unset if the student has not accessed this item.\n\nRead-only.", |
2037 "format": "google-datetime", | 2508 "format": "google-datetime", |
2038 "type": "string" | 2509 "type": "string" |
2039 }, | 2510 }, |
2040 "alternateLink": { | 2511 "alternateLink": { |
2041 "description": "Absolute link to the submission in the Class
room web UI.\n\nRead-only.", | 2512 "description": "Absolute link to the submission in the Class
room web UI.\n\nRead-only.", |
2042 "type": "string" | 2513 "type": "string" |
2043 }, | 2514 }, |
| 2515 "late": { |
| 2516 "description": "Whether this submission is late.\n\nRead-onl
y.", |
| 2517 "type": "boolean" |
| 2518 }, |
2044 "draftGrade": { | 2519 "draftGrade": { |
2045 "description": "Optional pending grade. If unset, no grade w
as set.\nThis value must be non-negative. Decimal (i.e. non-integer) values are\
nallowed, but will be rounded to two decimal places.\n\nThis is only visible to
and modifiable by course teachers.", | 2520 "description": "Optional pending grade. If unset, no grade w
as set.\nThis value must be non-negative. Decimal (i.e. non-integer) values are\
nallowed, but will be rounded to two decimal places.\n\nThis is only visible to
and modifiable by course teachers.", |
2046 "format": "double", | 2521 "format": "double", |
2047 "type": "number" | 2522 "type": "number" |
2048 }, | 2523 }, |
2049 "late": { | |
2050 "description": "Whether this submission is late.\n\nRead-onl
y.", | |
2051 "type": "boolean" | |
2052 }, | |
2053 "courseWorkType": { | 2524 "courseWorkType": { |
2054 "description": "Type of course work this submission is for.\
n\nRead-only.", | 2525 "description": "Type of course work this submission is for.\
n\nRead-only.", |
2055 "enum": [ | 2526 "enum": [ |
2056 "COURSE_WORK_TYPE_UNSPECIFIED", | 2527 "COURSE_WORK_TYPE_UNSPECIFIED", |
2057 "ASSIGNMENT", | 2528 "ASSIGNMENT", |
2058 "SHORT_ANSWER_QUESTION", | 2529 "SHORT_ANSWER_QUESTION", |
2059 "MULTIPLE_CHOICE_QUESTION" | 2530 "MULTIPLE_CHOICE_QUESTION" |
2060 ], | 2531 ], |
2061 "enumDescriptions": [ | 2532 "enumDescriptions": [ |
2062 "No work type specified. This is never returned.", | 2533 "No work type specified. This is never returned.", |
(...skipping 52 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2115 "type": "array" | 2586 "type": "array" |
2116 }, | 2587 }, |
2117 "assignedGrade": { | 2588 "assignedGrade": { |
2118 "description": "Optional grade. If unset, no grade was set.\
nThis value must be non-negative. Decimal (i.e. non-integer) values are\nallowed
, but will be rounded to two decimal places.\n\nThis may be modified only by cou
rse teachers.", | 2589 "description": "Optional grade. If unset, no grade was set.\
nThis value must be non-negative. Decimal (i.e. non-integer) values are\nallowed
, but will be rounded to two decimal places.\n\nThis may be modified only by cou
rse teachers.", |
2119 "format": "double", | 2590 "format": "double", |
2120 "type": "number" | 2591 "type": "number" |
2121 }, | 2592 }, |
2122 "multipleChoiceSubmission": { | 2593 "multipleChoiceSubmission": { |
2123 "$ref": "MultipleChoiceSubmission", | 2594 "$ref": "MultipleChoiceSubmission", |
2124 "description": "Submission content when course_work_type is
MULTIPLE_CHOICE_QUESTION." | 2595 "description": "Submission content when course_work_type is
MULTIPLE_CHOICE_QUESTION." |
2125 }, | 2596 } |
2126 "assignmentSubmission": { | 2597 }, |
2127 "$ref": "AssignmentSubmission", | |
2128 "description": "Submission content when course_work_type is
ASSIGNMENT ." | |
2129 } | |
2130 }, | |
2131 "type": "object" | |
2132 }, | |
2133 "ListStudentSubmissionsResponse": { | |
2134 "description": "Response when listing student submissions.", | |
2135 "id": "ListStudentSubmissionsResponse", | |
2136 "properties": { | |
2137 "nextPageToken": { | |
2138 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | |
2139 "type": "string" | |
2140 }, | |
2141 "studentSubmissions": { | |
2142 "description": "Student work that matches the request.", | |
2143 "items": { | |
2144 "$ref": "StudentSubmission" | |
2145 }, | |
2146 "type": "array" | |
2147 } | |
2148 }, | |
2149 "type": "object" | |
2150 }, | |
2151 "TurnInStudentSubmissionRequest": { | |
2152 "description": "Request to turn in a student submission.", | |
2153 "id": "TurnInStudentSubmissionRequest", | |
2154 "properties": {}, | |
2155 "type": "object" | 2598 "type": "object" |
2156 }, | 2599 }, |
2157 "ListCourseWorkResponse": { | 2600 "ListCourseWorkResponse": { |
2158 "description": "Response when listing course work.", | 2601 "description": "Response when listing course work.", |
2159 "id": "ListCourseWorkResponse", | 2602 "id": "ListCourseWorkResponse", |
2160 "properties": { | 2603 "properties": { |
2161 "nextPageToken": { | 2604 "nextPageToken": { |
2162 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | 2605 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", |
2163 "type": "string" | 2606 "type": "string" |
2164 }, | 2607 }, |
(...skipping 82 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2247 "$ref": "Link", | 2690 "$ref": "Link", |
2248 "description": "Link attachment." | 2691 "description": "Link attachment." |
2249 } | 2692 } |
2250 }, | 2693 }, |
2251 "type": "object" | 2694 "type": "object" |
2252 }, | 2695 }, |
2253 "GuardianInvitation": { | 2696 "GuardianInvitation": { |
2254 "description": "An invitation to become the guardian of a specified
user, sent to a specified\nemail address.", | 2697 "description": "An invitation to become the guardian of a specified
user, sent to a specified\nemail address.", |
2255 "id": "GuardianInvitation", | 2698 "id": "GuardianInvitation", |
2256 "properties": { | 2699 "properties": { |
2257 "creationTime": { | |
2258 "description": "The time that this invitation was created.\n
\nRead-only.", | |
2259 "format": "google-datetime", | |
2260 "type": "string" | |
2261 }, | |
2262 "invitationId": { | |
2263 "description": "Unique identifier for this invitation.\n\nRe
ad-only.", | |
2264 "type": "string" | |
2265 }, | |
2266 "state": { | 2700 "state": { |
2267 "description": "The state that this invitation is in.", | 2701 "description": "The state that this invitation is in.", |
2268 "enum": [ | 2702 "enum": [ |
2269 "GUARDIAN_INVITATION_STATE_UNSPECIFIED", | 2703 "GUARDIAN_INVITATION_STATE_UNSPECIFIED", |
2270 "PENDING", | 2704 "PENDING", |
2271 "COMPLETE" | 2705 "COMPLETE" |
2272 ], | 2706 ], |
2273 "enumDescriptions": [ | 2707 "enumDescriptions": [ |
2274 "Should never be returned.", | 2708 "Should never be returned.", |
2275 "The invitation is active and awaiting a response.", | 2709 "The invitation is active and awaiting a response.", |
2276 "The invitation is no longer active. It may have been ac
cepted, declined,\nwithdrawn or it may have expired." | 2710 "The invitation is no longer active. It may have been ac
cepted, declined,\nwithdrawn or it may have expired." |
2277 ], | 2711 ], |
2278 "type": "string" | 2712 "type": "string" |
2279 }, | 2713 }, |
2280 "studentId": { | 2714 "studentId": { |
2281 "description": "ID of the student (in standard format)", | 2715 "description": "ID of the student (in standard format)", |
2282 "type": "string" | 2716 "type": "string" |
2283 }, | 2717 }, |
2284 "invitedEmailAddress": { | 2718 "invitedEmailAddress": { |
2285 "description": "Email address that the invitation was sent t
o.\nThis field is only visible to domain administrators.", | 2719 "description": "Email address that the invitation was sent t
o.\nThis field is only visible to domain administrators.", |
2286 "type": "string" | 2720 "type": "string" |
| 2721 }, |
| 2722 "creationTime": { |
| 2723 "description": "The time that this invitation was created.\n
\nRead-only.", |
| 2724 "format": "google-datetime", |
| 2725 "type": "string" |
| 2726 }, |
| 2727 "invitationId": { |
| 2728 "description": "Unique identifier for this invitation.\n\nRe
ad-only.", |
| 2729 "type": "string" |
2287 } | 2730 } |
2288 }, | 2731 }, |
2289 "type": "object" | 2732 "type": "object" |
2290 }, | 2733 }, |
2291 "StateHistory": { | 2734 "StateHistory": { |
2292 "description": "The history of each state this submission has been i
n.", | 2735 "description": "The history of each state this submission has been i
n.", |
2293 "id": "StateHistory", | 2736 "id": "StateHistory", |
2294 "properties": { | 2737 "properties": { |
2295 "state": { | 2738 "state": { |
2296 "description": "The workflow pipeline stage.", | 2739 "description": "The workflow pipeline stage.", |
(...skipping 42 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
2339 "description": "Title for this set.", | 2782 "description": "Title for this set.", |
2340 "type": "string" | 2783 "type": "string" |
2341 } | 2784 } |
2342 }, | 2785 }, |
2343 "type": "object" | 2786 "type": "object" |
2344 }, | 2787 }, |
2345 "TimeOfDay": { | 2788 "TimeOfDay": { |
2346 "description": "Represents a time of day. The date and time zone are
either not significant\nor are specified elsewhere. An API may choose to allow
leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp
`.", | 2789 "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
`.", |
2347 "id": "TimeOfDay", | 2790 "id": "TimeOfDay", |
2348 "properties": { | 2791 "properties": { |
| 2792 "seconds": { |
| 2793 "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.", |
| 2794 "format": "int32", |
| 2795 "type": "integer" |
| 2796 }, |
2349 "minutes": { | 2797 "minutes": { |
2350 "description": "Minutes of hour of day. Must be from 0 to 59
.", | 2798 "description": "Minutes of hour of day. Must be from 0 to 59
.", |
2351 "format": "int32", | 2799 "format": "int32", |
2352 "type": "integer" | 2800 "type": "integer" |
2353 }, | 2801 }, |
2354 "hours": { | 2802 "hours": { |
2355 "description": "Hours of day in 24 hour format. Should be fr
om 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios lik
e business closing time.", | 2803 "description": "Hours of day in 24 hour format. Should be fr
om 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios lik
e business closing time.", |
2356 "format": "int32", | 2804 "format": "int32", |
2357 "type": "integer" | 2805 "type": "integer" |
2358 }, | 2806 }, |
2359 "nanos": { | 2807 "nanos": { |
2360 "description": "Fractions of seconds in nanoseconds. Must be
from 0 to 999,999,999.", | 2808 "description": "Fractions of seconds in nanoseconds. Must be
from 0 to 999,999,999.", |
2361 "format": "int32", | 2809 "format": "int32", |
2362 "type": "integer" | 2810 "type": "integer" |
2363 }, | 2811 } |
2364 "seconds": { | 2812 }, |
2365 "description": "Seconds of minutes of the time. Must normall
y be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.", | 2813 "type": "object" |
2366 "format": "int32", | |
2367 "type": "integer" | |
2368 } | |
2369 }, | |
2370 "type": "object" | |
2371 }, | |
2372 "ListCoursesResponse": { | |
2373 "description": "Response when listing courses.", | |
2374 "id": "ListCoursesResponse", | |
2375 "properties": { | |
2376 "nextPageToken": { | |
2377 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | |
2378 "type": "string" | |
2379 }, | |
2380 "courses": { | |
2381 "description": "Courses that match the list request.", | |
2382 "items": { | |
2383 "$ref": "Course" | |
2384 }, | |
2385 "type": "array" | |
2386 } | |
2387 }, | |
2388 "type": "object" | |
2389 }, | |
2390 "Form": { | |
2391 "description": "Google Forms item.", | |
2392 "id": "Form", | |
2393 "properties": { | |
2394 "thumbnailUrl": { | |
2395 "description": "URL of a thumbnail image of the Form.\n\nRea
d-only.", | |
2396 "type": "string" | |
2397 }, | |
2398 "responseUrl": { | |
2399 "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.", | |
2400 "type": "string" | |
2401 }, | |
2402 "formUrl": { | |
2403 "description": "URL of the form.", | |
2404 "type": "string" | |
2405 }, | |
2406 "title": { | |
2407 "description": "Title of the Form.\n\nRead-only.", | |
2408 "type": "string" | |
2409 } | |
2410 }, | |
2411 "type": "object" | |
2412 }, | |
2413 "ListTeachersResponse": { | |
2414 "description": "Response when listing teachers.", | |
2415 "id": "ListTeachersResponse", | |
2416 "properties": { | |
2417 "nextPageToken": { | |
2418 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | |
2419 "type": "string" | |
2420 }, | |
2421 "teachers": { | |
2422 "description": "Teachers who match the list request.", | |
2423 "items": { | |
2424 "$ref": "Teacher" | |
2425 }, | |
2426 "type": "array" | |
2427 } | |
2428 }, | |
2429 "type": "object" | |
2430 }, | |
2431 "Link": { | |
2432 "description": "URL item.", | |
2433 "id": "Link", | |
2434 "properties": { | |
2435 "url": { | |
2436 "description": "URL to link to.\nThis must be a valid UTF-8
string containing between 1 and 2024 characters.", | |
2437 "type": "string" | |
2438 }, | |
2439 "title": { | |
2440 "description": "Title of the target of the URL.\n\nRead-only
.", | |
2441 "type": "string" | |
2442 }, | |
2443 "thumbnailUrl": { | |
2444 "description": "URL of a thumbnail image of the target URL.\
n\nRead-only.", | |
2445 "type": "string" | |
2446 } | |
2447 }, | |
2448 "type": "object" | |
2449 }, | |
2450 "ListGuardiansResponse": { | |
2451 "description": "Response when listing guardians.", | |
2452 "id": "ListGuardiansResponse", | |
2453 "properties": { | |
2454 "nextPageToken": { | |
2455 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | |
2456 "type": "string" | |
2457 }, | |
2458 "guardians": { | |
2459 "description": "Guardians on this page of results that met t
he criteria specified in\nthe request.", | |
2460 "items": { | |
2461 "$ref": "Guardian" | |
2462 }, | |
2463 "type": "array" | |
2464 } | |
2465 }, | |
2466 "type": "object" | |
2467 }, | |
2468 "ListGuardianInvitationsResponse": { | |
2469 "description": "Response when listing guardian invitations.", | |
2470 "id": "ListGuardianInvitationsResponse", | |
2471 "properties": { | |
2472 "guardianInvitations": { | |
2473 "description": "Guardian invitations that matched the list r
equest.", | |
2474 "items": { | |
2475 "$ref": "GuardianInvitation" | |
2476 }, | |
2477 "type": "array" | |
2478 }, | |
2479 "nextPageToken": { | |
2480 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | |
2481 "type": "string" | |
2482 } | |
2483 }, | |
2484 "type": "object" | |
2485 }, | |
2486 "ListCourseAliasesResponse": { | |
2487 "description": "Response when listing course aliases.", | |
2488 "id": "ListCourseAliasesResponse", | |
2489 "properties": { | |
2490 "aliases": { | |
2491 "description": "The course aliases.", | |
2492 "items": { | |
2493 "$ref": "CourseAlias" | |
2494 }, | |
2495 "type": "array" | |
2496 }, | |
2497 "nextPageToken": { | |
2498 "description": "Token identifying the next page of results t
o return. If empty, no further\nresults are available.", | |
2499 "type": "string" | |
2500 } | |
2501 }, | |
2502 "type": "object" | |
2503 }, | |
2504 "CourseAlias": { | |
2505 "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.", | |
2506 "id": "CourseAlias", | |
2507 "properties": { | |
2508 "alias": { | |
2509 "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.", | |
2510 "type": "string" | |
2511 } | |
2512 }, | |
2513 "type": "object" | |
2514 }, | |
2515 "Date": { | |
2516 "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`.", | |
2517 "id": "Date", | |
2518 "properties": { | |
2519 "day": { | |
2520 "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.", | |
2521 "format": "int32", | |
2522 "type": "integer" | |
2523 }, | |
2524 "year": { | |
2525 "description": "Year of date. Must be from 1 to 9999, or 0 i
f specifying a date without\na year.", | |
2526 "format": "int32", | |
2527 "type": "integer" | |
2528 }, | |
2529 "month": { | |
2530 "description": "Month of year. Must be from 1 to 12.", | |
2531 "format": "int32", | |
2532 "type": "integer" | |
2533 } | |
2534 }, | |
2535 "type": "object" | |
2536 }, | |
2537 "MultipleChoiceSubmission": { | |
2538 "description": "Student work for a multiple-choice question.", | |
2539 "id": "MultipleChoiceSubmission", | |
2540 "properties": { | |
2541 "answer": { | |
2542 "description": "Student's select choice.", | |
2543 "type": "string" | |
2544 } | |
2545 }, | |
2546 "type": "object" | |
2547 }, | |
2548 "Name": { | |
2549 "description": "Details of the user's name.", | |
2550 "id": "Name", | |
2551 "properties": { | |
2552 "fullName": { | |
2553 "description": "The user's full name formed by concatenating
the first and last name\nvalues.\n\nRead-only.", | |
2554 "type": "string" | |
2555 }, | |
2556 "familyName": { | |
2557 "description": "The user's last name.\n\nRead-only.", | |
2558 "type": "string" | |
2559 }, | |
2560 "givenName": { | |
2561 "description": "The user's first name.\n\nRead-only.", | |
2562 "type": "string" | |
2563 } | |
2564 }, | |
2565 "type": "object" | |
2566 }, | |
2567 "CourseMaterial": { | |
2568 "description": "A material attached to a course as part of a materia
l set.", | |
2569 "id": "CourseMaterial", | |
2570 "properties": { | |
2571 "youTubeVideo": { | |
2572 "$ref": "YouTubeVideo", | |
2573 "description": "Youtube video attachment." | |
2574 }, | |
2575 "driveFile": { | |
2576 "$ref": "DriveFile", | |
2577 "description": "Google Drive file attachment." | |
2578 }, | |
2579 "form": { | |
2580 "$ref": "Form", | |
2581 "description": "Google Forms attachment." | |
2582 }, | |
2583 "link": { | |
2584 "$ref": "Link", | |
2585 "description": "Link atatchment." | |
2586 } | |
2587 }, | |
2588 "type": "object" | |
2589 }, | |
2590 "Assignment": { | |
2591 "description": "Additional details for assignments.", | |
2592 "id": "Assignment", | |
2593 "properties": { | |
2594 "studentWorkFolder": { | |
2595 "$ref": "DriveFolder", | |
2596 "description": "Drive folder where attachments from student
submissions are placed.\nThis is only populated for course teachers and administ
rators." | |
2597 } | |
2598 }, | |
2599 "type": "object" | |
2600 }, | |
2601 "SharedDriveFile": { | |
2602 "description": "Drive file that is used as material for course work.
", | |
2603 "id": "SharedDriveFile", | |
2604 "properties": { | |
2605 "shareMode": { | |
2606 "description": "Mechanism by which students access the Drive
item.", | |
2607 "enum": [ | |
2608 "UNKNOWN_SHARE_MODE", | |
2609 "VIEW", | |
2610 "EDIT", | |
2611 "STUDENT_COPY" | |
2612 ], | |
2613 "enumDescriptions": [ | |
2614 "No sharing mode specified. This should never be returne
d.", | |
2615 "Students can view the shared file.", | |
2616 "Students can edit the shared file.", | |
2617 "Students have a personal copy of the shared file." | |
2618 ], | |
2619 "type": "string" | |
2620 }, | |
2621 "driveFile": { | |
2622 "$ref": "DriveFile", | |
2623 "description": "Drive file details." | |
2624 } | |
2625 }, | |
2626 "type": "object" | |
2627 }, | |
2628 "Empty": { | |
2629 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", | |
2630 "id": "Empty", | |
2631 "properties": {}, | |
2632 "type": "object" | |
2633 }, | |
2634 "MultipleChoiceQuestion": { | |
2635 "description": "Additional details for multiple-choice questions.", | |
2636 "id": "MultipleChoiceQuestion", | |
2637 "properties": { | |
2638 "choices": { | |
2639 "description": "Possible choices.", | |
2640 "items": { | |
2641 "type": "string" | |
2642 }, | |
2643 "type": "array" | |
2644 } | |
2645 }, | |
2646 "type": "object" | |
2647 }, | |
2648 "Course": { | |
2649 "description": "A Course in Classroom.", | |
2650 "id": "Course", | |
2651 "properties": { | |
2652 "courseGroupEmail": { | |
2653 "description": "The email address of a Google group containi
ng all members of the course.\nThis group does not accept email and can only be
used for permissions.\n\nRead-only.", | |
2654 "type": "string" | |
2655 }, | |
2656 "courseMaterialSets": { | |
2657 "description": "Sets of materials that appear on the \"about
\" page of this course.\n\nRead-only.", | |
2658 "items": { | |
2659 "$ref": "CourseMaterialSet" | |
2660 }, | |
2661 "type": "array" | |
2662 }, | |
2663 "enrollmentCode": { | |
2664 "description": "Enrollment code to use when joining this cou
rse.\nSpecifying this field in a course update mask results in an error.\n\nRead
-only.", | |
2665 "type": "string" | |
2666 }, | |
2667 "descriptionHeading": { | |
2668 "description": "Optional heading for the description.\nFor e
xample, \"Welcome to 10th Grade Biology.\"\nIf set, this field must be a valid U
TF-8 string and no longer than 3600\ncharacters.", | |
2669 "type": "string" | |
2670 }, | |
2671 "calendarId": { | |
2672 "description": "The Calendar ID for a calendar that all cour
se members can see, to which\nClassroom adds events for course work and announce
ments in the course.\n\nRead-only.", | |
2673 "type": "string" | |
2674 }, | |
2675 "updateTime": { | |
2676 "description": "Time of the most recent update to this cours
e.\nSpecifying this field in a course update mask results in an error.\n\nRead-o
nly.", | |
2677 "format": "google-datetime", | |
2678 "type": "string" | |
2679 }, | |
2680 "alternateLink": { | |
2681 "description": "Absolute link to this course in the Classroo
m web UI.\n\nRead-only.", | |
2682 "type": "string" | |
2683 }, | |
2684 "guardiansEnabled": { | |
2685 "description": "Whether or not guardian notifications are en
abled for this course.\n\nRead-only.", | |
2686 "type": "boolean" | |
2687 }, | |
2688 "ownerId": { | |
2689 "description": "The identifier of the owner of a course.\n\n
When specified as a parameter of a\ncreate course request, this\nfield is requir
ed.\nThe identifier can be one of the following:\n\n* the numeric identifier for
the user\n* the email address of the user\n* the string literal `\"me\"`, indic
ating the requesting user\n\nThis must be set in a create request. Admins can al
so specify this field\nin a patch course request to\ntransfer ownership. In othe
r contexts, it is read-only.", | |
2690 "type": "string" | |
2691 }, | |
2692 "courseState": { | |
2693 "description": "State of the course.\nIf unspecified, the de
fault state is `PROVISIONED`.", | |
2694 "enum": [ | |
2695 "COURSE_STATE_UNSPECIFIED", | |
2696 "ACTIVE", | |
2697 "ARCHIVED", | |
2698 "PROVISIONED", | |
2699 "DECLINED", | |
2700 "SUSPENDED" | |
2701 ], | |
2702 "enumDescriptions": [ | |
2703 "No course state. No returned Course message will use th
is value.", | |
2704 "The course is active.", | |
2705 "The course has been archived. You cannot modify it exce
pt to change it\nto a different state.", | |
2706 "The course has been created, but not yet activated. It
is accessible by\nthe primary teacher and domain administrators, who may modify
it or\nchange it to the `ACTIVE` or `DECLINED` states.\nA course may only be cha
nged to `PROVISIONED` if it is in the `DECLINED`\nstate.", | |
2707 "The course has been created, but declined. It is access
ible by the\ncourse owner and domain administrators, though it will not be\ndisp
layed in the web UI. You cannot modify the course except to change it\nto the `P
ROVISIONED` state.\nA course may only be changed to `DECLINED` if it is in the `
PROVISIONED`\nstate.", | |
2708 "The course has been suspended. You cannot modify the co
urse, and only the\nuser identified by the `owner_id` can view the course.\nA co
urse may be placed in this state if it potentially violates the\nTerms of Servic
e." | |
2709 ], | |
2710 "type": "string" | |
2711 }, | |
2712 "description": { | |
2713 "description": "Optional description.\nFor example, \"We'll
be learning about the structure of living\ncreatures from a combination of textb
ooks, guest lectures, and lab work.\nExpect to be excited!\"\nIf set, this field
must be a valid UTF-8 string and no longer than 30,000\ncharacters.", | |
2714 "type": "string" | |
2715 }, | |
2716 "teacherGroupEmail": { | |
2717 "description": "The email address of a Google group containi
ng all teachers of the course.\nThis group does not accept email and can only be
used for permissions.\n\nRead-only.", | |
2718 "type": "string" | |
2719 }, | |
2720 "creationTime": { | |
2721 "description": "Creation time of the course.\nSpecifying thi
s field in a course update mask results in an error.\n\nRead-only.", | |
2722 "format": "google-datetime", | |
2723 "type": "string" | |
2724 }, | |
2725 "teacherFolder": { | |
2726 "$ref": "DriveFolder", | |
2727 "description": "Information about a Drive Folder that is sha
red with all teachers of the\ncourse.\n\nThis field will only be set for teacher
s of the course and domain administrators.\n\nRead-only." | |
2728 }, | |
2729 "name": { | |
2730 "description": "Name of the course.\nFor example, \"10th Gra
de Biology\".\nThe name is required. It must be between 1 and 750 characters and
a valid\nUTF-8 string.", | |
2731 "type": "string" | |
2732 }, | |
2733 "section": { | |
2734 "description": "Section of the course.\nFor example, \"Perio
d 2\".\nIf set, this field must be a valid UTF-8 string and no longer than 2800\
ncharacters.", | |
2735 "type": "string" | |
2736 }, | |
2737 "id": { | |
2738 "description": "Identifier for this course assigned by Class
room.\n\nWhen\ncreating a course,\nyou may optionally set this identifier to an\
nalias string in the\nrequest to create a corresponding alias. The `id` is still
assigned by\nClassroom and cannot be updated after the course is created.\n\nSp
ecifying this field in a course update mask results in an error.", | |
2739 "type": "string" | |
2740 }, | |
2741 "room": { | |
2742 "description": "Optional room location.\nFor example, \"301\
".\nIf set, this field must be a valid UTF-8 string and no longer than 650\nchar
acters.", | |
2743 "type": "string" | |
2744 } | |
2745 }, | |
2746 "type": "object" | |
2747 }, | |
2748 "DriveFile": { | |
2749 "description": "Representation of a Google Drive file.", | |
2750 "id": "DriveFile", | |
2751 "properties": { | |
2752 "alternateLink": { | |
2753 "description": "URL that can be used to access the Drive ite
m.\n\nRead-only.", | |
2754 "type": "string" | |
2755 }, | |
2756 "thumbnailUrl": { | |
2757 "description": "URL of a thumbnail image of the Drive item.\
n\nRead-only.", | |
2758 "type": "string" | |
2759 }, | |
2760 "id": { | |
2761 "description": "Drive API resource ID.", | |
2762 "type": "string" | |
2763 }, | |
2764 "title": { | |
2765 "description": "Title of the Drive item.\n\nRead-only.", | |
2766 "type": "string" | |
2767 } | |
2768 }, | |
2769 "type": "object" | |
2770 }, | |
2771 "GlobalPermission": { | |
2772 "description": "Global user permission description.", | |
2773 "id": "GlobalPermission", | |
2774 "properties": { | |
2775 "permission": { | |
2776 "description": "Permission value.", | |
2777 "enum": [ | |
2778 "PERMISSION_UNSPECIFIED", | |
2779 "CREATE_COURSE" | |
2780 ], | |
2781 "enumDescriptions": [ | |
2782 "No permission is specified. This is not returned and is
not a\nvalid value.", | |
2783 "User is permitted to create a course." | |
2784 ], | |
2785 "type": "string" | |
2786 } | |
2787 }, | |
2788 "type": "object" | |
2789 }, | |
2790 "ReturnStudentSubmissionRequest": { | |
2791 "description": "Request to return a student submission.", | |
2792 "id": "ReturnStudentSubmissionRequest", | |
2793 "properties": {}, | |
2794 "type": "object" | |
2795 }, | |
2796 "Teacher": { | |
2797 "description": "Teacher of a course.", | |
2798 "id": "Teacher", | |
2799 "properties": { | |
2800 "profile": { | |
2801 "$ref": "UserProfile", | |
2802 "description": "Global user information for the teacher.\n\n
Read-only." | |
2803 }, | |
2804 "userId": { | |
2805 "description": "Identifier of the user.\n\nWhen specified as
a parameter of a request, this identifier can be one of\nthe following:\n\n* th
e numeric identifier for the user\n* the email address of the user\n* the string
literal `\"me\"`, indicating the requesting user", | |
2806 "type": "string" | |
2807 }, | |
2808 "courseId": { | |
2809 "description": "Identifier of the course.\n\nRead-only.", | |
2810 "type": "string" | |
2811 } | |
2812 }, | |
2813 "type": "object" | |
2814 } | 2814 } |
2815 }, | 2815 }, |
2816 "servicePath": "", | 2816 "servicePath": "", |
2817 "title": "Google Classroom API", | 2817 "title": "Google Classroom API", |
2818 "version": "v1" | 2818 "version": "v1" |
2819 } | 2819 } |
OLD | NEW |