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

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

Issue 2649893002: Api-roll 44: 2017-01-23 (Closed)
Patch Set: Created 3 years, 11 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/calendar__v3.json ('k') | discovery/googleapis/cloudbuild__v1.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 { 1 {
2 "auth": { 2 "auth": {
3 "oauth2": { 3 "oauth2": {
4 "scopes": { 4 "scopes": {
5 "https://www.googleapis.com/auth/classroom.course-work.readonly" : { 5 "https://www.googleapis.com/auth/classroom.course-work.readonly" : {
6 "description": "View instructions for teacher-assigned work in your Google Classroom classes" 6 "description": "View instructions for teacher-assigned work in your Google Classroom classes"
7 }, 7 },
8 "https://www.googleapis.com/auth/classroom.courses": { 8 "https://www.googleapis.com/auth/classroom.courses": {
9 "description": "Manage your Google Classroom classes" 9 "description": "Manage your Google Classroom classes"
10 }, 10 },
(...skipping 32 matching lines...) Expand 10 before | Expand all | Expand 10 after
43 } 43 }
44 } 44 }
45 } 45 }
46 }, 46 },
47 "basePath": "", 47 "basePath": "",
48 "baseUrl": "https://classroom.googleapis.com/", 48 "baseUrl": "https://classroom.googleapis.com/",
49 "batchPath": "batch", 49 "batchPath": "batch",
50 "description": "Manages classes, rosters, and invitations in Google Classroo m.", 50 "description": "Manages classes, rosters, and invitations in Google Classroo m.",
51 "discoveryVersion": "v1", 51 "discoveryVersion": "v1",
52 "documentationLink": "https://developers.google.com/classroom/", 52 "documentationLink": "https://developers.google.com/classroom/",
53 "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/mk_oLjlaBwJ1BcBJ5yykCFb6u3w\"", 53 "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/VPjAdAuQhi94i4H_5Zyjop6mRoc\"",
54 "icons": { 54 "icons": {
55 "x16": "http://www.google.com/images/icons/product/search-16.gif", 55 "x16": "http://www.google.com/images/icons/product/search-16.gif",
56 "x32": "http://www.google.com/images/icons/product/search-32.gif" 56 "x32": "http://www.google.com/images/icons/product/search-32.gif"
57 }, 57 },
58 "id": "classroom:v1", 58 "id": "classroom:v1",
59 "kind": "discovery#restDescription", 59 "kind": "discovery#restDescription",
60 "name": "classroom", 60 "name": "classroom",
61 "ownerDomain": "google.com", 61 "ownerDomain": "google.com",
62 "ownerName": "Google", 62 "ownerName": "Google",
63 "parameters": { 63 "parameters": {
(...skipping 609 matching lines...) Expand 10 before | Expand all | Expand 10 after
673 "https://www.googleapis.com/auth/classroom.profi le.photos", 673 "https://www.googleapis.com/auth/classroom.profi le.photos",
674 "https://www.googleapis.com/auth/classroom.roste rs", 674 "https://www.googleapis.com/auth/classroom.roste rs",
675 "https://www.googleapis.com/auth/classroom.roste rs.readonly" 675 "https://www.googleapis.com/auth/classroom.roste rs.readonly"
676 ] 676 ]
677 } 677 }
678 } 678 }
679 }, 679 },
680 "courseWork": { 680 "courseWork": {
681 "methods": { 681 "methods": {
682 "create": { 682 "create": {
683 "description": "Creates course work. The resulting c ourse work (and corresponding student submissions) are associated with the Devel oper Console project of the [OAuth client ID](https://support.google.com/cloud/a nswer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the asso ciated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the req uested course, create course work in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requeste d course does not exist.", 683 "description": "Creates course work. The resulting c ourse work (and corresponding student submissions) are associated with the Devel oper Console project of the [OAuth client ID](https://support.google.com/cloud/a nswer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the asso ciated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the req uested course, create course work in the requested course, share a Drive attachm ent, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * ` NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for t he following request error: * AttachmentNotVisible",
684 "httpMethod": "POST", 684 "httpMethod": "POST",
685 "id": "classroom.courses.courseWork.create", 685 "id": "classroom.courses.courseWork.create",
686 "parameterOrder": [ 686 "parameterOrder": [
687 "courseId" 687 "courseId"
688 ], 688 ],
689 "parameters": { 689 "parameters": {
690 "courseId": { 690 "courseId": {
691 "description": "Identifier of the course. Th is identifier can be either the Classroom-assigned identifier or an alias.", 691 "description": "Identifier of the course. Th is identifier can be either the Classroom-assigned identifier or an alias.",
692 "location": "path", 692 "location": "path",
693 "required": true, 693 "required": true,
694 "type": "string" 694 "type": "string"
695 } 695 }
696 }, 696 },
697 "path": "v1/courses/{courseId}/courseWork", 697 "path": "v1/courses/{courseId}/courseWork",
698 "request": { 698 "request": {
699 "$ref": "CourseWork" 699 "$ref": "CourseWork"
700 }, 700 },
701 "response": { 701 "response": {
702 "$ref": "CourseWork" 702 "$ref": "CourseWork"
703 }, 703 },
704 "scopes": [ 704 "scopes": [
705 "https://www.googleapis.com/auth/classroom.cours ework.students" 705 "https://www.googleapis.com/auth/classroom.cours ework.students"
706 ] 706 ]
707 }, 707 },
708 "patch": {
709 "description": "Updates one or more fields of a cour se work. See google.classroom.v1.CourseWork for details of which fields may be u pdated and who may change them. This request must be made by the Developer Conso le project of the [OAuth client ID](https://support.google.com/cloud/answer/6158 849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to m ake the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.",
710 "httpMethod": "PATCH",
711 "id": "classroom.courses.courseWork.patch",
712 "parameterOrder": [
713 "courseId",
714 "id"
715 ],
716 "parameters": {
717 "courseId": {
718 "description": "Identifier of the course. Th is identifier can be either the Classroom-assigned identifier or an alias.",
719 "location": "path",
720 "required": true,
721 "type": "string"
722 },
723 "id": {
724 "description": "Identifier of the course wor k.",
725 "location": "path",
726 "required": true,
727 "type": "string"
728 },
729 "updateMask": {
730 "description": "Mask that identifies which f ields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an `INVALID_ARGUMENT` error will be r eturned. The following fields may be specified by teachers: * `title` * `descrip tion` * `state` * `due_date` * `due_time` * `max_points` * `submission_modificat ion_mode`",
731 "location": "query",
732 "type": "string"
733 }
734 },
735 "path": "v1/courses/{courseId}/courseWork/{id}",
736 "request": {
737 "$ref": "CourseWork"
738 },
739 "response": {
740 "$ref": "CourseWork"
741 },
742 "scopes": [
743 "https://www.googleapis.com/auth/classroom.cours ework.students"
744 ]
745 },
746 "delete": {
747 "description": "Deletes a course work. This request must be made by the Developer Console project of the [OAuth client ID](https://s upport.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work , if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.",
748 "httpMethod": "DELETE",
749 "id": "classroom.courses.courseWork.delete",
750 "parameterOrder": [
751 "courseId",
752 "id"
753 ],
754 "parameters": {
755 "courseId": {
756 "description": "Identifier of the course. Th is identifier can be either the Classroom-assigned identifier or an alias.",
757 "location": "path",
758 "required": true,
759 "type": "string"
760 },
761 "id": {
762 "description": "Identifier of the course wor k to delete. This identifier is a Classroom-assigned identifier.",
763 "location": "path",
764 "required": true,
765 "type": "string"
766 }
767 },
768 "path": "v1/courses/{courseId}/courseWork/{id}",
769 "response": {
770 "$ref": "Empty"
771 },
772 "scopes": [
773 "https://www.googleapis.com/auth/classroom.cours ework.students"
774 ]
775 },
708 "get": { 776 "get": {
709 "description": "Returns course work. This method ret urns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access error s. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the reques ted course or course work does not exist.", 777 "description": "Returns course work. This method ret urns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access error s. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the reques ted course or course work does not exist.",
710 "httpMethod": "GET", 778 "httpMethod": "GET",
711 "id": "classroom.courses.courseWork.get", 779 "id": "classroom.courses.courseWork.get",
712 "parameterOrder": [ 780 "parameterOrder": [
713 "courseId", 781 "courseId",
714 "id" 782 "id"
715 ], 783 ],
716 "parameters": { 784 "parameters": {
717 "courseId": { 785 "courseId": {
(...skipping 277 matching lines...) Expand 10 before | Expand all | Expand 10 after
995 "$ref": "TurnInStudentSubmissionRequest" 1063 "$ref": "TurnInStudentSubmissionRequest"
996 }, 1064 },
997 "response": { 1065 "response": {
998 "$ref": "Empty" 1066 "$ref": "Empty"
999 }, 1067 },
1000 "scopes": [ 1068 "scopes": [
1001 "https://www.googleapis.com/auth/classro om.coursework.me" 1069 "https://www.googleapis.com/auth/classro om.coursework.me"
1002 ] 1070 ]
1003 }, 1071 },
1004 "reclaim": { 1072 "reclaim": {
1005 "description": "Reclaims a student submissio n on behalf of the student that owns it. Reclaiming a student submission transfe rs ownership of attached Drive files to the student and update the submission st ate. Only the student that ownes the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the [OAuth client ID](https://s upport.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILE D_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARG UMENT` if the request is malformed. * `NOT_FOUND` if the requested course, cours e work, or student submission does not exist.", 1073 "description": "Reclaims a student submissio n on behalf of the student that owns it. Reclaiming a student submission transfe rs ownership of attached Drive files to the student and update the submission st ate. Only the student that owns the requested student submission may call this m ethod, and only for a student submission that has been turned in. This request m ust be made by the Developer Console project of the [OAuth client ID](https://su pport.google.com/cloud/answer/6158849) used to create the corresponding course w ork item. This method returns the following error codes: * `PERMISSION_DENIED` i f the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED _PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGU MENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.",
1006 "httpMethod": "POST", 1074 "httpMethod": "POST",
1007 "id": "classroom.courses.courseWork.studentS ubmissions.reclaim", 1075 "id": "classroom.courses.courseWork.studentS ubmissions.reclaim",
1008 "parameterOrder": [ 1076 "parameterOrder": [
1009 "courseId", 1077 "courseId",
1010 "courseWorkId", 1078 "courseWorkId",
1011 "id" 1079 "id"
1012 ], 1080 ],
1013 "parameters": { 1081 "parameters": {
1014 "courseId": { 1082 "courseId": {
1015 "description": "Identifier of the co urse. This identifier can be either the Classroom-assigned identifier or an alia s.", 1083 "description": "Identifier of the co urse. This identifier can be either the Classroom-assigned identifier or an alia s.",
(...skipping 59 matching lines...) Expand 10 before | Expand all | Expand 10 after
1075 "$ref": "ReturnStudentSubmissionRequest" 1143 "$ref": "ReturnStudentSubmissionRequest"
1076 }, 1144 },
1077 "response": { 1145 "response": {
1078 "$ref": "Empty" 1146 "$ref": "Empty"
1079 }, 1147 },
1080 "scopes": [ 1148 "scopes": [
1081 "https://www.googleapis.com/auth/classro om.coursework.students" 1149 "https://www.googleapis.com/auth/classro om.coursework.students"
1082 ] 1150 ]
1083 }, 1151 },
1084 "modifyAttachments": { 1152 "modifyAttachments": {
1085 "description": "Modifies attachments of stud ent submission. Attachments may only be added to student submissions whose type is `ASSIGNMENT`. This request must be made by the Developer Console project of t he [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to cr eate the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify atta chments on the requested student submission, or for access errors. * `INVALID_AR GUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, cour se work, or student submission does not exist.", 1153 "description": "Modifies attachments of stud ent submission. Attachments may only be added to student submissions belonging t o course work objects with a `workType` of `ASSIGNMENT`. This request must be ma de by the Developer Console project of the [OAuth client ID](https://support.goo gle.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the req uesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submiss ion, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * ` NOT_FOUND` if the requested course, course work, or student submission does not exist.",
1086 "httpMethod": "POST", 1154 "httpMethod": "POST",
1087 "id": "classroom.courses.courseWork.studentS ubmissions.modifyAttachments", 1155 "id": "classroom.courses.courseWork.studentS ubmissions.modifyAttachments",
1088 "parameterOrder": [ 1156 "parameterOrder": [
1089 "courseId", 1157 "courseId",
1090 "courseWorkId", 1158 "courseWorkId",
1091 "id" 1159 "id"
1092 ], 1160 ],
1093 "parameters": { 1161 "parameters": {
1094 "courseId": { 1162 "courseId": {
1095 "description": "Identifier of the co urse. This identifier can be either the Classroom-assigned identifier or an alia s.", 1163 "description": "Identifier of the co urse. This identifier can be either the Classroom-assigned identifier or an alia s.",
(...skipping 28 matching lines...) Expand all
1124 } 1192 }
1125 } 1193 }
1126 } 1194 }
1127 } 1195 }
1128 } 1196 }
1129 } 1197 }
1130 }, 1198 },
1131 "userProfiles": { 1199 "userProfiles": {
1132 "methods": { 1200 "methods": {
1133 "get": { 1201 "get": {
1134 "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 or if no profile exists with the requested ID or for access errors.", 1202 "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, if no profile exists with the requested ID , or for access errors.",
1135 "httpMethod": "GET", 1203 "httpMethod": "GET",
1136 "id": "classroom.userProfiles.get", 1204 "id": "classroom.userProfiles.get",
1137 "parameterOrder": [ 1205 "parameterOrder": [
1138 "userId" 1206 "userId"
1139 ], 1207 ],
1140 "parameters": { 1208 "parameters": {
1141 "userId": { 1209 "userId": {
1142 "description": "Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the us er * the email address of the user * the string literal `\"me\"`, indicating the requesting user", 1210 "description": "Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the us er * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
1143 "location": "path", 1211 "location": "path",
1144 "required": true, 1212 "required": true,
(...skipping 181 matching lines...) Expand 10 before | Expand all | Expand 10 after
1326 "location": "query", 1394 "location": "query",
1327 "type": "integer" 1395 "type": "integer"
1328 } 1396 }
1329 }, 1397 },
1330 "path": "v1/userProfiles/{studentId}/guardians", 1398 "path": "v1/userProfiles/{studentId}/guardians",
1331 "response": { 1399 "response": {
1332 "$ref": "ListGuardiansResponse" 1400 "$ref": "ListGuardiansResponse"
1333 } 1401 }
1334 }, 1402 },
1335 "get": { 1403 "get": {
1336 "description": "Returns a specific guardian. This me thod returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian information for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or f or other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if Classroom cannot f ind any record of the given student or `guardian_id`, or if the guardian has bee n disabled.", 1404 "description": "Returns a specific guardian. This me thod returns the following error codes: * `PERMISSION_DENIED` if no user that ma tches the provided `student_id` is visible to the requesting user, if the reques ting user is not permitted to view guardian information for the student identifi ed by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified , but its format cannot be recognized (it is not an email address, nor a `studen t_id` from the API, nor the literal string `me`). * `NOT_FOUND` if the requestin g user is permitted to view guardians for the requested `student_id`, but no `Gu ardian` record exists for that student that matches the provided `guardian_id`." ,
1337 "httpMethod": "GET", 1405 "httpMethod": "GET",
1338 "id": "classroom.userProfiles.guardians.get", 1406 "id": "classroom.userProfiles.guardians.get",
1339 "parameterOrder": [ 1407 "parameterOrder": [
1340 "studentId", 1408 "studentId",
1341 "guardianId" 1409 "guardianId"
1342 ], 1410 ],
1343 "parameters": { 1411 "parameters": {
1344 "studentId": { 1412 "studentId": {
1345 "description": "The student whose guardian i s being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the req uesting user", 1413 "description": "The student whose guardian i s being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the req uesting user",
1346 "location": "path", 1414 "location": "path",
1347 "required": true, 1415 "required": true,
1348 "type": "string" 1416 "type": "string"
1349 }, 1417 },
1350 "guardianId": { 1418 "guardianId": {
1351 "description": "The `id` field from a `Guard ian`.", 1419 "description": "The `id` field from a `Guard ian`.",
1352 "location": "path", 1420 "location": "path",
1353 "required": true, 1421 "required": true,
1354 "type": "string" 1422 "type": "string"
1355 } 1423 }
1356 }, 1424 },
1357 "path": "v1/userProfiles/{studentId}/guardians/{guar dianId}", 1425 "path": "v1/userProfiles/{studentId}/guardians/{guar dianId}",
1358 "response": { 1426 "response": {
1359 "$ref": "Guardian" 1427 "$ref": "Guardian"
1360 } 1428 }
1361 }, 1429 },
1362 "delete": { 1430 "delete": {
1363 "description": "Deletes a guardian. The guardian wil l no longer receive guardian notifications and the guardian will no longer be ac cessible via the API. This method returns the following error codes: * `PERMISSI ON_DENIED` if the requesting user is not permitted to manage guardians for the s tudent identified by the `student_id`, if guardians are not enabled for the doma in in question, or for other access errors. * `INVALID_ARGUMENT` if a `student_i d` is specified, but its format cannot be recognized (it is not an email address , nor a `student_id` from the API). * `NOT_FOUND` if Classroom cannot find any r ecord of the given `student_id` or `guardian_id`, or if the guardian has already been disabled.", 1431 "description": "Deletes a guardian. The guardian wil l no longer receive guardian notifications and the guardian will no longer be ac cessible via the API. This method returns the following error codes: * `PERMISSI ON_DENIED` if no user that matches the provided `student_id` is visible to the r equesting user, if the requesting user is not permitted to manage guardians for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. * `INVALID_ARGUMENT` if a `stud ent_id` is specified, but its format cannot be recognized (it is not an email ad dress, nor a `student_id` from the API). * `NOT_FOUND` if the requesting user is permitted to modify guardians for the requested `student_id`, but no `Guardian` record exists for that student with the provided `guardian_id`.",
1364 "httpMethod": "DELETE", 1432 "httpMethod": "DELETE",
1365 "id": "classroom.userProfiles.guardians.delete", 1433 "id": "classroom.userProfiles.guardians.delete",
1366 "parameterOrder": [ 1434 "parameterOrder": [
1367 "studentId", 1435 "studentId",
1368 "guardianId" 1436 "guardianId"
1369 ], 1437 ],
1370 "parameters": { 1438 "parameters": {
1371 "studentId": { 1439 "studentId": {
1372 "description": "The student whose guardian i s to be deleted. One of the following: * the numeric identifier for the user * t he email address of the user * the string literal `\"me\"`, indicating the reque sting user", 1440 "description": "The student whose guardian i s to be deleted. One of the following: * the numeric identifier for the user * t he email address of the user * the string literal `\"me\"`, indicating the reque sting user",
1373 "location": "path", 1441 "location": "path",
(...skipping 135 matching lines...) Expand 10 before | Expand all | Expand 10 after
1509 "response": { 1577 "response": {
1510 "$ref": "Empty" 1578 "$ref": "Empty"
1511 }, 1579 },
1512 "scopes": [ 1580 "scopes": [
1513 "https://www.googleapis.com/auth/classroom.rosters" 1581 "https://www.googleapis.com/auth/classroom.rosters"
1514 ] 1582 ]
1515 } 1583 }
1516 } 1584 }
1517 } 1585 }
1518 }, 1586 },
1519 "revision": "20161006", 1587 "revision": "20170110",
1520 "rootUrl": "https://classroom.googleapis.com/", 1588 "rootUrl": "https://classroom.googleapis.com/",
1521 "schemas": { 1589 "schemas": {
1522 "Course": { 1590 "Course": {
1523 "description": "A Course in Classroom.", 1591 "description": "A Course in Classroom.",
1524 "id": "Course", 1592 "id": "Course",
1525 "properties": { 1593 "properties": {
1526 "id": { 1594 "id": {
1527 "description": "Identifier for this course assigned by Class room. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assign ed by Classroom and cannot be updated after the course is created. Specifying th is field in a course update mask results in an error.", 1595 "description": "Identifier for this course assigned by Class room. When creating a course, you may optionally set this identifier to an alias string in the request to create a corresponding alias. The `id` is still assign ed by Classroom and cannot be updated after the course is created. Specifying th is field in a course update mask results in an error.",
1528 "type": "string" 1596 "type": "string"
1529 }, 1597 },
(...skipping 317 matching lines...) Expand 10 before | Expand all | Expand 10 after
1847 ], 1915 ],
1848 "type": "string" 1916 "type": "string"
1849 }, 1917 },
1850 "creationTime": { 1918 "creationTime": {
1851 "description": "The time that this invitation was created. R ead-only.", 1919 "description": "The time that this invitation was created. R ead-only.",
1852 "type": "string" 1920 "type": "string"
1853 } 1921 }
1854 }, 1922 },
1855 "type": "object" 1923 "type": "object"
1856 }, 1924 },
1857 "ListGuardiansResponse": {
1858 "description": "Response when listing guardians.",
1859 "id": "ListGuardiansResponse",
1860 "properties": {
1861 "guardians": {
1862 "description": "Guardians on this page of results that met t he criteria specified in the request.",
1863 "items": {
1864 "$ref": "Guardian"
1865 },
1866 "type": "array"
1867 },
1868 "nextPageToken": {
1869 "description": "Token identifying the next page of results t o return. If empty, no further results are available.",
1870 "type": "string"
1871 }
1872 },
1873 "type": "object"
1874 },
1875 "Guardian": {
1876 "description": "Association between a student and a guardian of that student. The guardian may receive information about the student's course work." ,
1877 "id": "Guardian",
1878 "properties": {
1879 "studentId": {
1880 "description": "Identifier for the student to whom the guard ian relationship applies.",
1881 "type": "string"
1882 },
1883 "guardianId": {
1884 "description": "Identifier for the guardian.",
1885 "type": "string"
1886 },
1887 "guardianProfile": {
1888 "$ref": "UserProfile",
1889 "description": "User profile for the guardian."
1890 },
1891 "invitedEmailAddress": {
1892 "description": "The email address to which the initial guard ian invitation was sent. This field is only visible to domain administrators.",
1893 "type": "string"
1894 }
1895 },
1896 "type": "object"
1897 },
1898 "UserProfile": { 1925 "UserProfile": {
1899 "description": "Global information for a user.", 1926 "description": "Global information for a user.",
1900 "id": "UserProfile", 1927 "id": "UserProfile",
1901 "properties": { 1928 "properties": {
1902 "id": { 1929 "id": {
1903 "description": "Identifier of the user. Read-only.", 1930 "description": "Identifier of the user. Read-only.",
1904 "type": "string" 1931 "type": "string"
1905 }, 1932 },
1906 "name": { 1933 "name": {
1907 "$ref": "Name", 1934 "$ref": "Name",
(...skipping 122 matching lines...) Expand 10 before | Expand all | Expand 10 after
2030 }, 2057 },
2031 "type": "array" 2058 "type": "array"
2032 }, 2059 },
2033 "nextPageToken": { 2060 "nextPageToken": {
2034 "description": "Token identifying the next page of results t o return. If empty, no further results are available.", 2061 "description": "Token identifying the next page of results t o return. If empty, no further results are available.",
2035 "type": "string" 2062 "type": "string"
2036 } 2063 }
2037 }, 2064 },
2038 "type": "object" 2065 "type": "object"
2039 }, 2066 },
2067 "ListGuardiansResponse": {
2068 "description": "Response when listing guardians.",
2069 "id": "ListGuardiansResponse",
2070 "properties": {
2071 "guardians": {
2072 "description": "Guardians on this page of results that met t he criteria specified in the request.",
2073 "items": {
2074 "$ref": "Guardian"
2075 },
2076 "type": "array"
2077 },
2078 "nextPageToken": {
2079 "description": "Token identifying the next page of results t o return. If empty, no further results are available.",
2080 "type": "string"
2081 }
2082 },
2083 "type": "object"
2084 },
2085 "Guardian": {
2086 "description": "Association between a student and a guardian of that student. The guardian may receive information about the student's course work." ,
2087 "id": "Guardian",
2088 "properties": {
2089 "studentId": {
2090 "description": "Identifier for the student to whom the guard ian relationship applies.",
2091 "type": "string"
2092 },
2093 "guardianId": {
2094 "description": "Identifier for the guardian.",
2095 "type": "string"
2096 },
2097 "guardianProfile": {
2098 "$ref": "UserProfile",
2099 "description": "User profile for the guardian."
2100 },
2101 "invitedEmailAddress": {
2102 "description": "The email address to which the initial guard ian invitation was sent. This field is only visible to domain administrators.",
2103 "type": "string"
2104 }
2105 },
2106 "type": "object"
2107 },
2040 "Invitation": { 2108 "Invitation": {
2041 "description": "An invitation to join a course.", 2109 "description": "An invitation to join a course.",
2042 "id": "Invitation", 2110 "id": "Invitation",
2043 "properties": { 2111 "properties": {
2044 "id": { 2112 "id": {
2045 "description": "Identifier assigned by Classroom. Read-only. ", 2113 "description": "Identifier assigned by Classroom. Read-only. ",
2046 "type": "string" 2114 "type": "string"
2047 }, 2115 },
2048 "userId": { 2116 "userId": {
2049 "description": "Identifier of the invited user. When specifi ed as a parameter of a request, this identifier can be set to one of the followi ng: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user", 2117 "description": "Identifier of the invited user. When specifi ed as a parameter of a request, this identifier can be set to one of the followi ng: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
(...skipping 89 matching lines...) Expand 10 before | Expand all | Expand 10 after
2139 "dueTime": { 2207 "dueTime": {
2140 "$ref": "TimeOfDay", 2208 "$ref": "TimeOfDay",
2141 "description": "Optional time of day, in UTC, that submissio ns for this this course work are due. This must be specified if `due_date` is sp ecified." 2209 "description": "Optional time of day, in UTC, that submissio ns for this this course work are due. This must be specified if `due_date` is sp ecified."
2142 }, 2210 },
2143 "maxPoints": { 2211 "maxPoints": {
2144 "description": "Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negat ive integer value.", 2212 "description": "Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negat ive integer value.",
2145 "format": "double", 2213 "format": "double",
2146 "type": "number" 2214 "type": "number"
2147 }, 2215 },
2148 "workType": { 2216 "workType": {
2149 "description": "Type of this course work. The type is set wh en the course work is created and cannot be changed. When creating course work, this must be `ASSIGNMENT`.", 2217 "description": "Type of this course work. The type is set wh en the course work is created and cannot be changed.",
2150 "enum": [ 2218 "enum": [
2151 "COURSE_WORK_TYPE_UNSPECIFIED", 2219 "COURSE_WORK_TYPE_UNSPECIFIED",
2152 "ASSIGNMENT", 2220 "ASSIGNMENT",
2153 "SHORT_ANSWER_QUESTION", 2221 "SHORT_ANSWER_QUESTION",
2154 "MULTIPLE_CHOICE_QUESTION" 2222 "MULTIPLE_CHOICE_QUESTION"
2155 ], 2223 ],
2156 "type": "string" 2224 "type": "string"
2157 }, 2225 },
2158 "associatedWithDeveloper": { 2226 "associatedWithDeveloper": {
2159 "description": "Whether this course work item is associated with the Developer Console project making the request. See google.classroom.Work .CreateCourseWork for more details. Read-only.", 2227 "description": "Whether this course work item is associated with the Developer Console project making the request. See google.classroom.Work .CreateCourseWork for more details. Read-only.",
2160 "type": "boolean" 2228 "type": "boolean"
2161 }, 2229 },
2162 "submissionModificationMode": { 2230 "submissionModificationMode": {
2163 "description": "Setting to determine when students are allow ed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL _TURNED_IN`.", 2231 "description": "Setting to determine when students are allow ed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL _TURNED_IN`.",
2164 "enum": [ 2232 "enum": [
2165 "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED", 2233 "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED",
2166 "MODIFIABLE_UNTIL_TURNED_IN", 2234 "MODIFIABLE_UNTIL_TURNED_IN",
2167 "MODIFIABLE" 2235 "MODIFIABLE"
2168 ], 2236 ],
2169 "type": "string" 2237 "type": "string"
2170 }, 2238 },
2171 "assignment": { 2239 "assignment": {
2172 "$ref": "Assignment", 2240 "$ref": "Assignment",
2173 "description": "Assignment details. This is populated only w hen `work_type` is `ASSIGNMENT`." 2241 "description": "Assignment details. This is populated only w hen `work_type` is `ASSIGNMENT`. Read-only."
2174 }, 2242 },
2175 "multipleChoiceQuestion": { 2243 "multipleChoiceQuestion": {
2176 "$ref": "MultipleChoiceQuestion", 2244 "$ref": "MultipleChoiceQuestion",
2177 "description": "Multiple choice question details. This is po pulated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`." 2245 "description": "Multiple choice question details. For read o perations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUE STION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set ot herwise."
2178 } 2246 }
2179 }, 2247 },
2180 "type": "object" 2248 "type": "object"
2181 }, 2249 },
2182 "Material": { 2250 "Material": {
2183 "description": "Material attached to course work. When creating atta chments, only the Link field may be specified.", 2251 "description": "Material attached to course work. When creating atta chments, setting the `form` field is not supported.",
2184 "id": "Material", 2252 "id": "Material",
2185 "properties": { 2253 "properties": {
2186 "driveFile": { 2254 "driveFile": {
2187 "$ref": "SharedDriveFile", 2255 "$ref": "SharedDriveFile",
2188 "description": "Google Drive file material." 2256 "description": "Google Drive file material."
2189 }, 2257 },
2190 "youtubeVideo": { 2258 "youtubeVideo": {
2191 "$ref": "YouTubeVideo", 2259 "$ref": "YouTubeVideo",
2192 "description": "YouTube video material." 2260 "description": "YouTube video material."
2193 }, 2261 },
2194 "link": { 2262 "link": {
2195 "$ref": "Link", 2263 "$ref": "Link",
2196 "description": "Link material." 2264 "description": "Link material. On creation, will be upgraded to a more appropriate type if possible, and this will be reflected in the respo nse."
2197 }, 2265 },
2198 "form": { 2266 "form": {
2199 "$ref": "Form", 2267 "$ref": "Form",
2200 "description": "Google Forms material." 2268 "description": "Google Forms material."
2201 } 2269 }
2202 }, 2270 },
2203 "type": "object" 2271 "type": "object"
2204 }, 2272 },
2205 "SharedDriveFile": { 2273 "SharedDriveFile": {
2206 "description": "Drive file that is used as material for course work. ", 2274 "description": "Drive file that is used as material for course work. ",
(...skipping 193 matching lines...) Expand 10 before | Expand all | Expand 10 after
2400 "description": "Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION." 2468 "description": "Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION."
2401 } 2469 }
2402 }, 2470 },
2403 "type": "object" 2471 "type": "object"
2404 }, 2472 },
2405 "AssignmentSubmission": { 2473 "AssignmentSubmission": {
2406 "description": "Student work for an assignment.", 2474 "description": "Student work for an assignment.",
2407 "id": "AssignmentSubmission", 2475 "id": "AssignmentSubmission",
2408 "properties": { 2476 "properties": {
2409 "attachments": { 2477 "attachments": {
2410 "description": "Attachments added by the student. Drive file s that correspond to materials with a share mode of SUBMISSION_COPY may not exis t yet if the student has not accessed the assignment in Classroom. Some attachme nt metadata is only populated if the requesting user has permission to access it . Identifier and alternate_link fields are available, but others (e.g. title) ma y not be.", 2478 "description": "Attachments added by the student. Drive file s that correspond to materials with a share mode of STUDENT_COPY may not exist y et if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. I dentifier and alternate_link fields are always available, but others (e.g. title ) may not be.",
2411 "items": { 2479 "items": {
2412 "$ref": "Attachment" 2480 "$ref": "Attachment"
2413 }, 2481 },
2414 "type": "array" 2482 "type": "array"
2415 } 2483 }
2416 }, 2484 },
2417 "type": "object" 2485 "type": "object"
2418 }, 2486 },
2419 "Attachment": { 2487 "Attachment": {
2420 "description": "Attachment added to student assignment work. When cr eating attachments, only the Link field may be specified.", 2488 "description": "Attachment added to student assignment work. When cr eating attachments, setting the `form` field is not supported.",
2421 "id": "Attachment", 2489 "id": "Attachment",
2422 "properties": { 2490 "properties": {
2423 "driveFile": { 2491 "driveFile": {
2424 "$ref": "DriveFile", 2492 "$ref": "DriveFile",
2425 "description": "Google Drive file attachment." 2493 "description": "Google Drive file attachment."
2426 }, 2494 },
2427 "youTubeVideo": { 2495 "youTubeVideo": {
2428 "$ref": "YouTubeVideo", 2496 "$ref": "YouTubeVideo",
2429 "description": "Youtube video attachment." 2497 "description": "Youtube video attachment."
2430 }, 2498 },
(...skipping 61 matching lines...) Expand 10 before | Expand all | Expand 10 after
2492 "ReturnStudentSubmissionRequest": { 2560 "ReturnStudentSubmissionRequest": {
2493 "description": "Request to return a student submission.", 2561 "description": "Request to return a student submission.",
2494 "id": "ReturnStudentSubmissionRequest", 2562 "id": "ReturnStudentSubmissionRequest",
2495 "type": "object" 2563 "type": "object"
2496 }, 2564 },
2497 "ModifyAttachmentsRequest": { 2565 "ModifyAttachmentsRequest": {
2498 "description": "Request to modify the attachments of a student submi ssion.", 2566 "description": "Request to modify the attachments of a student submi ssion.",
2499 "id": "ModifyAttachmentsRequest", 2567 "id": "ModifyAttachmentsRequest",
2500 "properties": { 2568 "properties": {
2501 "addAttachments": { 2569 "addAttachments": {
2502 "description": "Attachments to add. A student submission may not have more than 20 attachments. This may only contain link attachments.", 2570 "description": "Attachments to add. A student submission may not have more than 20 attachments. Form attachments are not supported.",
2503 "items": { 2571 "items": {
2504 "$ref": "Attachment" 2572 "$ref": "Attachment"
2505 }, 2573 },
2506 "type": "array" 2574 "type": "array"
2507 } 2575 }
2508 }, 2576 },
2509 "type": "object" 2577 "type": "object"
2510 } 2578 }
2511 }, 2579 },
2512 "servicePath": "", 2580 "servicePath": "",
2513 "title": "Google Classroom API", 2581 "title": "Google Classroom API",
2514 "version": "v1" 2582 "version": "v1"
2515 } 2583 }
OLDNEW
« no previous file with comments | « discovery/googleapis/calendar__v3.json ('k') | discovery/googleapis/cloudbuild__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698