blob: 8df8df1304b229559877d2ea7c6c2fec81f7b0e1 [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -07001<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.teachers.html">teachers</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070081 <code><a href="#create">create(courseId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070082<p class="firstline">Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers 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 * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teacher or student in the course.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -070083<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -070084 <code><a href="#delete">delete(courseId, userId, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085<p class="firstline">Deletes a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -070086<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -070087 <code><a href="#get">get(courseId, userId, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088<p class="firstline">Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -070089<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070090 <code><a href="#list">list(courseId, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Returns a list of teachers 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 -070092<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<h3>Method Details</h3>
96<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070097 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99</div>
100
101<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700102 <code class="details" id="create">create(courseId, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700103 <pre>Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers 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 * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teacher or student in the course.
Takashi Matsuo06694102015-09-11 13:55:40 -0700104
105Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700106 courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700107 body: object, The request body.
Takashi Matsuo06694102015-09-11 13:55:40 -0700108 The object takes the form of:
109
110{ # Teacher of a course.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700111 &quot;profile&quot;: { # Global information for a user. # Global user information for the teacher. Read-only.
112 &quot;verifiedTeacher&quot;: True or False, # Represents whether a G Suite for Education user&#x27;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 is always false. Read-only
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700113 &quot;emailAddress&quot;: &quot;A String&quot;, # Email address of the user. Read-only.
114 &quot;photoUrl&quot;: &quot;A String&quot;, # URL of user&#x27;s profile photo. Read-only.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700115 &quot;permissions&quot;: [ # Global permissions of the user. Read-only.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700116 { # Global user permission description.
117 &quot;permission&quot;: &quot;A String&quot;, # Permission value.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700118 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700119 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700120 &quot;id&quot;: &quot;A String&quot;, # Identifier of the user. Read-only.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700121 &quot;name&quot;: { # Details of the user&#x27;s name. # Name of the user. Read-only.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700122 &quot;fullName&quot;: &quot;A String&quot;, # The user&#x27;s full name formed by concatenating the first and last name values. Read-only.
123 &quot;familyName&quot;: &quot;A String&quot;, # The user&#x27;s last name. Read-only.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700124 &quot;givenName&quot;: &quot;A String&quot;, # The user&#x27;s first name. Read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700125 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700126 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700127 &quot;courseId&quot;: &quot;A String&quot;, # Identifier of the course. Read-only.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700128 &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
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700129}
Takashi Matsuo06694102015-09-11 13:55:40 -0700130
131 x__xgafv: string, V1 error format.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700132 Allowed values
133 1 - v1 error format
134 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700135
136Returns:
137 An object of the form:
138
139 { # Teacher of a course.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700140 &quot;profile&quot;: { # Global information for a user. # Global user information for the teacher. Read-only.
141 &quot;verifiedTeacher&quot;: True or False, # Represents whether a G Suite for Education user&#x27;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 is always false. Read-only
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700142 &quot;emailAddress&quot;: &quot;A String&quot;, # Email address of the user. Read-only.
143 &quot;photoUrl&quot;: &quot;A String&quot;, # URL of user&#x27;s profile photo. Read-only.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700144 &quot;permissions&quot;: [ # Global permissions of the user. Read-only.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700145 { # Global user permission description.
146 &quot;permission&quot;: &quot;A String&quot;, # Permission value.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700147 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700148 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700149 &quot;id&quot;: &quot;A String&quot;, # Identifier of the user. Read-only.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700150 &quot;name&quot;: { # Details of the user&#x27;s name. # Name of the user. Read-only.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700151 &quot;fullName&quot;: &quot;A String&quot;, # The user&#x27;s full name formed by concatenating the first and last name values. Read-only.
152 &quot;familyName&quot;: &quot;A String&quot;, # The user&#x27;s last name. Read-only.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700153 &quot;givenName&quot;: &quot;A String&quot;, # The user&#x27;s first name. Read-only.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700154 },
155 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700156 &quot;courseId&quot;: &quot;A String&quot;, # Identifier of the course. Read-only.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700157 &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
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700158 }</pre>
Takashi Matsuo06694102015-09-11 13:55:40 -0700159</div>
160
161<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700162 <code class="details" id="delete">delete(courseId, userId, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700163 <pre>Deletes a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course.
Takashi Matsuo06694102015-09-11 13:55:40 -0700164
165Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700166 courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
167 userId: string, Identifier of the teacher 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)
Takashi Matsuo06694102015-09-11 13:55:40 -0700168 x__xgafv: string, V1 error format.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700169 Allowed values
170 1 - v1 error format
171 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700172
173Returns:
174 An object of the form:
175
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700176 { # 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 `{}`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700177 }</pre>
178</div>
179
180<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700181 <code class="details" id="get">get(courseId, userId, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700182 <pre>Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist.
Takashi Matsuo06694102015-09-11 13:55:40 -0700183
184Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700185 courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
186 userId: string, Identifier of the teacher 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)
Takashi Matsuo06694102015-09-11 13:55:40 -0700187 x__xgafv: string, V1 error format.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700188 Allowed values
189 1 - v1 error format
190 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700191
192Returns:
193 An object of the form:
194
195 { # Teacher of a course.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700196 &quot;profile&quot;: { # Global information for a user. # Global user information for the teacher. Read-only.
197 &quot;verifiedTeacher&quot;: True or False, # Represents whether a G Suite for Education user&#x27;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 is always false. Read-only
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700198 &quot;emailAddress&quot;: &quot;A String&quot;, # Email address of the user. Read-only.
199 &quot;photoUrl&quot;: &quot;A String&quot;, # URL of user&#x27;s profile photo. Read-only.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700200 &quot;permissions&quot;: [ # Global permissions of the user. Read-only.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700201 { # Global user permission description.
202 &quot;permission&quot;: &quot;A String&quot;, # Permission value.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700203 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700204 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700205 &quot;id&quot;: &quot;A String&quot;, # Identifier of the user. Read-only.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700206 &quot;name&quot;: { # Details of the user&#x27;s name. # Name of the user. Read-only.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700207 &quot;fullName&quot;: &quot;A String&quot;, # The user&#x27;s full name formed by concatenating the first and last name values. Read-only.
208 &quot;familyName&quot;: &quot;A String&quot;, # The user&#x27;s last name. Read-only.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700209 &quot;givenName&quot;: &quot;A String&quot;, # The user&#x27;s first name. Read-only.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700210 },
211 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700212 &quot;courseId&quot;: &quot;A String&quot;, # Identifier of the course. Read-only.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700213 &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
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700214 }</pre>
Takashi Matsuo06694102015-09-11 13:55:40 -0700215</div>
216
217<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700218 <code class="details" id="list">list(courseId, pageToken=None, pageSize=None, x__xgafv=None)</code>
219 <pre>Returns a list of teachers 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 -0700220
221Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700222 courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
223 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.
224 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700225 x__xgafv: string, V1 error format.
226 Allowed values
227 1 - v1 error format
228 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700229
230Returns:
231 An object of the form:
232
233 { # Response when listing teachers.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700234 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token identifying the next page of results to return. If empty, no further results are available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700235 &quot;teachers&quot;: [ # Teachers who match the list request.
Takashi Matsuo06694102015-09-11 13:55:40 -0700236 { # Teacher of a course.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700237 &quot;profile&quot;: { # Global information for a user. # Global user information for the teacher. Read-only.
238 &quot;verifiedTeacher&quot;: True or False, # Represents whether a G Suite for Education user&#x27;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 is always false. Read-only
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700239 &quot;emailAddress&quot;: &quot;A String&quot;, # Email address of the user. Read-only.
240 &quot;photoUrl&quot;: &quot;A String&quot;, # URL of user&#x27;s profile photo. Read-only.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700241 &quot;permissions&quot;: [ # Global permissions of the user. Read-only.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700242 { # Global user permission description.
243 &quot;permission&quot;: &quot;A String&quot;, # Permission value.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700244 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700245 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700246 &quot;id&quot;: &quot;A String&quot;, # Identifier of the user. Read-only.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700247 &quot;name&quot;: { # Details of the user&#x27;s name. # Name of the user. Read-only.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700248 &quot;fullName&quot;: &quot;A String&quot;, # The user&#x27;s full name formed by concatenating the first and last name values. Read-only.
249 &quot;familyName&quot;: &quot;A String&quot;, # The user&#x27;s last name. Read-only.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700250 &quot;givenName&quot;: &quot;A String&quot;, # The user&#x27;s first name. Read-only.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700251 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700252 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700253 &quot;courseId&quot;: &quot;A String&quot;, # Identifier of the course. Read-only.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700254 &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
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700255 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700256 ],
257 }</pre>
258</div>
259
260<div class="method">
261 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
262 <pre>Retrieves the next page of results.
263
264Args:
265 previous_request: The request for the previous page. (required)
266 previous_response: The response from the request for the previous page. (required)
267
268Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700269 A request object that you can call &#x27;execute()&#x27; on to request the next
Takashi Matsuo06694102015-09-11 13:55:40 -0700270 page. Returns None if there are no more items in the collection.
271 </pre>
272</div>
273
274</body></html>