1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="classroom_v1.html">Google Classroom API</a> . <a href="classroom_v1.courses.html">courses</a> . <a href="classroom_v1.courses.students.html">students</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(courseId, body, enrollmentCode=None, x__xgafv=None)</a></code></p>
<p class="firstline">Adds a user as a student of a course.</p>
<p class="toc_element">
<code><a href="#delete">delete(courseId, userId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a student of a course.</p>
<p class="toc_element">
<code><a href="#get">get(courseId, userId, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a student of a course.</p>
<p class="toc_element">
<code><a href="#list">list(courseId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a list of students of this course that the requester</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(courseId, body, enrollmentCode=None, x__xgafv=None)</code>
<pre>Adds a user as a student of a course.
This method returns the following error codes:
* `PERMISSION_DENIED` if the requesting user is not permitted to create
students in this course or for access errors.
* `NOT_FOUND` if the requested course ID does not exist.
* `FAILED_PRECONDITION` if the requested user's account is disabled,
for the following request errors:
* CourseMemberLimitReached
* CourseNotModifiable
* UserGroupsMembershipLimitReached
* `ALREADY_EXISTS` if the user is already a student or teacher in the
course.
Args:
courseId: string, Identifier of the course to create the student in.
This identifier can be either the Classroom-assigned identifier or an
alias. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Student in a course.
"profile": { # Global information for a user. # Global user information for the student.
#
# Read-only.
"name": { # Details of the user's name. # Name of the user.
#
# Read-only.
"fullName": "A String", # The user's full name formed by concatenating the first and last name
# values.
#
# Read-only.
"givenName": "A String", # The user's first name.
#
# Read-only.
"familyName": "A String", # The user's last name.
#
# Read-only.
},
"photoUrl": "A String", # URL of user's profile photo.
#
# Read-only.
"emailAddress": "A String", # Email address of the user.
#
# Read-only.
"verifiedTeacher": True or False, # Represents whether a G Suite for Education user's domain administrator has
# explicitly verified them as being a teacher. If the user is not a member of
# a G Suite for Education domain, than this field will always be false.
#
# Read-only
"id": "A String", # Identifier of the user.
#
# Read-only.
"permissions": [ # Global permissions of the user.
#
# Read-only.
{ # Global user permission description.
"permission": "A String", # Permission value.
},
],
},
"courseId": "A String", # Identifier of the course.
#
# Read-only.
"studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course.
# Only visible to the student and domain administrators.
#
# Read-only.
"alternateLink": "A String", # URL that can be used to access the Drive folder.
#
# Read-only.
"id": "A String", # Drive API resource ID.
"title": "A String", # Title of the Drive folder.
#
# Read-only.
},
"userId": "A String", # Identifier of the user.
#
# When specified as a parameter of a request, this identifier can be one of
# the following:
#
# * the numeric identifier for the user
# * the email address of the user
# * the string literal `"me"`, indicating the requesting user
}
enrollmentCode: string, Enrollment code of the course to create the student in.
This code is required if userId
corresponds to the requesting user; it may be omitted if the requesting
user has administrative permissions to create students for any user.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Student in a course.
"profile": { # Global information for a user. # Global user information for the student.
#
# Read-only.
"name": { # Details of the user's name. # Name of the user.
#
# Read-only.
"fullName": "A String", # The user's full name formed by concatenating the first and last name
# values.
#
# Read-only.
"givenName": "A String", # The user's first name.
#
# Read-only.
"familyName": "A String", # The user's last name.
#
# Read-only.
},
"photoUrl": "A String", # URL of user's profile photo.
#
# Read-only.
"emailAddress": "A String", # Email address of the user.
#
# Read-only.
"verifiedTeacher": True or False, # Represents whether a G Suite for Education user's domain administrator has
# explicitly verified them as being a teacher. If the user is not a member of
# a G Suite for Education domain, than this field will always be false.
#
# Read-only
"id": "A String", # Identifier of the user.
#
# Read-only.
"permissions": [ # Global permissions of the user.
#
# Read-only.
{ # Global user permission description.
"permission": "A String", # Permission value.
},
],
},
"courseId": "A String", # Identifier of the course.
#
# Read-only.
"studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course.
# Only visible to the student and domain administrators.
#
# Read-only.
"alternateLink": "A String", # URL that can be used to access the Drive folder.
#
# Read-only.
"id": "A String", # Drive API resource ID.
"title": "A String", # Title of the Drive folder.
#
# Read-only.
},
"userId": "A String", # Identifier of the user.
#
# When specified as a parameter of a request, this identifier can be one of
# the following:
#
# * the numeric identifier for the user
# * the email address of the user
# * the string literal `"me"`, indicating the requesting user
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(courseId, userId, x__xgafv=None)</code>
<pre>Deletes a student of a course.
This method returns the following error codes:
* `PERMISSION_DENIED` if the requesting user is not permitted to delete
students of this course or for access errors.
* `NOT_FOUND` if no student of this course has the requested ID or if the
course does not exist.
Args:
courseId: string, Identifier of the course.
This identifier can be either the Classroom-assigned identifier or an
alias. (required)
userId: string, Identifier of the student to delete. The identifier can be one of the
following:
* the numeric identifier for the user
* the email address of the user
* the string literal `"me"`, indicating the requesting user (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
#
# service Foo {
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(courseId, userId, x__xgafv=None)</code>
<pre>Returns a student of a course.
This method returns the following error codes:
* `PERMISSION_DENIED` if the requesting user is not permitted to view
students of this course or for access errors.
* `NOT_FOUND` if no student of this course has the requested ID or if the
course does not exist.
Args:
courseId: string, Identifier of the course.
This identifier can be either the Classroom-assigned identifier or an
alias. (required)
userId: string, Identifier of the student to return. The identifier can be one of the
following:
* the numeric identifier for the user
* the email address of the user
* the string literal `"me"`, indicating the requesting user (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Student in a course.
"profile": { # Global information for a user. # Global user information for the student.
#
# Read-only.
"name": { # Details of the user's name. # Name of the user.
#
# Read-only.
"fullName": "A String", # The user's full name formed by concatenating the first and last name
# values.
#
# Read-only.
"givenName": "A String", # The user's first name.
#
# Read-only.
"familyName": "A String", # The user's last name.
#
# Read-only.
},
"photoUrl": "A String", # URL of user's profile photo.
#
# Read-only.
"emailAddress": "A String", # Email address of the user.
#
# Read-only.
"verifiedTeacher": True or False, # Represents whether a G Suite for Education user's domain administrator has
# explicitly verified them as being a teacher. If the user is not a member of
# a G Suite for Education domain, than this field will always be false.
#
# Read-only
"id": "A String", # Identifier of the user.
#
# Read-only.
"permissions": [ # Global permissions of the user.
#
# Read-only.
{ # Global user permission description.
"permission": "A String", # Permission value.
},
],
},
"courseId": "A String", # Identifier of the course.
#
# Read-only.
"studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course.
# Only visible to the student and domain administrators.
#
# Read-only.
"alternateLink": "A String", # URL that can be used to access the Drive folder.
#
# Read-only.
"id": "A String", # Drive API resource ID.
"title": "A String", # Title of the Drive folder.
#
# Read-only.
},
"userId": "A String", # Identifier of the user.
#
# When specified as a parameter of a request, this identifier can be one of
# the following:
#
# * the numeric identifier for the user
# * the email address of the user
# * the string literal `"me"`, indicating the requesting user
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(courseId, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Returns a list of students of this course that the requester
is permitted to view.
This method returns the following error codes:
* `NOT_FOUND` if the course does not exist.
* `PERMISSION_DENIED` for access errors.
Args:
courseId: string, Identifier of the course.
This identifier can be either the Classroom-assigned identifier or an
alias. (required)
pageSize: integer, Maximum number of items to return. Zero means no maximum.
The server may return fewer than the specified number of results.
pageToken: string, nextPageToken
value returned from a previous
list call, indicating that
the subsequent page of results should be returned.
The list request must be
otherwise identical to the one that resulted in this token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response when listing students.
"students": [ # Students who match the list request.
{ # Student in a course.
"profile": { # Global information for a user. # Global user information for the student.
#
# Read-only.
"name": { # Details of the user's name. # Name of the user.
#
# Read-only.
"fullName": "A String", # The user's full name formed by concatenating the first and last name
# values.
#
# Read-only.
"givenName": "A String", # The user's first name.
#
# Read-only.
"familyName": "A String", # The user's last name.
#
# Read-only.
},
"photoUrl": "A String", # URL of user's profile photo.
#
# Read-only.
"emailAddress": "A String", # Email address of the user.
#
# Read-only.
"verifiedTeacher": True or False, # Represents whether a G Suite for Education user's domain administrator has
# explicitly verified them as being a teacher. If the user is not a member of
# a G Suite for Education domain, than this field will always be false.
#
# Read-only
"id": "A String", # Identifier of the user.
#
# Read-only.
"permissions": [ # Global permissions of the user.
#
# Read-only.
{ # Global user permission description.
"permission": "A String", # Permission value.
},
],
},
"courseId": "A String", # Identifier of the course.
#
# Read-only.
"studentWorkFolder": { # Representation of a Google Drive folder. # Information about a Drive Folder for this student's work in this course.
# Only visible to the student and domain administrators.
#
# Read-only.
"alternateLink": "A String", # URL that can be used to access the Drive folder.
#
# Read-only.
"id": "A String", # Drive API resource ID.
"title": "A String", # Title of the Drive folder.
#
# Read-only.
},
"userId": "A String", # Identifier of the user.
#
# When specified as a parameter of a request, this identifier can be one of
# the following:
#
# * the numeric identifier for the user
# * the email address of the user
# * the string literal `"me"`, indicating the requesting user
},
],
"nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further
# results are available.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
