Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 36e41bc9e5f0c6e6d5920ae4a5c9802ca63554e2 / . / docs / dyn / classroom_v1.courses.students.html
blob: 4c346d04c2b1a210c985c0fb6d092c2b6f708a80 [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">
78 <code><a href="#create">create(courseId, body, enrollmentCode=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]79<p class="firstline">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.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]80<p class="toc_element">
81 <code><a href="#delete">delete(courseId, userId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]82<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>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#get">get(courseId, userId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]85<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>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]86<p class="toc_element">
87 <code><a href="#list">list(courseId, pageSize=None, x__xgafv=None, pageToken=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]88<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>
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">
94 <code class="details" id="create">create(courseId, body, enrollmentCode=None, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]95 <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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]96
97Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]98 courseId: string, Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]99 body: object, The request body. (required)
100 The object takes the form of:
101
102{ # Student in a course.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]103 "courseId": "A String", # Identifier of the course. Read-only.
104 "profile": { # Global information for a user. # Global user information for the student. Read-only.
105 "permissions": [ # Global permissions of the user. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]106 { # Global user permission description.
107 "permission": "A String", # Permission value.
108 },
109 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]110 "photoUrl": "A String", # URL of user's profile photo. Read-only.
111 "emailAddress": "A String", # Email address of the user. Read-only.
112 "id": "A String", # Identifier of the user. Read-only.
113 "name": { # Details of the user's name. # Name of the user. Read-only.
114 "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
115 "givenName": "A String", # The user's first name. Read-only.
116 "familyName": "A String", # The user's last name. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]117 },
118 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]119 "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
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]120 }
121
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]122 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]123 x__xgafv: string, V1 error format.
124
125Returns:
126 An object of the form:
127
128 { # Student in a course.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]129 "courseId": "A String", # Identifier of the course. Read-only.
130 "profile": { # Global information for a user. # Global user information for the student. Read-only.
131 "permissions": [ # Global permissions of the user. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]132 { # Global user permission description.
133 "permission": "A String", # Permission value.
134 },
135 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]136 "photoUrl": "A String", # URL of user's profile photo. Read-only.
137 "emailAddress": "A String", # Email address of the user. Read-only.
138 "id": "A String", # Identifier of the user. Read-only.
139 "name": { # Details of the user's name. # Name of the user. Read-only.
140 "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
141 "givenName": "A String", # The user's first name. Read-only.
142 "familyName": "A String", # The user's last name. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]143 },
144 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]145 "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
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]146 }</pre>
147</div>
148
149<div class="method">
150 <code class="details" id="delete">delete(courseId, userId, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]151 <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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]152
153Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]154 courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
155 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)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]156 x__xgafv: string, V1 error format.
157
158Returns:
159 An object of the form:
160
161 { # 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 `{}`.
162 }</pre>
163</div>
164
165<div class="method">
166 <code class="details" id="get">get(courseId, userId, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]167 <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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]168
169Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]170 courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
171 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)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]172 x__xgafv: string, V1 error format.
173
174Returns:
175 An object of the form:
176
177 { # Student in a course.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]178 "courseId": "A String", # Identifier of the course. Read-only.
179 "profile": { # Global information for a user. # Global user information for the student. Read-only.
180 "permissions": [ # Global permissions of the user. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]181 { # Global user permission description.
182 "permission": "A String", # Permission value.
183 },
184 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]185 "photoUrl": "A String", # URL of user's profile photo. Read-only.
186 "emailAddress": "A String", # Email address of the user. Read-only.
187 "id": "A String", # Identifier of the user. Read-only.
188 "name": { # Details of the user's name. # Name of the user. Read-only.
189 "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
190 "givenName": "A String", # The user's first name. Read-only.
191 "familyName": "A String", # The user's last name. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]192 },
193 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]194 "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
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]195 }</pre>
196</div>
197
198<div class="method">
199 <code class="details" id="list">list(courseId, pageSize=None, x__xgafv=None, pageToken=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]200 <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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]201
202Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]203 courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]204 pageSize: integer, Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.
205 x__xgafv: string, V1 error format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]206 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.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]207
208Returns:
209 An object of the form:
210
211 { # Response when listing students.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]212 "students": [ # Students who match the list request.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]213 { # Student in a course.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]214 "courseId": "A String", # Identifier of the course. Read-only.
215 "profile": { # Global information for a user. # Global user information for the student. Read-only.
216 "permissions": [ # Global permissions of the user. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]217 { # Global user permission description.
218 "permission": "A String", # Permission value.
219 },
220 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]221 "photoUrl": "A String", # URL of user's profile photo. Read-only.
222 "emailAddress": "A String", # Email address of the user. Read-only.
223 "id": "A String", # Identifier of the user. Read-only.
224 "name": { # Details of the user's name. # Name of the user. Read-only.
225 "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only.
226 "givenName": "A String", # The user's first name. Read-only.
227 "familyName": "A String", # The user's last name. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]228 },
229 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]230 "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
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]231 },
232 ],
233 "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available.
234 }</pre>
235</div>
236
237<div class="method">
238 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
239 <pre>Retrieves the next page of results.
240
241Args:
242 previous_request: The request for the previous page. (required)
243 previous_response: The response from the request for the previous page. (required)
244
245Returns:
246 A request object that you can call 'execute()' on to request the next
247 page. Returns None if there are no more items in the collection.
248 </pre>
249</div>
250
251</body></html>