Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(82)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: discovery/googleapis/classroom__v1.json

Issue 1268013003: Api-roll 21: 2015-08-04 (Closed) Base URL: git@github.com:dart-lang/googleapis.git@master
Patch Set: Created 5 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « discovery/googleapis/civicinfo__v2.json ('k') | discovery/googleapis/clouddebugger__v2.json » ('j') | discovery/googleapis/dfareporting__v2.0.json » ('J')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
1 {
2 "auth": {
3 "oauth2": {
4 "scopes": {
5 "https://www.googleapis.com/auth/classroom.courses": {
6 "description": "Manage your Google Classroom classes"
7 },
8 "https://www.googleapis.com/auth/classroom.courses.readonly": {
9 "description": "View your Google Classroom classes"
10 },
11 "https://www.googleapis.com/auth/classroom.profile.emails": {
12 "description": "View the email addresses of people in your c lasses"
13 },
14 "https://www.googleapis.com/auth/classroom.profile.photos": {
15 "description": "View the profile photos of people in your cl asses"
16 },
17 "https://www.googleapis.com/auth/classroom.rosters": {
18 "description": "Manage your Google Classroom class rosters"
19 },
20 "https://www.googleapis.com/auth/classroom.rosters.readonly": {
21 "description": "View your Google Classroom class rosters"
22 }
23 }
24 }
25 },
26 "basePath": "",
27 "baseUrl": "https://classroom.googleapis.com/",
28 "batchPath": "batch",
29 "description": "Google Classroom API",
30 "discoveryVersion": "v1",
31 "documentationLink": "",
32 "etag": "\"ye6orv2F-1npMW3u9suM3a7C5Bo/niuwoiUGTAQydy0rARLpR-dYbKw\"",
33 "icons": {
34 "x16": "http://www.google.com/images/icons/product/search-16.gif",
35 "x32": "http://www.google.com/images/icons/product/search-32.gif"
36 },
37 "id": "classroom:v1",
38 "kind": "discovery#restDescription",
39 "name": "classroom",
40 "ownerDomain": "google.com",
41 "ownerName": "Google",
42 "parameters": {
43 "access_token": {
44 "description": "OAuth access token.",
45 "location": "query",
46 "type": "string"
47 },
48 "alt": {
49 "default": "json",
50 "description": "Data format for response.",
51 "enumDescriptions": [
52 "Responses with Content-Type of application/json",
53 "Media download with context-dependent Content-Type",
54 "Responses with Content-Type of application/x-protobuf"
55 ],
56 "location": "query",
57 "type": "string"
58 },
59 "bearer_token": {
60 "description": "OAuth bearer token.",
61 "location": "query",
62 "type": "string"
63 },
64 "callback": {
65 "description": "JSONP",
66 "location": "query",
67 "type": "string"
68 },
69 "fields": {
70 "description": "Selector specifying which fields to include in a par tial response.",
71 "location": "query",
72 "type": "string"
73 },
74 "key": {
75 "description": "API key. Your API key identifies your project and pr ovides you with API access, quota, and reports. Required unless you provide an O Auth 2.0 token.",
76 "location": "query",
77 "type": "string"
78 },
79 "oauth_token": {
80 "description": "OAuth 2.0 token for the current user.",
81 "location": "query",
82 "type": "string"
83 },
84 "pp": {
85 "default": "true",
86 "description": "Pretty-print response.",
87 "location": "query",
88 "type": "boolean"
89 },
90 "prettyPrint": {
91 "default": "true",
92 "description": "Returns response with indentations and line breaks." ,
93 "location": "query",
94 "type": "boolean"
95 },
96 "quotaUser": {
97 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exc eed 40 characters.",
98 "location": "query",
99 "type": "string"
100 },
101 "upload_protocol": {
102 "description": "Upload protocol for media (e.g. \"raw\", \"multipart \").",
103 "location": "query",
104 "type": "string"
105 },
106 "uploadType": {
107 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
108 "location": "query",
109 "type": "string"
110 },
111 "$.xgafv": {
112 "description": "V1 error format.",
113 "enumDescriptions": [
114 "v1 error format",
115 "v2 error format"
116 ],
117 "location": "query",
118 "type": "string"
119 }
120 },
121 "protocol": "rest",
122 "resources": {
123 "courses": {
124 "methods": {
125 "create": {
126 "description": "Creates a course. The user specified as the primary teacher in `primary_teacher_id` is the owner of the created course and a dded as a teacher. This method returns the following error codes: * `PERMISSION_ DENIED` if the requesting user is not permitted to create courses. * `NOT_FOUND` if the primary teacher is not a valid user. * `ALREADY_EXISTS` if an alias was specified and already exists.",
127 "httpMethod": "POST",
128 "id": "classroom.courses.create",
129 "path": "v1/courses",
130 "request": {
131 "$ref": "Course"
132 },
133 "response": {
134 "$ref": "Course"
135 },
136 "scopes": [
137 "https://www.googleapis.com/auth/classroom.courses"
138 ]
139 },
140 "get": {
141 "description": "Returns a course. This method returns the fo llowing error codes: * `PERMISSION_DENIED` if the requesting user is not permitt ed to access the requested course. * `NOT_FOUND` if no course exists with the re quested ID.",
142 "httpMethod": "GET",
143 "id": "classroom.courses.get",
144 "parameterOrder": [
145 "id"
146 ],
147 "parameters": {
148 "id": {
149 "description": "Identifier of the course to return. This may either be the Classroom-assigned identifier or an [alias][google.classr oom.v1.CourseAlias].",
150 "location": "path",
151 "required": true,
152 "type": "string"
153 }
154 },
155 "path": "v1/courses/{id}",
156 "response": {
157 "$ref": "Course"
158 },
159 "scopes": [
160 "https://www.googleapis.com/auth/classroom.courses",
161 "https://www.googleapis.com/auth/classroom.courses.reado nly"
162 ]
163 },
164 "update": {
165 "description": "Updates a course. This method returns the fo llowing error codes: * `PERMISSION_DENIED` if the requesting user is not permitt ed to modify the requested course. * `NOT_FOUND` if no course exists with the re quested ID.",
166 "httpMethod": "PUT",
167 "id": "classroom.courses.update",
168 "parameterOrder": [
169 "id"
170 ],
171 "parameters": {
172 "id": {
173 "description": "Identifier of the course to update. This may either be the Classroom-assigned identifier or an [alias][google.classr oom.v1.CourseAlias].",
174 "location": "path",
175 "required": true,
176 "type": "string"
177 }
178 },
179 "path": "v1/courses/{id}",
180 "request": {
181 "$ref": "Course"
182 },
183 "response": {
184 "$ref": "Course"
185 },
186 "scopes": [
187 "https://www.googleapis.com/auth/classroom.courses"
188 ]
189 },
190 "patch": {
191 "description": "Updates one or more fields a course. This me thod returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specif ied in the update mask or if no update mask is supplied.",
192 "httpMethod": "PATCH",
193 "id": "classroom.courses.patch",
194 "parameterOrder": [
195 "id"
196 ],
197 "parameters": {
198 "id": {
199 "description": "Identifier of the course to update. This may either be the Classroom-assigned identifier or an [alias][google.classr oom.v1.CourseAlias].",
200 "location": "path",
201 "required": true,
202 "type": "string"
203 },
204 "updateMask": {
205 "description": "Mask which identifies which fields o n the course to update. This field is required to do an update. The update will fail if invalid fields are specified. Valid fields are listed below: * `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` When s et in a query parameter, this should be specified as `updateMask=,,...`",
206 "location": "query",
207 "type": "string"
208 }
209 },
210 "path": "v1/courses/{id}",
211 "request": {
212 "$ref": "Course"
213 },
214 "response": {
215 "$ref": "Course"
216 },
217 "scopes": [
218 "https://www.googleapis.com/auth/classroom.courses"
219 ]
220 },
221 "delete": {
222 "description": "Deletes a course. This method returns the fo llowing error codes: * `PERMISSION_DENIED` if the requesting user is not permitt ed to delete the requested course. * `NOT_FOUND` if no course exists with the re quested ID.",
223 "httpMethod": "DELETE",
224 "id": "classroom.courses.delete",
225 "parameterOrder": [
226 "id"
227 ],
228 "parameters": {
229 "id": {
230 "description": "Identifier of the course to delete. This may either be the Classroom-assigned identifier or an [alias][google.classr oom.v1.CourseAlias].",
231 "location": "path",
232 "required": true,
233 "type": "string"
234 }
235 },
236 "path": "v1/courses/{id}",
237 "response": {
238 "$ref": "Empty"
239 },
240 "scopes": [
241 "https://www.googleapis.com/auth/classroom.courses"
242 ]
243 },
244 "list": {
245 "description": "Returns a list of courses that the requestin g user is permitted to view, restricted to those that match the request. This me thod returns the following error codes: * `INVALID_ARGUMENT` if the query argume nt is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.",
246 "httpMethod": "GET",
247 "id": "classroom.courses.list",
248 "parameters": {
249 "studentId": {
250 "description": "Restricts returned courses to those having a student with the specified identifier, or an alias that identifies a st udent. The following aliases are supported: * the e-mail address of the user * t he string literal `\"me\"`, indicating that the requesting user",
251 "location": "query",
252 "type": "string"
253 },
254 "teacherId": {
255 "description": "Restricts returned courses to those having a teacher with the specified identifier, or an alias that identifies a te acher. The following aliases are supported: * the e-mail address of the user * t he string literal `\"me\"`, indicating that the requesting user",
256 "location": "query",
257 "type": "string"
258 },
259 "pageSize": {
260 "description": "Maximum number of items to return. Z ero or unspecified indicates that the server may assign a maximum. The server ma y return fewer than the specified number of results.",
261 "format": "int32",
262 "location": "query",
263 "type": "integer"
264 },
265 "pageToken": {
266 "description": "[nextPageToken][google.classroom.v1. ListCoursesResponse.next_page_token] value returned from a previous [list][googl e.classroom.v1.Courses.ListCourses] call, indicating that the subsequent page of results should be returned. The [list][google.classroom.v1.Courses.ListCourses] request must be identical to the one which resulted in this token.",
267 "location": "query",
268 "type": "string"
269 }
270 },
271 "path": "v1/courses",
272 "response": {
273 "$ref": "ListCoursesResponse"
274 },
275 "scopes": [
276 "https://www.googleapis.com/auth/classroom.courses",
277 "https://www.googleapis.com/auth/classroom.courses.reado nly"
278 ]
279 }
280 },
281 "resources": {
282 "aliases": {
283 "methods": {
284 "create": {
285 "description": "Creates an alias to a course. This m ethod returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists.",
286 "httpMethod": "POST",
287 "id": "classroom.courses.aliases.create",
288 "parameterOrder": [
289 "courseId"
290 ],
291 "parameters": {
292 "courseId": {
293 "description": "The identifier of the course to alias. This may either be the Classroom-assigned identifier or an [alias][go ogle.classroom.v1.CourseAlias].",
294 "location": "path",
295 "required": true,
296 "type": "string"
297 }
298 },
299 "path": "v1/courses/{courseId}/aliases",
300 "request": {
301 "$ref": "CourseAlias"
302 },
303 "response": {
304 "$ref": "CourseAlias"
305 },
306 "scopes": [
307 "https://www.googleapis.com/auth/classroom.cours es"
308 ]
309 },
310 "delete": {
311 "description": "Deletes an alias of a course. This m ethod returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias. * `NOT_FOUND` if the alias does not exist.",
312 "httpMethod": "DELETE",
313 "id": "classroom.courses.aliases.delete",
314 "parameterOrder": [
315 "courseId",
316 "alias"
317 ],
318 "parameters": {
319 "courseId": {
320 "description": "The identifier of the course whose alias should be deleted. This may either be the Classroom-assigned identi fier or an [alias][google.classroom.v1.CourseAlias].",
321 "location": "path",
322 "required": true,
323 "type": "string"
324 },
325 "alias": {
326 "description": "The alias to delete. This ma y not be the Classroom-assigned identifier.",
327 "location": "path",
328 "required": true,
329 "type": "string"
330 }
331 },
332 "path": "v1/courses/{courseId}/aliases/{alias}",
333 "response": {
334 "$ref": "Empty"
335 },
336 "scopes": [
337 "https://www.googleapis.com/auth/classroom.cours es"
338 ]
339 },
340 "list": {
341 "description": "Lists the aliases of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requestin g user is not permitted to access the course. * `NOT_FOUND` if the course does n ot exist.",
342 "httpMethod": "GET",
343 "id": "classroom.courses.aliases.list",
344 "parameterOrder": [
345 "courseId"
346 ],
347 "parameters": {
348 "courseId": {
349 "description": "The identifier of the course . This may either be the Classroom-assigned identifier or an [alias][google.clas sroom.v1.CourseAlias].",
350 "location": "path",
351 "required": true,
352 "type": "string"
353 },
354 "pageSize": {
355 "description": "Maximum number of items to r eturn. Zero or unspecified indicates that the server may assign a maximum. The s erver may return fewer than the specified number of results.",
356 "format": "int32",
357 "location": "query",
358 "type": "integer"
359 },
360 "pageToken": {
361 "description": "[nextPageToken][google.class room.v1.ListCourseAliasesResponse.next_page_token] value returned from a previou s [list][google.classroom.v1.Courses.ListCourseAliases] call, indicating that th e subsequent page of results should be returned. The [list][google.classroom.v1. Courses.ListCourseAliases] request must be identical to the one which resulted i n this token.",
362 "location": "query",
363 "type": "string"
364 }
365 },
366 "path": "v1/courses/{courseId}/aliases",
367 "response": {
368 "$ref": "ListCourseAliasesResponse"
369 },
370 "scopes": [
371 "https://www.googleapis.com/auth/classroom.cours es",
372 "https://www.googleapis.com/auth/classroom.cours es.readonly"
373 ]
374 }
375 }
376 },
377 "teachers": {
378 "methods": {
379 "create": {
380 "description": "Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requestin g user is not permitted to create teachers in this course. * `NOT_FOUND` if the requested course ID does not exist. * `ALREADY_EXISTS` if the user is already a teacher or student in the course.",
381 "httpMethod": "POST",
382 "id": "classroom.courses.teachers.create",
383 "parameterOrder": [
384 "courseId"
385 ],
386 "parameters": {
387 "courseId": {
388 "description": "Unique identifier of the cou rse. This may either be the Classroom-assigned identifier or an alias.",
389 "location": "path",
390 "required": true,
391 "type": "string"
392 }
393 },
394 "path": "v1/courses/{courseId}/teachers",
395 "request": {
396 "$ref": "Teacher"
397 },
398 "response": {
399 "$ref": "Teacher"
400 },
401 "scopes": [
402 "https://www.googleapis.com/auth/classroom.profi le.emails",
403 "https://www.googleapis.com/auth/classroom.profi le.photos",
404 "https://www.googleapis.com/auth/classroom.roste rs"
405 ]
406 },
407 "get": {
408 "description": "Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requestin g user is not permitted to view teachers of this course. * `NOT_FOUND` if no tea cher of this course has the requested ID or if the course does not exist.",
409 "httpMethod": "GET",
410 "id": "classroom.courses.teachers.get",
411 "parameterOrder": [
412 "courseId",
413 "userId"
414 ],
415 "parameters": {
416 "courseId": {
417 "description": "Unique identifier of the cou rse. This may either be the Classroom-assigned identifier or an alias.",
418 "location": "path",
419 "required": true,
420 "type": "string"
421 },
422 "userId": {
423 "description": "Identifier of the teacher to return, or an alias the identifies the user. the following aliases are supporte d: * the e-mail address of the user * the string literal `\"me\"`, indicating th at the requesting user",
424 "location": "path",
425 "required": true,
426 "type": "string"
427 }
428 },
429 "path": "v1/courses/{courseId}/teachers/{userId}",
430 "response": {
431 "$ref": "Teacher"
432 },
433 "scopes": [
434 "https://www.googleapis.com/auth/classroom.profi le.emails",
435 "https://www.googleapis.com/auth/classroom.profi le.photos",
436 "https://www.googleapis.com/auth/classroom.roste rs",
437 "https://www.googleapis.com/auth/classroom.roste rs.readonly"
438 ]
439 },
440 "delete": {
441 "description": "Deletes a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requestin g user is not permitted to delete teachers of this course. * `NOT_FOUND` if no t eacher of this course has the requested ID or if the course does not exist. * `F AILED_PRECONDITION` if the requested ID belongs to the primary teacher of this c ourse.",
442 "httpMethod": "DELETE",
443 "id": "classroom.courses.teachers.delete",
444 "parameterOrder": [
445 "courseId",
446 "userId"
447 ],
448 "parameters": {
449 "courseId": {
450 "description": "Unique identifier of the cou rse. This may either be the Classroom-assigned identifier or an alias.",
451 "location": "path",
452 "required": true,
453 "type": "string"
454 },
455 "userId": {
456 "description": "Identifier of the teacher to delete, or an alias the identifies the user. the following aliases are supporte d: * the e-mail address of the user * the string literal `\"me\"`, indicating th at the requesting user",
457 "location": "path",
458 "required": true,
459 "type": "string"
460 }
461 },
462 "path": "v1/courses/{courseId}/teachers/{userId}",
463 "response": {
464 "$ref": "Empty"
465 },
466 "scopes": [
467 "https://www.googleapis.com/auth/classroom.roste rs"
468 ]
469 },
470 "list": {
471 "description": "Returns a list of teachers of this c ourse that the requester is permitted to view. Fails with `NOT_FOUND` if the cou rse does not exist.",
472 "httpMethod": "GET",
473 "id": "classroom.courses.teachers.list",
474 "parameterOrder": [
475 "courseId"
476 ],
477 "parameters": {
478 "courseId": {
479 "description": "Unique identifier of the cou rse. This may either be the Classroom-assigned identifier or an alias.",
480 "location": "path",
481 "required": true,
482 "type": "string"
483 },
484 "pageSize": {
485 "description": "Maximum number of items to r eturn. Zero means no maximum. The server may return fewer than the specified num ber of results.",
486 "format": "int32",
487 "location": "query",
488 "type": "integer"
489 },
490 "pageToken": {
491 "description": "[nextPageToken][google.class room.v1.ListTeachersResponse.next_page_token] value returned from a previous [li st][google.classroom.v1.Users.ListTeachers] call, indicating that the subsequent page of results should be returned. The [list][google.classroom.v1.Users.ListTe achers] request must be identical to the one which resulted in this token.",
492 "location": "query",
493 "type": "string"
494 }
495 },
496 "path": "v1/courses/{courseId}/teachers",
497 "response": {
498 "$ref": "ListTeachersResponse"
499 },
500 "scopes": [
501 "https://www.googleapis.com/auth/classroom.profi le.emails",
502 "https://www.googleapis.com/auth/classroom.profi le.photos",
503 "https://www.googleapis.com/auth/classroom.roste rs",
504 "https://www.googleapis.com/auth/classroom.roste rs.readonly"
505 ]
506 }
507 }
508 },
509 "students": {
510 "methods": {
511 "create": {
512 "description": "Adds a user as a student of a course . This method returns the following error codes: * `PERMISSION_DENIED` if the re questing user is not permitted to create students in this course. * `NOT_FOUND` if the requested course ID does not exist. * `ALREADY_EXISTS` if the user is alr eady a student or student in the course.",
513 "httpMethod": "POST",
514 "id": "classroom.courses.students.create",
515 "parameterOrder": [
516 "courseId"
517 ],
518 "parameters": {
519 "courseId": {
520 "description": "Identifier of the course to create the student in. This may either be the Classroom-assigned identifier or a n alias.",
521 "location": "path",
522 "required": true,
523 "type": "string"
524 },
525 "enrollmentCode": {
526 "description": "Enrollment code of the cours e to create the student in. This is required if [userId][google.classroom.v1.Stu dent.user_id] corresponds to the requesting user; this may be omitted if the req uesting user has administrative permissions to create students for any user.",
527 "location": "query",
528 "type": "string"
529 }
530 },
531 "path": "v1/courses/{courseId}/students",
532 "request": {
533 "$ref": "Student"
534 },
535 "response": {
536 "$ref": "Student"
537 },
538 "scopes": [
539 "https://www.googleapis.com/auth/classroom.profi le.emails",
540 "https://www.googleapis.com/auth/classroom.profi le.photos",
541 "https://www.googleapis.com/auth/classroom.roste rs"
542 ]
543 },
544 "get": {
545 "description": "Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requestin g user is not permitted to view students of this course. * `NOT_FOUND` if no stu dent of this course has the requested ID or if the course does not exist.",
546 "httpMethod": "GET",
547 "id": "classroom.courses.students.get",
548 "parameterOrder": [
549 "courseId",
550 "userId"
551 ],
552 "parameters": {
553 "courseId": {
554 "description": "Unique identifier of the cou rse. This may either be the Classroom-assigned identifier or an alias.",
555 "location": "path",
556 "required": true,
557 "type": "string"
558 },
559 "userId": {
560 "description": "Identifier of the student to return, or an alias the identifies the user. The following aliases are supporte d: * the e-mail address of the user * the string literal `\"me\"`, indicating th at the requesting user",
561 "location": "path",
562 "required": true,
563 "type": "string"
564 }
565 },
566 "path": "v1/courses/{courseId}/students/{userId}",
567 "response": {
568 "$ref": "Student"
569 },
570 "scopes": [
571 "https://www.googleapis.com/auth/classroom.profi le.emails",
572 "https://www.googleapis.com/auth/classroom.profi le.photos",
573 "https://www.googleapis.com/auth/classroom.roste rs",
574 "https://www.googleapis.com/auth/classroom.roste rs.readonly"
575 ]
576 },
577 "delete": {
578 "description": "Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requestin g user is not permitted to delete students of this course. * `NOT_FOUND` if no s tudent of this course has the requested ID or if the course does not exist.",
579 "httpMethod": "DELETE",
580 "id": "classroom.courses.students.delete",
581 "parameterOrder": [
582 "courseId",
583 "userId"
584 ],
585 "parameters": {
586 "courseId": {
587 "description": "Unique identifier of the cou rse. This may either be the Classroom-assigned identifier or an alias.",
588 "location": "path",
589 "required": true,
590 "type": "string"
591 },
592 "userId": {
593 "description": "Identifier of the student to delete, or an alias the identifies the user. The following aliases are supporte d: * the e-mail address of the user * the string literal `\"me\"`, indicating th at the requesting user",
594 "location": "path",
595 "required": true,
596 "type": "string"
597 }
598 },
599 "path": "v1/courses/{courseId}/students/{userId}",
600 "response": {
601 "$ref": "Empty"
602 },
603 "scopes": [
604 "https://www.googleapis.com/auth/classroom.roste rs"
605 ]
606 },
607 "list": {
608 "description": "Returns a list of students of this c ourse that the requester is permitted to view. Fails with `NOT_FOUND` if the cou rse does not exist.",
609 "httpMethod": "GET",
610 "id": "classroom.courses.students.list",
611 "parameterOrder": [
612 "courseId"
613 ],
614 "parameters": {
615 "courseId": {
616 "description": "Unique identifier of the cou rse. This may either be the Classroom-assigned identifier or an alias.",
617 "location": "path",
618 "required": true,
619 "type": "string"
620 },
621 "pageSize": {
622 "description": "Maximum number of items to r eturn. Zero means no maximum. The server may return fewer than the specified num ber of results.",
623 "format": "int32",
624 "location": "query",
625 "type": "integer"
626 },
627 "pageToken": {
628 "description": "[nextPageToken][google.class room.v1.ListStudentsResponse.next_page_token] value returned from a previous [li st][google.classroom.v1.Users.ListStudents] call, indicating that the subsequent page of results should be returned. The [list][google.classroom.v1.Users.ListSt udents] request must be identical to the one which resulted in this token.",
629 "location": "query",
630 "type": "string"
631 }
632 },
633 "path": "v1/courses/{courseId}/students",
634 "response": {
635 "$ref": "ListStudentsResponse"
636 },
637 "scopes": [
638 "https://www.googleapis.com/auth/classroom.profi le.emails",
639 "https://www.googleapis.com/auth/classroom.profi le.photos",
640 "https://www.googleapis.com/auth/classroom.roste rs",
641 "https://www.googleapis.com/auth/classroom.roste rs.readonly"
642 ]
643 }
644 }
645 }
646 }
647 },
648 "invitations": {
649 "methods": {
650 "create": {
651 "description": "Creates a invitation. Only one invitation fo r a user and course may exist at a time. Delete and recreate an invitation to ma ke changes. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course. * `NOT_FOUND` if the course or the user does not exist. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.",
652 "httpMethod": "POST",
653 "id": "classroom.invitations.create",
654 "path": "v1/invitations",
655 "request": {
656 "$ref": "Invitation"
657 },
658 "response": {
659 "$ref": "Invitation"
660 },
661 "scopes": [
662 "https://www.googleapis.com/auth/classroom.rosters"
663 ]
664 },
665 "get": {
666 "description": "Returns a invitation. This method returns th e following error codes: * `PERMISSION_DENIED` if the requesting user is not per mitted to view the requested invitation. * `NOT_FOUND` if no invitation exists w ith the requested ID.",
667 "httpMethod": "GET",
668 "id": "classroom.invitations.get",
669 "parameterOrder": [
670 "id"
671 ],
672 "parameters": {
673 "id": {
674 "description": "Identifier of the invitation to retu rn.",
675 "location": "path",
676 "required": true,
677 "type": "string"
678 }
679 },
680 "path": "v1/invitations/{id}",
681 "response": {
682 "$ref": "Invitation"
683 },
684 "scopes": [
685 "https://www.googleapis.com/auth/classroom.rosters",
686 "https://www.googleapis.com/auth/classroom.rosters.reado nly"
687 ]
688 },
689 "delete": {
690 "description": "Deletes a invitation. This method returns th e following error codes: * `PERMISSION_DENIED` if the requesting user is not per mitted to delete the requested invitation. * `NOT_FOUND` if no invitation exists with the requested ID.",
691 "httpMethod": "DELETE",
692 "id": "classroom.invitations.delete",
693 "parameterOrder": [
694 "id"
695 ],
696 "parameters": {
697 "id": {
698 "description": "Identifier of the invitation to dele te.",
699 "location": "path",
700 "required": true,
701 "type": "string"
702 }
703 },
704 "path": "v1/invitations/{id}",
705 "response": {
706 "$ref": "Empty"
707 },
708 "scopes": [
709 "https://www.googleapis.com/auth/classroom.rosters"
710 ]
711 },
712 "list": {
713 "description": "Returns a list of invitations that the reque sting user is permitted to view, restricted to those that match the request. *No te:* At least one of `user_id` or `course_id` must be supplied.",
714 "httpMethod": "GET",
715 "id": "classroom.invitations.list",
716 "parameters": {
717 "userId": {
718 "description": "Restricts returned invitations to th ose for a specific user. This may be the unique identifier for the user or an al ias. The supported aliases are: * the e-mail address of the user * the string li teral `\"me\"`, indicating the requesting user",
719 "location": "query",
720 "type": "string"
721 },
722 "courseId": {
723 "description": "Restricts returned invitations to th ose for a course with the specified identifier.",
724 "location": "query",
725 "type": "string"
726 },
727 "pageSize": {
728 "description": "The maximum number of items to retur n. Zero means no maximum. The server may return fewer than the specified number of results.",
729 "format": "int32",
730 "location": "query",
731 "type": "integer"
732 },
733 "pageToken": {
734 "description": "[nextPageToken][google.classroom.v1. ListInvitationsRespnse.next_page_token] value returned from a previous [list][go ogle.classroom.v1.Users.ListInvitations] call, indicating that the subsequent pa ge of results should be returned. The [list][google.classroom.v1.Users.ListInvit ations] request must be identical to the one which resulted in this token.",
735 "location": "query",
736 "type": "string"
737 }
738 },
739 "path": "v1/invitations",
740 "response": {
741 "$ref": "ListInvitationsResponse"
742 },
743 "scopes": [
744 "https://www.googleapis.com/auth/classroom.rosters",
745 "https://www.googleapis.com/auth/classroom.rosters.reado nly"
746 ]
747 },
748 "accept": {
749 "description": "Accepts an invitation, removing it and addin g the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not perm itted to accept the requested invitation. * `NOT_FOUND` if no invitation exists with the requested ID.",
750 "httpMethod": "POST",
751 "id": "classroom.invitations.accept",
752 "parameterOrder": [
753 "id"
754 ],
755 "parameters": {
756 "id": {
757 "description": "Identifier of the invitation to acce pt.",
758 "location": "path",
759 "required": true,
760 "type": "string"
761 }
762 },
763 "path": "v1/invitations/{id}:accept",
764 "response": {
765 "$ref": "Empty"
766 },
767 "scopes": [
768 "https://www.googleapis.com/auth/classroom.rosters"
769 ]
770 }
771 }
772 },
773 "userProfiles": {
774 "methods": {
775 "get": {
776 "description": "Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not p ermitted to access this user profile. * `NOT_FOUND` if the profile does not exis t.",
777 "httpMethod": "GET",
778 "id": "classroom.userProfiles.get",
779 "parameterOrder": [
780 "userId"
781 ],
782 "parameters": {
783 "userId": {
784 "description": "Identifier of the profile to return, or an alias the identifies the user. The following aliases are supported: * the e-mail address of the user * the string literal `\"me\"`, indicating the reques ting user",
785 "location": "path",
786 "required": true,
787 "type": "string"
788 }
789 },
790 "path": "v1/userProfiles/{userId}",
791 "response": {
792 "$ref": "UserProfile"
793 },
794 "scopes": [
795 "https://www.googleapis.com/auth/classroom.profile.email s",
796 "https://www.googleapis.com/auth/classroom.profile.photo s",
797 "https://www.googleapis.com/auth/classroom.rosters",
798 "https://www.googleapis.com/auth/classroom.rosters.reado nly"
799 ]
800 }
801 }
802 }
803 },
804 "revision": "20150628",
805 "rootUrl": "https://classroom.googleapis.com/",
806 "schemas": {
807 "Course": {
808 "description": "A Course in Classroom.",
809 "id": "Course",
810 "properties": {
811 "id": {
812 "description": "Unique identifier for this course assigned b y Classroom. You may optionally set this to an [alias string][google.classroom.v 1.CourseAlias] as part of [creating a course][google.classroom.v1.Courses.Create Course], creating a corresponding alias. The `ID` cannot be updated after a cour se is created. Specifying this field in a course update mask will result in an e rror.",
813 "type": "string"
814 },
815 "name": {
816 "description": "Name of the course. For example, \"10th Grad e Biology\". This is required and must be between 1 and 750 characters and a val id UTF-8 string.",
817 "type": "string"
818 },
819 "section": {
820 "description": "Section of the course For example, \"Period 2\". If set, this field must be a valid UTF-8 string and no longer than 2800 cha racters.",
821 "type": "string"
822 },
823 "descriptionHeading": {
824 "description": "Optional heading for the description. For ex ample, \"Welcome to 10th Grade Biology\" If set, this field must be a valid UTF- 8 string and no longer than 3600 characters.",
825 "type": "string"
826 },
827 "description": {
828 "description": "Optional description. For example, \"We'll b e learning about about the structure of living creatures from a combination of t extbooks, guest lectures, and lab work. Expect to be excited!\" If set, this fie ld must be a valid UTF-8 string and no longer than 30,000 characters.",
829 "type": "string"
830 },
831 "room": {
832 "description": "Optional room location. For example, \"301\" If set, this field must be a valid UTF-8 string and no longer than 650 characte rs.",
833 "type": "string"
834 },
835 "ownerId": {
836 "description": "The identifier of the owner (and primary tea cher) of a course. When specified as a parameter of CreateCourseRequest, this fi eld is required. It may be the numeric identifier for the user, or an alias that identifies the owner. The following aliases are supported: * the e-mail address of the user * the string literal `\"me\"`, indicating that the requesting user This must be set in a CreateRequest; specifying this field in a course update ma sk will result in an error.",
837 "type": "string"
838 },
839 "creationTime": {
840 "description": "Creation time of the course. Specifying this field in a course update mask will result in an error. Read-only.",
841 "type": "string"
842 },
843 "updateTime": {
844 "description": "Time of the most recent update to this cours e. Specifying this field in a course update mask will result in an error. Read-o nly.",
845 "type": "string"
846 },
847 "enrollmentCode": {
848 "description": "Enrollment code to use when joining this cou rse. Specifying this field in a course update mask will result in an error. Read -only.",
849 "type": "string"
850 },
851 "courseState": {
852 "description": "State of the course. If unspecified, the def ault state will be `PROVISIONED`.",
853 "enum": [
854 "COURSE_STATE_UNSPECIFIED",
855 "ACTIVE",
856 "ARCHIVED",
857 "PROVISIONED",
858 "DECLINED"
859 ],
860 "type": "string"
861 },
862 "alternateLink": {
863 "description": "Absolute link to this course in the Classroo m web UI. Read-only.",
864 "type": "string"
865 }
866 },
867 "type": "object"
868 },
869 "Empty": {
870 "description": "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 re presentation for `Empty` is empty JSON object `{}`.",
871 "id": "Empty",
872 "type": "object"
873 },
874 "ListCoursesResponse": {
875 "description": "Response when listing courses.",
876 "id": "ListCoursesResponse",
877 "properties": {
878 "courses": {
879 "description": "Courses that match the request.",
880 "items": {
881 "$ref": "Course"
882 },
883 "type": "array"
884 },
885 "nextPageToken": {
886 "description": "Token identifying the next page of results t o return. If empty, no further results are available.",
887 "type": "string"
888 }
889 },
890 "type": "object"
891 },
892 "CourseAlias": {
893 "description": "Alternative identifier for a course. An alias unique ly identifies a course. It will be unique within one of the following scopes: * domain: A domain-scoped alias is visible to all users within the alias creator's domain and may only be created by a domain admin. A domain-scoped alias is ofte n used when a course has an identifier external to Classroom. * project: A proje ct-scoped alias is visible to any request from an application using the Develope r Console Project ID that created the alias and may be created by any project. A project-scoped alias is often used when an application has alternative identifi ers. A random value can also be used to avoid duplicate courses in the event of transmission failures, as retrying a request will return ALREADY_EXISTS if a pre vious one has succeeded.",
894 "id": "CourseAlias",
895 "properties": {
896 "alias": {
897 "description": "Alias string. The format of the string indic ated the desired alias scoping. * \"d:\" indicates a domain-scoped alias. Exampl e: d:math_101 * \"p:\" indicates a project-scoped alias. Example: p:abc123 This field has a maximum length of 256 characters.",
898 "type": "string"
899 }
900 },
901 "type": "object"
902 },
903 "ListCourseAliasesResponse": {
904 "description": "Response when listing course aliases.",
905 "id": "ListCourseAliasesResponse",
906 "properties": {
907 "aliases": {
908 "description": "The course aliases.",
909 "items": {
910 "$ref": "CourseAlias"
911 },
912 "type": "array"
913 },
914 "nextPageToken": {
915 "description": "Token identifying the next page of results t o return. If empty, no further results are available.",
916 "type": "string"
917 }
918 },
919 "type": "object"
920 },
921 "Invitation": {
922 "description": "An invitation to join a course.",
923 "id": "Invitation",
924 "properties": {
925 "id": {
926 "description": "Unique identifier assigned by Classroom. Rea d-only",
927 "type": "string"
928 },
929 "userId": {
930 "description": "Identifier of the invited user. When specifi ed as a parameter of a request, this may be set to an alias that identifies the user to invite. The supported aliases are: * the e-mail address of the user * th e string literal `\"me\"`, indicating that the requesting user",
931 "type": "string"
932 },
933 "courseId": {
934 "description": "Identifier of the course to invite the user to.",
935 "type": "string"
936 },
937 "role": {
938 "description": "Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.",
939 "enum": [
940 "COURSE_ROLE_UNSPECIFIED",
941 "STUDENT",
942 "TEACHER"
943 ],
944 "type": "string"
945 }
946 },
947 "type": "object"
948 },
949 "ListInvitationsResponse": {
950 "description": "Response when listing invitations.",
951 "id": "ListInvitationsResponse",
952 "properties": {
953 "invitations": {
954 "description": "Invitations that match the request.",
955 "items": {
956 "$ref": "Invitation"
957 },
958 "type": "array"
959 },
960 "nextPageToken": {
961 "description": "Token identifying the next page of results t o return. If empty, no further results are available.",
962 "type": "string"
963 }
964 },
965 "type": "object"
966 },
967 "UserProfile": {
968 "description": "Global information for a user.",
969 "id": "UserProfile",
970 "properties": {
971 "id": {
972 "description": "Unique identifier of the user. Read-only",
973 "type": "string"
974 },
975 "name": {
976 "$ref": "Name",
977 "description": "Name of the user. Read-only"
978 },
979 "emailAddress": {
980 "description": "E-mail address of the user. Read-only",
981 "type": "string"
982 },
983 "photoUrl": {
984 "description": "Url of user's profile photo. Read-only",
985 "type": "string"
986 },
987 "permissions": {
988 "description": "Global permissions of the user. Read-only",
989 "items": {
990 "$ref": "GlobalPermission"
991 },
992 "type": "array"
993 }
994 },
995 "type": "object"
996 },
997 "Name": {
998 "description": "Details of the user's name.",
999 "id": "Name",
1000 "properties": {
1001 "givenName": {
1002 "description": "The user's first name. Read-only",
1003 "type": "string"
1004 },
1005 "familyName": {
1006 "description": "The user's last name. Read-only",
1007 "type": "string"
1008 },
1009 "fullName": {
1010 "description": "The user's full name formed by concatenating the first and last name values. Read-only",
1011 "type": "string"
1012 }
1013 },
1014 "type": "object"
1015 },
1016 "GlobalPermission": {
1017 "description": "Global user permission description.",
1018 "id": "GlobalPermission",
1019 "properties": {
1020 "permission": {
1021 "description": "Permission value.",
1022 "enum": [
1023 "PERMISSION_UNSPECIFIED",
1024 "CREATE_COURSE"
1025 ],
1026 "type": "string"
1027 }
1028 },
1029 "type": "object"
1030 },
1031 "Teacher": {
1032 "description": "Teacher of a course.",
1033 "id": "Teacher",
1034 "properties": {
1035 "courseId": {
1036 "description": "Unique identifier of the course. Read-only",
1037 "type": "string"
1038 },
1039 "userId": {
1040 "description": "The identifier of the user. When specified a s a parameter of request, this field may be set to an alias that identifies the teacher. The following are supported: * the e-mail address of the user * the str ing literal `\"me\"`, indicating the requesting user",
1041 "type": "string"
1042 },
1043 "profile": {
1044 "$ref": "UserProfile",
1045 "description": "Global user information for the teacher. Rea d-only"
1046 }
1047 },
1048 "type": "object"
1049 },
1050 "ListTeachersResponse": {
1051 "description": "Response when listing teachers.",
1052 "id": "ListTeachersResponse",
1053 "properties": {
1054 "teachers": {
1055 "description": "The teachers who match the list request.",
1056 "items": {
1057 "$ref": "Teacher"
1058 },
1059 "type": "array"
1060 },
1061 "nextPageToken": {
1062 "description": "Token identifying the next page of results t o return. If empty, no further results are available.",
1063 "type": "string"
1064 }
1065 },
1066 "type": "object"
1067 },
1068 "Student": {
1069 "description": "Student in a course.",
1070 "id": "Student",
1071 "properties": {
1072 "courseId": {
1073 "description": "Unique identifier of the course. Read-only",
1074 "type": "string"
1075 },
1076 "userId": {
1077 "description": "The identifier of the user. When specified a s a parameter of request, this field may be set to an alias that identifies the student. The following are supported: * the e-mail address of the user * the str ing literal `\"me\"`, indicating that the requesting user",
1078 "type": "string"
1079 },
1080 "profile": {
1081 "$ref": "UserProfile",
1082 "description": "Global user information for the student. Rea d-only"
1083 }
1084 },
1085 "type": "object"
1086 },
1087 "ListStudentsResponse": {
1088 "description": "Response when listing students.",
1089 "id": "ListStudentsResponse",
1090 "properties": {
1091 "students": {
1092 "description": "The students who match the list request.",
1093 "items": {
1094 "$ref": "Student"
1095 },
1096 "type": "array"
1097 },
1098 "nextPageToken": {
1099 "description": "Token identifying the next page of results t o return. If empty, no further results are available.",
1100 "type": "string"
1101 }
1102 },
1103 "type": "object"
1104 }
1105 },
1106 "servicePath": "",
1107 "title": "Google Classroom API",
1108 "version": "v1"
1109 }
OLDNEW
« no previous file with comments | « discovery/googleapis/civicinfo__v2.json ('k') | discovery/googleapis/clouddebugger__v2.json » ('j') | discovery/googleapis/dfareporting__v2.0.json » ('J')

Powered by Google App Engine
This is Rietveld 408576698