Debian Codegraph @

docs/dyn/classroom_v1.courses.students.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#create">create(courseId, body=None, enrollmentCode=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Adds a user as a student of a course. Domain administrators are permitted to [directly add](https://developers.google.com/workspace/classroom/guides/manage-users) users within their domain as students to courses within their domain. Students are permitted to add themselves to a course using an enrollment code. 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 * InactiveCourseOwner * `ALREADY_EXISTS` if the user is already a student or teacher in the course.</p>
83 <p class="toc_element">
84 <code><a href="#delete">delete(courseId, userId, x__xgafv=None)</a></code></p>
85 <p class="firstline">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.</p>
86 <p class="toc_element">
87 <code><a href="#get">get(courseId, userId, x__xgafv=None)</a></code></p>
88 <p class="firstline">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.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(courseId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">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.</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <h3>Method Details</h3>
96 <div class="method">
97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99 </div>
100
101 <div class="method">
102 <code class="details" id="create">create(courseId, body=None, enrollmentCode=None, x__xgafv=None)</code>
103 <pre>Adds a user as a student of a course. Domain administrators are permitted to [directly add](https://developers.google.com/workspace/classroom/guides/manage-users) users within their domain as students to courses within their domain. Students are permitted to add themselves to a course using an enrollment code. 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&#x27;s account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * InactiveCourseOwner * `ALREADY_EXISTS` if the user is already a student or teacher in the course.
104
105 Args:
106 courseId: string, Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias. (required)
107 body: object, The request body.
108 The object takes the form of:
109
110 { # Student in a course.
111 &quot;courseId&quot;: &quot;A String&quot;, # Identifier of the course. Read-only.
112 &quot;profile&quot;: { # Global information for a user. # Global user information for the student. Read-only.
113 &quot;emailAddress&quot;: &quot;A String&quot;, # Email address of the user. Must request `https://www.googleapis.com/auth/classroom.profile.emails` scope for this field to be populated in a response body. Read-only.
114 &quot;id&quot;: &quot;A String&quot;, # Identifier of the user. Read-only.
115 &quot;name&quot;: { # Details of the user&#x27;s name. # Name of the user. Read-only.
116 &quot;familyName&quot;: &quot;A String&quot;, # The user&#x27;s last name. Read-only.
117 &quot;fullName&quot;: &quot;A String&quot;, # The user&#x27;s full name formed by concatenating the first and last name values. Read-only.
118 &quot;givenName&quot;: &quot;A String&quot;, # The user&#x27;s first name. Read-only.
119 },
120 &quot;permissions&quot;: [ # Global permissions of the user. Read-only.
121 { # Global user permission description.
122 &quot;permission&quot;: &quot;A String&quot;, # Permission value.
123 },
124 ],
125 &quot;photoUrl&quot;: &quot;A String&quot;, # URL of user&#x27;s profile photo. Must request `https://www.googleapis.com/auth/classroom.profile.photos` scope for this field to be populated in a response body. Read-only.
126 &quot;verifiedTeacher&quot;: True or False, # Represents whether a Google Workspace for Education user&#x27;s domain administrator has explicitly verified them as being a teacher. This field is always false if the user is not a member of a Google Workspace for Education domain. Read-only
127 },
128 &quot;studentWorkFolder&quot;: { # Representation of a Google Drive folder. # Information about a Drive Folder for this student&#x27;s work in this course. Only visible to the student and domain administrators. Read-only.
129 &quot;alternateLink&quot;: &quot;A String&quot;, # URL that can be used to access the Drive folder. Read-only.
130 &quot;id&quot;: &quot;A String&quot;, # Drive API resource ID.
131 &quot;title&quot;: &quot;A String&quot;, # Title of the Drive folder. Read-only.
132 },
133 &quot;userId&quot;: &quot;A String&quot;, # 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 `&quot;me&quot;`, indicating the requesting user
134 }
135
136 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.
137 x__xgafv: string, V1 error format.
138 Allowed values
139 1 - v1 error format
140 2 - v2 error format
141
142 Returns:
143 An object of the form:
144
145 { # Student in a course.
146 &quot;courseId&quot;: &quot;A String&quot;, # Identifier of the course. Read-only.
147 &quot;profile&quot;: { # Global information for a user. # Global user information for the student. Read-only.
148 &quot;emailAddress&quot;: &quot;A String&quot;, # Email address of the user. Must request `https://www.googleapis.com/auth/classroom.profile.emails` scope for this field to be populated in a response body. Read-only.
149 &quot;id&quot;: &quot;A String&quot;, # Identifier of the user. Read-only.
150 &quot;name&quot;: { # Details of the user&#x27;s name. # Name of the user. Read-only.
151 &quot;familyName&quot;: &quot;A String&quot;, # The user&#x27;s last name. Read-only.
152 &quot;fullName&quot;: &quot;A String&quot;, # The user&#x27;s full name formed by concatenating the first and last name values. Read-only.
153 &quot;givenName&quot;: &quot;A String&quot;, # The user&#x27;s first name. Read-only.
154 },
155 &quot;permissions&quot;: [ # Global permissions of the user. Read-only.
156 { # Global user permission description.
157 &quot;permission&quot;: &quot;A String&quot;, # Permission value.
158 },
159 ],
160 &quot;photoUrl&quot;: &quot;A String&quot;, # URL of user&#x27;s profile photo. Must request `https://www.googleapis.com/auth/classroom.profile.photos` scope for this field to be populated in a response body. Read-only.
161 &quot;verifiedTeacher&quot;: True or False, # Represents whether a Google Workspace for Education user&#x27;s domain administrator has explicitly verified them as being a teacher. This field is always false if the user is not a member of a Google Workspace for Education domain. Read-only
162 },
163 &quot;studentWorkFolder&quot;: { # Representation of a Google Drive folder. # Information about a Drive Folder for this student&#x27;s work in this course. Only visible to the student and domain administrators. Read-only.
164 &quot;alternateLink&quot;: &quot;A String&quot;, # URL that can be used to access the Drive folder. Read-only.
165 &quot;id&quot;: &quot;A String&quot;, # Drive API resource ID.
166 &quot;title&quot;: &quot;A String&quot;, # Title of the Drive folder. Read-only.
167 },
168 &quot;userId&quot;: &quot;A String&quot;, # 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 `&quot;me&quot;`, indicating the requesting user
169 }</pre>
170 </div>
171
172 <div class="method">
173 <code class="details" id="delete">delete(courseId, userId, x__xgafv=None)</code>
174 <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.
175
176 Args:
177 courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
178 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 `&quot;me&quot;`, indicating the requesting user (required)
179 x__xgafv: string, V1 error format.
180 Allowed values
181 1 - v1 error format
182 2 - v2 error format
183
184 Returns:
185 An object of the form:
186
187 { # 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); }
188 }</pre>
189 </div>
190
191 <div class="method">
192 <code class="details" id="get">get(courseId, userId, x__xgafv=None)</code>
193 <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.
194
195 Args:
196 courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
197 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 `&quot;me&quot;`, indicating the requesting user (required)
198 x__xgafv: string, V1 error format.
199 Allowed values
200 1 - v1 error format
201 2 - v2 error format
202
203 Returns:
204 An object of the form:
205
206 { # Student in a course.
207 &quot;courseId&quot;: &quot;A String&quot;, # Identifier of the course. Read-only.
208 &quot;profile&quot;: { # Global information for a user. # Global user information for the student. Read-only.
209 &quot;emailAddress&quot;: &quot;A String&quot;, # Email address of the user. Must request `https://www.googleapis.com/auth/classroom.profile.emails` scope for this field to be populated in a response body. Read-only.
210 &quot;id&quot;: &quot;A String&quot;, # Identifier of the user. Read-only.
211 &quot;name&quot;: { # Details of the user&#x27;s name. # Name of the user. Read-only.
212 &quot;familyName&quot;: &quot;A String&quot;, # The user&#x27;s last name. Read-only.
213 &quot;fullName&quot;: &quot;A String&quot;, # The user&#x27;s full name formed by concatenating the first and last name values. Read-only.
214 &quot;givenName&quot;: &quot;A String&quot;, # The user&#x27;s first name. Read-only.
215 },
216 &quot;permissions&quot;: [ # Global permissions of the user. Read-only.
217 { # Global user permission description.
218 &quot;permission&quot;: &quot;A String&quot;, # Permission value.
219 },
220 ],
221 &quot;photoUrl&quot;: &quot;A String&quot;, # URL of user&#x27;s profile photo. Must request `https://www.googleapis.com/auth/classroom.profile.photos` scope for this field to be populated in a response body. Read-only.
222 &quot;verifiedTeacher&quot;: True or False, # Represents whether a Google Workspace for Education user&#x27;s domain administrator has explicitly verified them as being a teacher. This field is always false if the user is not a member of a Google Workspace for Education domain. Read-only
223 },
224 &quot;studentWorkFolder&quot;: { # Representation of a Google Drive folder. # Information about a Drive Folder for this student&#x27;s work in this course. Only visible to the student and domain administrators. Read-only.
225 &quot;alternateLink&quot;: &quot;A String&quot;, # URL that can be used to access the Drive folder. Read-only.
226 &quot;id&quot;: &quot;A String&quot;, # Drive API resource ID.
227 &quot;title&quot;: &quot;A String&quot;, # Title of the Drive folder. Read-only.
228 },
229 &quot;userId&quot;: &quot;A String&quot;, # 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 `&quot;me&quot;`, indicating the requesting user
230 }</pre>
231 </div>
232
233 <div class="method">
234 <code class="details" id="list">list(courseId, pageSize=None, pageToken=None, x__xgafv=None)</code>
235 <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.
236
237 Args:
238 courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
239 pageSize: integer, Maximum number of items to return. The default is 30 if unspecified or `0`. The server may return fewer than the specified number of results.
240 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.
241 x__xgafv: string, V1 error format.
242 Allowed values
243 1 - v1 error format
244 2 - v2 error format
245
246 Returns:
247 An object of the form:
248
249 { # Response when listing students.
250 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token identifying the next page of results to return. If empty, no further results are available.
251 &quot;students&quot;: [ # Students who match the list request.
252 { # Student in a course.
253 &quot;courseId&quot;: &quot;A String&quot;, # Identifier of the course. Read-only.
254 &quot;profile&quot;: { # Global information for a user. # Global user information for the student. Read-only.
255 &quot;emailAddress&quot;: &quot;A String&quot;, # Email address of the user. Must request `https://www.googleapis.com/auth/classroom.profile.emails` scope for this field to be populated in a response body. Read-only.
256 &quot;id&quot;: &quot;A String&quot;, # Identifier of the user. Read-only.
257 &quot;name&quot;: { # Details of the user&#x27;s name. # Name of the user. Read-only.
258 &quot;familyName&quot;: &quot;A String&quot;, # The user&#x27;s last name. Read-only.
259 &quot;fullName&quot;: &quot;A String&quot;, # The user&#x27;s full name formed by concatenating the first and last name values. Read-only.
260 &quot;givenName&quot;: &quot;A String&quot;, # The user&#x27;s first name. Read-only.
261 },
262 &quot;permissions&quot;: [ # Global permissions of the user. Read-only.
263 { # Global user permission description.
264 &quot;permission&quot;: &quot;A String&quot;, # Permission value.
265 },
266 ],
267 &quot;photoUrl&quot;: &quot;A String&quot;, # URL of user&#x27;s profile photo. Must request `https://www.googleapis.com/auth/classroom.profile.photos` scope for this field to be populated in a response body. Read-only.
268 &quot;verifiedTeacher&quot;: True or False, # Represents whether a Google Workspace for Education user&#x27;s domain administrator has explicitly verified them as being a teacher. This field is always false if the user is not a member of a Google Workspace for Education domain. Read-only
269 },
270 &quot;studentWorkFolder&quot;: { # Representation of a Google Drive folder. # Information about a Drive Folder for this student&#x27;s work in this course. Only visible to the student and domain administrators. Read-only.
271 &quot;alternateLink&quot;: &quot;A String&quot;, # URL that can be used to access the Drive folder. Read-only.
272 &quot;id&quot;: &quot;A String&quot;, # Drive API resource ID.
273 &quot;title&quot;: &quot;A String&quot;, # Title of the Drive folder. Read-only.
274 },
275 &quot;userId&quot;: &quot;A String&quot;, # 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 `&quot;me&quot;`, indicating the requesting user
276 },
277 ],
278 }</pre>
279 </div>
280
281 <div class="method">
282 <code class="details" id="list_next">list_next()</code>
283 <pre>Retrieves the next page of results.
284
285 Args:
286 previous_request: The request for the previous page. (required)
287 previous_response: The response from the request for the previous page. (required)
288
289 Returns:
290 A request object that you can call &#x27;execute()&#x27; on to request the next
291 page. Returns None if there are no more items in the collection.
292 </pre>
293 </div>
294
295 </body></html>