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