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.teachers.html">teachers</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, x__xgafv=None)</a></code></p> 82<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> 83<p class="toc_element"> 84 <code><a href="#delete">delete(courseId, userId, x__xgafv=None)</a></code></p> 85<p class="firstline">Removes the specified teacher from the specified 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. * `FAILED_PRECONDITION` if the requested ID belongs to the owner of the course Drive folder. * `FAILED_PRECONDITION` if the course no longer has an active owner.</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 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> 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 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> 92<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"> 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, x__xgafv=None)</code> 103 <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'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. 104 105Args: 106 courseId: string, Identifier of the course. 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{ # Teacher of a course. 111 "courseId": "A String", # Identifier of the course. Read-only. 112 "profile": { # Global information for a user. # Global user information for the teacher. Read-only. 113 "emailAddress": "A String", # Email address of the user. Read-only. 114 "id": "A String", # Identifier of the user. Read-only. 115 "name": { # Details of the user's name. # Name of the user. Read-only. 116 "familyName": "A String", # The user's last name. Read-only. 117 "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only. 118 "givenName": "A String", # The user's first name. Read-only. 119 }, 120 "permissions": [ # Global permissions of the user. Read-only. 121 { # Global user permission description. 122 "permission": "A String", # Permission value. 123 }, 124 ], 125 "photoUrl": "A String", # URL of user's profile photo. Read-only. 126 "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 is always false. Read-only 127 }, 128 "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 129} 130 131 x__xgafv: string, V1 error format. 132 Allowed values 133 1 - v1 error format 134 2 - v2 error format 135 136Returns: 137 An object of the form: 138 139 { # Teacher of a course. 140 "courseId": "A String", # Identifier of the course. Read-only. 141 "profile": { # Global information for a user. # Global user information for the teacher. Read-only. 142 "emailAddress": "A String", # Email address of the user. Read-only. 143 "id": "A String", # Identifier of the user. Read-only. 144 "name": { # Details of the user's name. # Name of the user. Read-only. 145 "familyName": "A String", # The user's last name. Read-only. 146 "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only. 147 "givenName": "A String", # The user's first name. Read-only. 148 }, 149 "permissions": [ # Global permissions of the user. Read-only. 150 { # Global user permission description. 151 "permission": "A String", # Permission value. 152 }, 153 ], 154 "photoUrl": "A String", # URL of user's profile photo. Read-only. 155 "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 is always false. Read-only 156 }, 157 "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 158}</pre> 159</div> 160 161<div class="method"> 162 <code class="details" id="delete">delete(courseId, userId, x__xgafv=None)</code> 163 <pre>Removes the specified teacher from the specified 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. * `FAILED_PRECONDITION` if the requested ID belongs to the owner of the course Drive folder. * `FAILED_PRECONDITION` if the course no longer has an active owner. 164 165Args: 166 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 `"me"`, indicating the requesting user (required) 168 x__xgafv: string, V1 error format. 169 Allowed values 170 1 - v1 error format 171 2 - v2 error format 172 173Returns: 174 An object of the form: 175 176 { # 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 `{}`. 177}</pre> 178</div> 179 180<div class="method"> 181 <code class="details" id="get">get(courseId, userId, x__xgafv=None)</code> 182 <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. 183 184Args: 185 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 `"me"`, indicating the requesting user (required) 187 x__xgafv: string, V1 error format. 188 Allowed values 189 1 - v1 error format 190 2 - v2 error format 191 192Returns: 193 An object of the form: 194 195 { # Teacher of a course. 196 "courseId": "A String", # Identifier of the course. Read-only. 197 "profile": { # Global information for a user. # Global user information for the teacher. Read-only. 198 "emailAddress": "A String", # Email address of the user. Read-only. 199 "id": "A String", # Identifier of the user. Read-only. 200 "name": { # Details of the user's name. # Name of the user. Read-only. 201 "familyName": "A String", # The user's last name. Read-only. 202 "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only. 203 "givenName": "A String", # The user's first name. Read-only. 204 }, 205 "permissions": [ # Global permissions of the user. Read-only. 206 { # Global user permission description. 207 "permission": "A String", # Permission value. 208 }, 209 ], 210 "photoUrl": "A String", # URL of user's profile photo. Read-only. 211 "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 is always false. Read-only 212 }, 213 "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 214}</pre> 215</div> 216 217<div class="method"> 218 <code class="details" id="list">list(courseId, pageSize=None, pageToken=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. 220 221Args: 222 courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required) 223 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. 224 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. 225 x__xgafv: string, V1 error format. 226 Allowed values 227 1 - v1 error format 228 2 - v2 error format 229 230Returns: 231 An object of the form: 232 233 { # Response when listing teachers. 234 "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available. 235 "teachers": [ # Teachers who match the list request. 236 { # Teacher of a course. 237 "courseId": "A String", # Identifier of the course. Read-only. 238 "profile": { # Global information for a user. # Global user information for the teacher. Read-only. 239 "emailAddress": "A String", # Email address of the user. Read-only. 240 "id": "A String", # Identifier of the user. Read-only. 241 "name": { # Details of the user's name. # Name of the user. Read-only. 242 "familyName": "A String", # The user's last name. Read-only. 243 "fullName": "A String", # The user's full name formed by concatenating the first and last name values. Read-only. 244 "givenName": "A String", # The user's first name. Read-only. 245 }, 246 "permissions": [ # Global permissions of the user. Read-only. 247 { # Global user permission description. 248 "permission": "A String", # Permission value. 249 }, 250 ], 251 "photoUrl": "A String", # URL of user's profile photo. Read-only. 252 "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 is always false. Read-only 253 }, 254 "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 255 }, 256 ], 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: 269 A request object that you can call 'execute()' on to request the next 270 page. Returns None if there are no more items in the collection. 271 </pre> 272</div> 273 274</body></html>