Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 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.teachers.html">teachers</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 78 | <code><a href="#create">create(courseId=None, body, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Creates a teacher of a course.</p> |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 80 | <p class="toc_element"> |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 81 | <code><a href="#delete">delete(courseId=None, userId=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Deletes a teacher of a course.</p> |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 83 | <p class="toc_element"> |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 84 | <code><a href="#get">get(courseId=None, userId=None, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Returns a teacher of a course.</p> |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 86 | <p class="toc_element"> |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 87 | <code><a href="#list">list(courseId=None, pageSize=None, x__xgafv=None, pageToken=None)</a></code></p> |
| 88 | <p class="firstline">Returns a list of teachers of this course that the requester</p> |
Takashi Matsuo | 0669410 | 2015-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"> |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 94 | <code class="details" id="create">create(courseId=None, body, x__xgafv=None)</code> |
| 95 | <pre>Creates a teacher of a course. |
| 96 | |
| 97 | This method returns the following error codes: |
| 98 | |
| 99 | * `PERMISSION_DENIED` if the requesting user is not permitted to create |
| 100 | teachers in this course or for access errors. |
| 101 | * `NOT_FOUND` if the requested course ID does not exist. |
| 102 | * `FAILED_PRECONDITION` if the requested user's account is disabled, |
| 103 | for the following request errors: |
| 104 | * CourseMemberLimitReached |
| 105 | * CourseNotModifiable |
| 106 | * CourseTeacherLimitReached |
| 107 | * UserGroupsMembershipLimitReached |
| 108 | * `ALREADY_EXISTS` if the user is already a teacher or student in the |
| 109 | course. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 110 | |
| 111 | Args: |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 112 | courseId: string, Identifier of the course. |
| 113 | This identifier can be either the Classroom-assigned identifier or an |
| 114 | alias. (required) |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 115 | body: object, The request body. (required) |
| 116 | The object takes the form of: |
| 117 | |
| 118 | { # Teacher of a course. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 119 | "courseId": "A String", # Identifier of the course. |
| 120 | # |
| 121 | # Read-only. |
| 122 | "profile": { # Global information for a user. # Global user information for the teacher. |
| 123 | # |
| 124 | # Read-only. |
| 125 | "photoUrl": "A String", # URL of user's profile photo. |
| 126 | # |
| 127 | # Read-only. |
| 128 | "emailAddress": "A String", # Email address of the user. |
| 129 | # |
| 130 | # Read-only. |
| 131 | "id": "A String", # Identifier of the user. |
| 132 | # |
| 133 | # Read-only. |
| 134 | "name": { # Details of the user's name. # Name of the user. |
| 135 | # |
| 136 | # Read-only. |
| 137 | "fullName": "A String", # The user's full name formed by concatenating the first and last name |
| 138 | # values. |
| 139 | # |
| 140 | # Read-only. |
| 141 | "givenName": "A String", # The user's first name. |
| 142 | # |
| 143 | # Read-only. |
| 144 | "familyName": "A String", # The user's last name. |
| 145 | # |
| 146 | # Read-only. |
| 147 | }, |
| 148 | "permissions": [ # Global permissions of the user. |
| 149 | # |
| 150 | # Read-only. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 151 | { # Global user permission description. |
| 152 | "permission": "A String", # Permission value. |
| 153 | }, |
| 154 | ], |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 155 | }, |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 156 | "userId": "A String", # Identifier of the user. |
| 157 | # |
| 158 | # When specified as a parameter of a request, this identifier can be one of |
| 159 | # the following: |
| 160 | # |
| 161 | # * the numeric identifier for the user |
| 162 | # * the email address of the user |
| 163 | # * the string literal `"me"`, indicating the requesting user |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 164 | } |
| 165 | |
| 166 | x__xgafv: string, V1 error format. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 167 | Allowed values |
| 168 | 1 - v1 error format |
| 169 | 2 - v2 error format |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 170 | |
| 171 | Returns: |
| 172 | An object of the form: |
| 173 | |
| 174 | { # Teacher of a course. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 175 | "courseId": "A String", # Identifier of the course. |
| 176 | # |
| 177 | # Read-only. |
| 178 | "profile": { # Global information for a user. # Global user information for the teacher. |
| 179 | # |
| 180 | # Read-only. |
| 181 | "photoUrl": "A String", # URL of user's profile photo. |
| 182 | # |
| 183 | # Read-only. |
| 184 | "emailAddress": "A String", # Email address of the user. |
| 185 | # |
| 186 | # Read-only. |
| 187 | "id": "A String", # Identifier of the user. |
| 188 | # |
| 189 | # Read-only. |
| 190 | "name": { # Details of the user's name. # Name of the user. |
| 191 | # |
| 192 | # Read-only. |
| 193 | "fullName": "A String", # The user's full name formed by concatenating the first and last name |
| 194 | # values. |
| 195 | # |
| 196 | # Read-only. |
| 197 | "givenName": "A String", # The user's first name. |
| 198 | # |
| 199 | # Read-only. |
| 200 | "familyName": "A String", # The user's last name. |
| 201 | # |
| 202 | # Read-only. |
| 203 | }, |
| 204 | "permissions": [ # Global permissions of the user. |
| 205 | # |
| 206 | # Read-only. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 207 | { # Global user permission description. |
| 208 | "permission": "A String", # Permission value. |
| 209 | }, |
| 210 | ], |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 211 | }, |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 212 | "userId": "A String", # Identifier of the user. |
| 213 | # |
| 214 | # When specified as a parameter of a request, this identifier can be one of |
| 215 | # the following: |
| 216 | # |
| 217 | # * the numeric identifier for the user |
| 218 | # * the email address of the user |
| 219 | # * the string literal `"me"`, indicating the requesting user |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 220 | }</pre> |
| 221 | </div> |
| 222 | |
| 223 | <div class="method"> |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 224 | <code class="details" id="delete">delete(courseId=None, userId=None, x__xgafv=None)</code> |
| 225 | <pre>Deletes a teacher of a course. |
| 226 | |
| 227 | This method returns the following error codes: |
| 228 | |
| 229 | * `PERMISSION_DENIED` if the requesting user is not permitted to delete |
| 230 | teachers of this course or for access errors. |
| 231 | * `NOT_FOUND` if no teacher of this course has the requested ID or if the |
| 232 | course does not exist. |
| 233 | * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher |
| 234 | of this course. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 235 | |
| 236 | Args: |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 237 | courseId: string, Identifier of the course. |
| 238 | This identifier can be either the Classroom-assigned identifier or an |
| 239 | alias. (required) |
| 240 | userId: string, Identifier of the teacher to delete. The identifier can be one of the |
| 241 | following: |
| 242 | |
| 243 | * the numeric identifier for the user |
| 244 | * the email address of the user |
| 245 | * the string literal `"me"`, indicating the requesting user (required) |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 246 | x__xgafv: string, V1 error format. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 247 | Allowed values |
| 248 | 1 - v1 error format |
| 249 | 2 - v2 error format |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 250 | |
| 251 | Returns: |
| 252 | An object of the form: |
| 253 | |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 254 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 255 | # empty messages in your APIs. A typical example is to use it as the request |
| 256 | # or the response type of an API method. For instance: |
| 257 | # |
| 258 | # service Foo { |
| 259 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 260 | # } |
| 261 | # |
| 262 | # The JSON representation for `Empty` is empty JSON object `{}`. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 263 | }</pre> |
| 264 | </div> |
| 265 | |
| 266 | <div class="method"> |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 267 | <code class="details" id="get">get(courseId=None, userId=None, x__xgafv=None)</code> |
| 268 | <pre>Returns a teacher of a course. |
| 269 | |
| 270 | This method returns the following error codes: |
| 271 | |
| 272 | * `PERMISSION_DENIED` if the requesting user is not permitted to view |
| 273 | teachers of this course or for access errors. |
| 274 | * `NOT_FOUND` if no teacher of this course has the requested ID or if the |
| 275 | course does not exist. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 276 | |
| 277 | Args: |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 278 | courseId: string, Identifier of the course. |
| 279 | This identifier can be either the Classroom-assigned identifier or an |
| 280 | alias. (required) |
| 281 | userId: string, Identifier of the teacher to return. The identifier can be one of the |
| 282 | following: |
| 283 | |
| 284 | * the numeric identifier for the user |
| 285 | * the email address of the user |
| 286 | * the string literal `"me"`, indicating the requesting user (required) |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 287 | x__xgafv: string, V1 error format. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 288 | Allowed values |
| 289 | 1 - v1 error format |
| 290 | 2 - v2 error format |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 291 | |
| 292 | Returns: |
| 293 | An object of the form: |
| 294 | |
| 295 | { # Teacher of a course. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 296 | "courseId": "A String", # Identifier of the course. |
| 297 | # |
| 298 | # Read-only. |
| 299 | "profile": { # Global information for a user. # Global user information for the teacher. |
| 300 | # |
| 301 | # Read-only. |
| 302 | "photoUrl": "A String", # URL of user's profile photo. |
| 303 | # |
| 304 | # Read-only. |
| 305 | "emailAddress": "A String", # Email address of the user. |
| 306 | # |
| 307 | # Read-only. |
| 308 | "id": "A String", # Identifier of the user. |
| 309 | # |
| 310 | # Read-only. |
| 311 | "name": { # Details of the user's name. # Name of the user. |
| 312 | # |
| 313 | # Read-only. |
| 314 | "fullName": "A String", # The user's full name formed by concatenating the first and last name |
| 315 | # values. |
| 316 | # |
| 317 | # Read-only. |
| 318 | "givenName": "A String", # The user's first name. |
| 319 | # |
| 320 | # Read-only. |
| 321 | "familyName": "A String", # The user's last name. |
| 322 | # |
| 323 | # Read-only. |
| 324 | }, |
| 325 | "permissions": [ # Global permissions of the user. |
| 326 | # |
| 327 | # Read-only. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 328 | { # Global user permission description. |
| 329 | "permission": "A String", # Permission value. |
| 330 | }, |
| 331 | ], |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 332 | }, |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 333 | "userId": "A String", # Identifier of the user. |
| 334 | # |
| 335 | # When specified as a parameter of a request, this identifier can be one of |
| 336 | # the following: |
| 337 | # |
| 338 | # * the numeric identifier for the user |
| 339 | # * the email address of the user |
| 340 | # * the string literal `"me"`, indicating the requesting user |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 341 | }</pre> |
| 342 | </div> |
| 343 | |
| 344 | <div class="method"> |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 345 | <code class="details" id="list">list(courseId=None, pageSize=None, x__xgafv=None, pageToken=None)</code> |
| 346 | <pre>Returns a list of teachers of this course that the requester |
| 347 | is permitted to view. |
| 348 | |
| 349 | This method returns the following error codes: |
| 350 | |
| 351 | * `NOT_FOUND` if the course does not exist. |
| 352 | * `PERMISSION_DENIED` for access errors. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 353 | |
| 354 | Args: |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 355 | courseId: string, Identifier of the course. |
| 356 | This identifier can be either the Classroom-assigned identifier or an |
| 357 | alias. (required) |
| 358 | pageSize: integer, Maximum number of items to return. Zero means no maximum. |
| 359 | |
| 360 | The server may return fewer than the specified number of results. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 361 | x__xgafv: string, V1 error format. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 362 | Allowed values |
| 363 | 1 - v1 error format |
| 364 | 2 - v2 error format |
| 365 | pageToken: string, nextPageToken |
| 366 | value returned from a previous |
| 367 | list call, indicating that |
| 368 | the subsequent page of results should be returned. |
| 369 | |
| 370 | The list request must be |
| 371 | otherwise identical to the one that resulted in this token. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 372 | |
| 373 | Returns: |
| 374 | An object of the form: |
| 375 | |
| 376 | { # Response when listing teachers. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 377 | "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further |
| 378 | # results are available. |
Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 379 | "teachers": [ # Teachers who match the list request. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 380 | { # Teacher of a course. |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 381 | "courseId": "A String", # Identifier of the course. |
| 382 | # |
| 383 | # Read-only. |
| 384 | "profile": { # Global information for a user. # Global user information for the teacher. |
| 385 | # |
| 386 | # Read-only. |
| 387 | "photoUrl": "A String", # URL of user's profile photo. |
| 388 | # |
| 389 | # Read-only. |
| 390 | "emailAddress": "A String", # Email address of the user. |
| 391 | # |
| 392 | # Read-only. |
| 393 | "id": "A String", # Identifier of the user. |
| 394 | # |
| 395 | # Read-only. |
| 396 | "name": { # Details of the user's name. # Name of the user. |
| 397 | # |
| 398 | # Read-only. |
| 399 | "fullName": "A String", # The user's full name formed by concatenating the first and last name |
| 400 | # values. |
| 401 | # |
| 402 | # Read-only. |
| 403 | "givenName": "A String", # The user's first name. |
| 404 | # |
| 405 | # Read-only. |
| 406 | "familyName": "A String", # The user's last name. |
| 407 | # |
| 408 | # Read-only. |
| 409 | }, |
| 410 | "permissions": [ # Global permissions of the user. |
| 411 | # |
| 412 | # Read-only. |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 413 | { # Global user permission description. |
| 414 | "permission": "A String", # Permission value. |
| 415 | }, |
| 416 | ], |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 417 | }, |
Sai Cheemalapati | e833b79 | 2017-03-24 15:06:46 -0700 | [diff] [blame^] | 418 | "userId": "A String", # Identifier of the user. |
| 419 | # |
| 420 | # When specified as a parameter of a request, this identifier can be one of |
| 421 | # the following: |
| 422 | # |
| 423 | # * the numeric identifier for the user |
| 424 | # * the email address of the user |
| 425 | # * the string literal `"me"`, indicating the requesting user |
Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 426 | }, |
| 427 | ], |
| 428 | }</pre> |
| 429 | </div> |
| 430 | |
| 431 | <div class="method"> |
| 432 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 433 | <pre>Retrieves the next page of results. |
| 434 | |
| 435 | Args: |
| 436 | previous_request: The request for the previous page. (required) |
| 437 | previous_response: The response from the request for the previous page. (required) |
| 438 | |
| 439 | Returns: |
| 440 | A request object that you can call 'execute()' on to request the next |
| 441 | page. Returns None if there are no more items in the collection. |
| 442 | </pre> |
| 443 | </div> |
| 444 | |
| 445 | </body></html> |