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

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

Issue 2281923002: Api-roll 41: 2016-08-26 (Closed) Base URL: git@github.com:dart-lang/googleapis.git@master
Patch Set: Created 4 years, 3 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/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": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/CqYvNpV2Som-B9o1jdwhrzhRs18\"", 53 "etag": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/YsDe4FXJlhWXueJei0_RXQqm_4I\"",
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 818 matching lines...) Expand 10 before | Expand all | Expand 10 after
882 "courseWorkId" 882 "courseWorkId"
883 ], 883 ],
884 "parameters": { 884 "parameters": {
885 "courseId": { 885 "courseId": {
886 "description": "Identifier of the co urse. This identifier can be either the Classroom-assigned identifier or an alia s.", 886 "description": "Identifier of the co urse. This identifier can be either the Classroom-assigned identifier or an alia s.",
887 "location": "path", 887 "location": "path",
888 "required": true, 888 "required": true,
889 "type": "string" 889 "type": "string"
890 }, 890 },
891 "courseWorkId": { 891 "courseWorkId": {
892 "description": "Identifer of the stu dent work to request. If `user_id` is specified, this may be set to the string l iteral `\"-\"` to request student work for all course work in the specified cour se.", 892 "description": "Identifer of the stu dent work to request. This may be set to the string literal `\"-\"` to request s tudent work for all course work in the specified course.",
893 "location": "path", 893 "location": "path",
894 "required": true, 894 "required": true,
895 "type": "string" 895 "type": "string"
896 }, 896 },
897 "userId": { 897 "userId": {
898 "description": "Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following: * the numeric identifie r for the user * the email address of the user * the string literal `\"me\"`, in dicating the requesting user", 898 "description": "Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following: * the numeric identifie r for the user * the email address of the user * the string literal `\"me\"`, in dicating the requesting user",
899 "location": "query", 899 "location": "query",
900 "type": "string" 900 "type": "string"
901 }, 901 },
902 "states": { 902 "states": {
(...skipping 205 matching lines...) Expand 10 before | Expand all | Expand 10 after
1108 "https://www.googleapis.com/auth/classro om.coursework.me", 1108 "https://www.googleapis.com/auth/classro om.coursework.me",
1109 "https://www.googleapis.com/auth/classro om.coursework.students" 1109 "https://www.googleapis.com/auth/classro om.coursework.students"
1110 ] 1110 ]
1111 } 1111 }
1112 } 1112 }
1113 } 1113 }
1114 } 1114 }
1115 } 1115 }
1116 } 1116 }
1117 }, 1117 },
1118 "userProfiles": {
1119 "methods": {
1120 "get": {
1121 "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.",
1122 "httpMethod": "GET",
1123 "id": "classroom.userProfiles.get",
1124 "parameterOrder": [
1125 "userId"
1126 ],
1127 "parameters": {
1128 "userId": {
1129 "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",
1130 "location": "path",
1131 "required": true,
1132 "type": "string"
1133 }
1134 },
1135 "path": "v1/userProfiles/{userId}",
1136 "response": {
1137 "$ref": "UserProfile"
1138 },
1139 "scopes": [
1140 "https://www.googleapis.com/auth/classroom.profile.email s",
1141 "https://www.googleapis.com/auth/classroom.profile.photo s",
1142 "https://www.googleapis.com/auth/classroom.rosters",
1143 "https://www.googleapis.com/auth/classroom.rosters.reado nly"
1144 ]
1145 }
1146 },
1147 "resources": {
1148 "guardianInvitations": {
1149 "methods": {
1150 "list": {
1151 "description": "Returns a list of guardian invitatio ns that the requesting user is permitted to view, filtered by the parameters pro vided. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view gua rdian invitations for that student, 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, n or a `student_id` from the API, nor the literal string `me`). May also be return ed if an invalid `page_token` or `state` is provided. * `NOT_FOUND` if a `studen t_id` is specified, and its format can be recognized, but Classroom has no recor d of that student.",
1152 "httpMethod": "GET",
1153 "id": "classroom.userProfiles.guardianInvitations.li st",
1154 "parameterOrder": [
1155 "studentId"
1156 ],
1157 "parameters": {
1158 "studentId": {
1159 "description": "The ID of the student whose guardian invitations are to be returned. The identifier can be one of the follow ing: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
1160 "location": "path",
1161 "required": true,
1162 "type": "string"
1163 },
1164 "invitedEmailAddress": {
1165 "description": "If specified, only results w ith the specified `invited_email_address` will be returned.",
1166 "location": "query",
1167 "type": "string"
1168 },
1169 "states": {
1170 "description": "If specified, only results w ith the specified `state` values will be returned. Otherwise, results with a `st ate` of `PENDING` will be returned.",
1171 "enum": [
1172 "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
1173 "PENDING",
1174 "COMPLETE"
1175 ],
1176 "location": "query",
1177 "repeated": true,
1178 "type": "string"
1179 },
1180 "pageToken": {
1181 "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results shoul d be returned. The list request must be otherwise identical to the one that resu lted in this token.",
1182 "location": "query",
1183 "type": "string"
1184 },
1185 "pageSize": {
1186 "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.",
1187 "format": "int32",
1188 "location": "query",
1189 "type": "integer"
1190 }
1191 },
1192 "path": "v1/userProfiles/{studentId}/guardianInvitat ions",
1193 "response": {
1194 "$ref": "ListGuardianInvitationsResponse"
1195 }
1196 },
1197 "get": {
1198 "description": "Returns a specific guardian invitati on. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations for the student id entified by the `student_id`, if guardians are not enabled for the domain in que stion, or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is spe cified, 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 Classro om cannot find any record of the given student or `invitation_id`. May also be r eturned if the student exists, but the requesting user does not have access to s ee that student.",
1199 "httpMethod": "GET",
1200 "id": "classroom.userProfiles.guardianInvitations.ge t",
1201 "parameterOrder": [
1202 "studentId",
1203 "invitationId"
1204 ],
1205 "parameters": {
1206 "studentId": {
1207 "description": "The ID of the student whose guardian invitation is being requested.",
1208 "location": "path",
1209 "required": true,
1210 "type": "string"
1211 },
1212 "invitationId": {
1213 "description": "The `id` field of the `Guard ianInvitation` being requested.",
1214 "location": "path",
1215 "required": true,
1216 "type": "string"
1217 }
1218 },
1219 "path": "v1/userProfiles/{studentId}/guardianInvitat ions/{invitationId}",
1220 "response": {
1221 "$ref": "GuardianInvitation"
1222 }
1223 },
1224 "create": {
1225 "description": "Creates a guardian invitation, and s ends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their `state` will change t o `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request obj ect must have the `student_id` and `invited_email_address` fields set. Failing t o set these fields, or setting any other fields in the request, will result in a n error. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardian s are not enabled for the domain in question, or for other access errors. * `RES OURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit . * `INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recogn ized (it is not an email address, nor a `user_id` from this API). This error wil l also be returned if read-only fields are set, or if the `state` field is set t o to a value other than `PENDING`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student. * `ALREADY_EXIST S` if there is already a pending guardian invitation for the student and `invite d_email_address` provided, or if the provided `invited_email_address` matches th e Google account of an existing `Guardian` for this user.",
1226 "httpMethod": "POST",
1227 "id": "classroom.userProfiles.guardianInvitations.cr eate",
1228 "parameterOrder": [
1229 "studentId"
1230 ],
1231 "parameters": {
1232 "studentId": {
1233 "description": "ID of the student (in standa rd format)",
1234 "location": "path",
1235 "required": true,
1236 "type": "string"
1237 }
1238 },
1239 "path": "v1/userProfiles/{studentId}/guardianInvitat ions",
1240 "request": {
1241 "$ref": "GuardianInvitation"
1242 },
1243 "response": {
1244 "$ref": "GuardianInvitation"
1245 }
1246 },
1247 "patch": {
1248 "description": "Modifies a guardian invitation. Curr ently, the only valid modification is to change the `state` from `PENDING` to `C OMPLETE`. This has the effect of withdrawing the invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not h ave permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. * `INVALID_ARGUMENT` if the format of the st udent ID provided cannot be recognized (it is not an email address, nor a `user_ id` from this API), or if the passed `GuardianInvitation` has a `state` other th an `COMPLETE`, or if it modifies fields other than `state`. * `NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to C lassroom.",
1249 "httpMethod": "PATCH",
1250 "id": "classroom.userProfiles.guardianInvitations.pa tch",
1251 "parameterOrder": [
1252 "studentId",
1253 "invitationId"
1254 ],
1255 "parameters": {
1256 "studentId": {
1257 "description": "The ID of the student whose guardian invitation is to be modified.",
1258 "location": "path",
1259 "required": true,
1260 "type": "string"
1261 },
1262 "invitationId": {
1263 "description": "The `id` field of the `Guard ianInvitation` to be modified.",
1264 "location": "path",
1265 "required": true,
1266 "type": "string"
1267 },
1268 "updateMask": {
1269 "description": "Mask that identifies which f ields on the course to update. This field is required to do an update. The updat e will fail if invalid fields are specified. The following fields are valid: * ` state` When set in a query parameter, this field should be specified as `updateM ask=,,...`",
1270 "location": "query",
1271 "type": "string"
1272 }
1273 },
1274 "path": "v1/userProfiles/{studentId}/guardianInvitat ions/{invitationId}",
1275 "request": {
1276 "$ref": "GuardianInvitation"
1277 },
1278 "response": {
1279 "$ref": "GuardianInvitation"
1280 }
1281 }
1282 }
1283 },
1284 "guardians": {
1285 "methods": {
1286 "list": {
1287 "description": "Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the reques t. This method returns the following error codes: * `PERMISSION_DENIED` if a `st udent_id` is specified, and the requesting user is not permitted to view guardia n information for that student, if guardians are not enabled for the domain in q uestion, if the `invited_email_address` filter is set by a user who is not a dom ain administrator, or for other access errors. * `INVALID_ARGUMENT` if a `studen t_id` is specified, but its format cannot be recognized (it is not an email addr ess, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.",
1288 "httpMethod": "GET",
1289 "id": "classroom.userProfiles.guardians.list",
1290 "parameterOrder": [
1291 "studentId"
1292 ],
1293 "parameters": {
1294 "studentId": {
1295 "description": "Filter results by the studen t who the guardian is linked to. The identifier can be one of the following: * t he numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
1296 "location": "path",
1297 "required": true,
1298 "type": "string"
1299 },
1300 "invitedEmailAddress": {
1301 "description": "Filter results by the email address that the original invitation was sent to, resulting in this guardian lin k. This filter can only be used by domain administrators.",
1302 "location": "query",
1303 "type": "string"
1304 },
1305 "pageToken": {
1306 "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results shoul d be returned. The list request must be otherwise identical to the one that resu lted in this token.",
1307 "location": "query",
1308 "type": "string"
1309 },
1310 "pageSize": {
1311 "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.",
1312 "format": "int32",
1313 "location": "query",
1314 "type": "integer"
1315 }
1316 },
1317 "path": "v1/userProfiles/{studentId}/guardians",
1318 "response": {
1319 "$ref": "ListGuardiansResponse"
1320 }
1321 },
1322 "get": {
1323 "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.",
1324 "httpMethod": "GET",
1325 "id": "classroom.userProfiles.guardians.get",
1326 "parameterOrder": [
1327 "studentId",
1328 "guardianId"
1329 ],
1330 "parameters": {
1331 "studentId": {
1332 "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",
1333 "location": "path",
1334 "required": true,
1335 "type": "string"
1336 },
1337 "guardianId": {
1338 "description": "The `id` field from a `Guard ian`.",
1339 "location": "path",
1340 "required": true,
1341 "type": "string"
1342 }
1343 },
1344 "path": "v1/userProfiles/{studentId}/guardians/{guar dianId}",
1345 "response": {
1346 "$ref": "Guardian"
1347 }
1348 },
1349 "delete": {
1350 "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.",
1351 "httpMethod": "DELETE",
1352 "id": "classroom.userProfiles.guardians.delete",
1353 "parameterOrder": [
1354 "studentId",
1355 "guardianId"
1356 ],
1357 "parameters": {
1358 "studentId": {
1359 "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",
1360 "location": "path",
1361 "required": true,
1362 "type": "string"
1363 },
1364 "guardianId": {
1365 "description": "The `id` field from a `Guard ian`.",
1366 "location": "path",
1367 "required": true,
1368 "type": "string"
1369 }
1370 },
1371 "path": "v1/userProfiles/{studentId}/guardians/{guar dianId}",
1372 "response": {
1373 "$ref": "Empty"
1374 }
1375 }
1376 }
1377 }
1378 }
1379 },
1118 "invitations": { 1380 "invitations": {
1119 "methods": { 1381 "methods": {
1120 "create": { 1382 "create": {
1121 "description": "Creates an invitation. Only one invitation f or a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIE D` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled or if the use r already has this role or a role with greater permissions. * `ALREADY_EXISTS` i f an invitation for the specified user and course already exists.", 1383 "description": "Creates an invitation. Only one invitation f or a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: * `PERMISSION_DENIE D` if the requesting user is not permitted to create invitations for this course or for access errors. * `NOT_FOUND` if the course or the user does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled or if the use r already has this role or a role with greater permissions. * `ALREADY_EXISTS` i f an invitation for the specified user and course already exists.",
1122 "httpMethod": "POST", 1384 "httpMethod": "POST",
1123 "id": "classroom.invitations.create", 1385 "id": "classroom.invitations.create",
1124 "path": "v1/invitations", 1386 "path": "v1/invitations",
1125 "request": { 1387 "request": {
1126 "$ref": "Invitation" 1388 "$ref": "Invitation"
1127 }, 1389 },
(...skipping 104 matching lines...) Expand 10 before | Expand all | Expand 10 after
1232 }, 1494 },
1233 "path": "v1/invitations/{id}:accept", 1495 "path": "v1/invitations/{id}:accept",
1234 "response": { 1496 "response": {
1235 "$ref": "Empty" 1497 "$ref": "Empty"
1236 }, 1498 },
1237 "scopes": [ 1499 "scopes": [
1238 "https://www.googleapis.com/auth/classroom.rosters" 1500 "https://www.googleapis.com/auth/classroom.rosters"
1239 ] 1501 ]
1240 } 1502 }
1241 } 1503 }
1242 },
1243 "userProfiles": {
1244 "methods": {
1245 "get": {
1246 "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.",
1247 "httpMethod": "GET",
1248 "id": "classroom.userProfiles.get",
1249 "parameterOrder": [
1250 "userId"
1251 ],
1252 "parameters": {
1253 "userId": {
1254 "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",
1255 "location": "path",
1256 "required": true,
1257 "type": "string"
1258 }
1259 },
1260 "path": "v1/userProfiles/{userId}",
1261 "response": {
1262 "$ref": "UserProfile"
1263 },
1264 "scopes": [
1265 "https://www.googleapis.com/auth/classroom.profile.email s",
1266 "https://www.googleapis.com/auth/classroom.profile.photo s",
1267 "https://www.googleapis.com/auth/classroom.rosters",
1268 "https://www.googleapis.com/auth/classroom.rosters.reado nly"
1269 ]
1270 }
1271 }
1272 } 1504 }
1273 }, 1505 },
1274 "revision": "20160517", 1506 "revision": "20160816",
1275 "rootUrl": "https://classroom.googleapis.com/", 1507 "rootUrl": "https://classroom.googleapis.com/",
1276 "schemas": { 1508 "schemas": {
1277 "Course": { 1509 "Course": {
1278 "description": "A Course in Classroom.", 1510 "description": "A Course in Classroom.",
1279 "id": "Course", 1511 "id": "Course",
1280 "properties": { 1512 "properties": {
1281 "id": { 1513 "id": {
1282 "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.", 1514 "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.",
1283 "type": "string" 1515 "type": "string"
1284 }, 1516 },
(...skipping 263 matching lines...) Expand 10 before | Expand all | Expand 10 after
1548 }, 1780 },
1549 "type": "array" 1781 "type": "array"
1550 }, 1782 },
1551 "nextPageToken": { 1783 "nextPageToken": {
1552 "description": "Token identifying the next page of results t o return. If empty, no further results are available.", 1784 "description": "Token identifying the next page of results t o return. If empty, no further results are available.",
1553 "type": "string" 1785 "type": "string"
1554 } 1786 }
1555 }, 1787 },
1556 "type": "object" 1788 "type": "object"
1557 }, 1789 },
1558 "Invitation": { 1790 "ListGuardianInvitationsResponse": {
1559 "description": "An invitation to join a course.", 1791 "description": "Response when listing guardian invitations.",
1560 "id": "Invitation", 1792 "id": "ListGuardianInvitationsResponse",
1561 "properties": { 1793 "properties": {
1562 "id": { 1794 "guardianInvitations": {
1563 "description": "Identifier assigned by Classroom. Read-only. ", 1795 "description": "Guardian invitations that matched the list r equest.",
1564 "type": "string" 1796 "items": {
1797 "$ref": "GuardianInvitation"
1798 },
1799 "type": "array"
1565 }, 1800 },
1566 "userId": { 1801 "nextPageToken": {
1567 "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", 1802 "description": "Token identifying the next page of results t o return. If empty, no further results are available.",
1568 "type": "string"
1569 },
1570 "courseId": {
1571 "description": "Identifier of the course to invite the user to.",
1572 "type": "string"
1573 },
1574 "role": {
1575 "description": "Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.",
1576 "enum": [
1577 "COURSE_ROLE_UNSPECIFIED",
1578 "STUDENT",
1579 "TEACHER"
1580 ],
1581 "type": "string" 1803 "type": "string"
1582 } 1804 }
1583 }, 1805 },
1584 "type": "object" 1806 "type": "object"
1585 }, 1807 },
1586 "ListInvitationsResponse": { 1808 "GuardianInvitation": {
1587 "description": "Response when listing invitations.", 1809 "description": "An invitation to become the guardian of a specified user, sent to a specified email address.",
1588 "id": "ListInvitationsResponse", 1810 "id": "GuardianInvitation",
1589 "properties": { 1811 "properties": {
1590 "invitations": { 1812 "studentId": {
1591 "description": "Invitations that match the list request.", 1813 "description": "ID of the student (in standard format)",
1814 "type": "string"
1815 },
1816 "invitationId": {
1817 "description": "Unique identifier for this invitation. Read- only.",
1818 "type": "string"
1819 },
1820 "invitedEmailAddress": {
1821 "description": "Email address that the invitation was sent t o. This field is only visible to domain administrators.",
1822 "type": "string"
1823 },
1824 "state": {
1825 "description": "The state that this invitation is in.",
1826 "enum": [
1827 "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
1828 "PENDING",
1829 "COMPLETE"
1830 ],
1831 "type": "string"
1832 },
1833 "creationTime": {
1834 "description": "The time that this invitation was created. R ead-only.",
1835 "type": "string"
1836 }
1837 },
1838 "type": "object"
1839 },
1840 "ListGuardiansResponse": {
1841 "description": "Response when listing guardians.",
1842 "id": "ListGuardiansResponse",
1843 "properties": {
1844 "guardians": {
1845 "description": "Guardians on this page of results that met t he criteria specified in the request.",
1592 "items": { 1846 "items": {
1593 "$ref": "Invitation" 1847 "$ref": "Guardian"
1594 }, 1848 },
1595 "type": "array" 1849 "type": "array"
1596 }, 1850 },
1597 "nextPageToken": { 1851 "nextPageToken": {
1598 "description": "Token identifying the next page of results t o return. If empty, no further results are available.", 1852 "description": "Token identifying the next page of results t o return. If empty, no further results are available.",
1599 "type": "string" 1853 "type": "string"
1600 } 1854 }
1601 }, 1855 },
1602 "type": "object" 1856 "type": "object"
1603 }, 1857 },
1858 "Guardian": {
1859 "description": "Association between a student and a guardian of that student. The guardian may receive information about the student's course work." ,
1860 "id": "Guardian",
1861 "properties": {
1862 "studentId": {
1863 "description": "Identifier for the student to whom the guard ian relationship applies.",
1864 "type": "string"
1865 },
1866 "guardianId": {
1867 "description": "Identifier for the guardian.",
1868 "type": "string"
1869 },
1870 "guardianProfile": {
1871 "$ref": "UserProfile",
1872 "description": "User profile for the guardian."
1873 },
1874 "invitedEmailAddress": {
1875 "description": "The email address to which the initial guard ian invitation was sent. This field is only visible to domain administrators.",
1876 "type": "string"
1877 }
1878 },
1879 "type": "object"
1880 },
1604 "UserProfile": { 1881 "UserProfile": {
1605 "description": "Global information for a user.", 1882 "description": "Global information for a user.",
1606 "id": "UserProfile", 1883 "id": "UserProfile",
1607 "properties": { 1884 "properties": {
1608 "id": { 1885 "id": {
1609 "description": "Identifier of the user. Read-only.", 1886 "description": "Identifier of the user. Read-only.",
1610 "type": "string" 1887 "type": "string"
1611 }, 1888 },
1612 "name": { 1889 "name": {
1613 "$ref": "Name", 1890 "$ref": "Name",
(...skipping 122 matching lines...) Expand 10 before | Expand all | Expand 10 after
1736 }, 2013 },
1737 "type": "array" 2014 "type": "array"
1738 }, 2015 },
1739 "nextPageToken": { 2016 "nextPageToken": {
1740 "description": "Token identifying the next page of results t o return. If empty, no further results are available.", 2017 "description": "Token identifying the next page of results t o return. If empty, no further results are available.",
1741 "type": "string" 2018 "type": "string"
1742 } 2019 }
1743 }, 2020 },
1744 "type": "object" 2021 "type": "object"
1745 }, 2022 },
2023 "Invitation": {
2024 "description": "An invitation to join a course.",
2025 "id": "Invitation",
2026 "properties": {
2027 "id": {
2028 "description": "Identifier assigned by Classroom. Read-only. ",
2029 "type": "string"
2030 },
2031 "userId": {
2032 "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",
2033 "type": "string"
2034 },
2035 "courseId": {
2036 "description": "Identifier of the course to invite the user to.",
2037 "type": "string"
2038 },
2039 "role": {
2040 "description": "Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.",
2041 "enum": [
2042 "COURSE_ROLE_UNSPECIFIED",
2043 "STUDENT",
2044 "TEACHER"
2045 ],
2046 "type": "string"
2047 }
2048 },
2049 "type": "object"
2050 },
2051 "ListInvitationsResponse": {
2052 "description": "Response when listing invitations.",
2053 "id": "ListInvitationsResponse",
2054 "properties": {
2055 "invitations": {
2056 "description": "Invitations that match the list request.",
2057 "items": {
2058 "$ref": "Invitation"
2059 },
2060 "type": "array"
2061 },
2062 "nextPageToken": {
2063 "description": "Token identifying the next page of results t o return. If empty, no further results are available.",
2064 "type": "string"
2065 }
2066 },
2067 "type": "object"
2068 },
1746 "CourseWork": { 2069 "CourseWork": {
1747 "description": "Course work created by a teacher for students of the course.", 2070 "description": "Course work created by a teacher for students of the course.",
1748 "id": "CourseWork", 2071 "id": "CourseWork",
1749 "properties": { 2072 "properties": {
1750 "courseId": { 2073 "courseId": {
1751 "description": "Identifier of the course. Read-only.", 2074 "description": "Identifier of the course. Read-only.",
1752 "type": "string" 2075 "type": "string"
1753 }, 2076 },
1754 "id": { 2077 "id": {
1755 "description": "Classroom-assigned identifier of this course work, unique per course. Read-only.", 2078 "description": "Classroom-assigned identifier of this course work, unique per course. Read-only.",
1756 "type": "string" 2079 "type": "string"
1757 }, 2080 },
1758 "title": { 2081 "title": {
1759 "description": "Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.", 2082 "description": "Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.",
1760 "type": "string" 2083 "type": "string"
1761 }, 2084 },
1762 "description": { 2085 "description": {
1763 "description": "Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,00 0 characters.", 2086 "description": "Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,00 0 characters.",
1764 "type": "string" 2087 "type": "string"
1765 }, 2088 },
1766 "materials": { 2089 "materials": {
1767 "description": "Additional materials.", 2090 "description": "Additional materials. CourseWork must have n o more than 20 material items.",
1768 "items": { 2091 "items": {
1769 "$ref": "Material" 2092 "$ref": "Material"
1770 }, 2093 },
1771 "type": "array" 2094 "type": "array"
1772 }, 2095 },
1773 "state": { 2096 "state": {
1774 "description": "Status of this course work.. If unspecified, the default state is `DRAFT`.", 2097 "description": "Status of this course work. If unspecified, the default state is `DRAFT`.",
1775 "enum": [ 2098 "enum": [
1776 "COURSE_WORK_STATE_UNSPECIFIED", 2099 "COURSE_WORK_STATE_UNSPECIFIED",
1777 "PUBLISHED", 2100 "PUBLISHED",
1778 "DRAFT", 2101 "DRAFT",
1779 "DELETED" 2102 "DELETED"
1780 ], 2103 ],
1781 "type": "string" 2104 "type": "string"
1782 }, 2105 },
1783 "alternateLink": { 2106 "alternateLink": {
1784 "description": "Absolute link to this course work in the Cla ssroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.", 2107 "description": "Absolute link to this course work in the Cla ssroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.",
1785 "type": "string" 2108 "type": "string"
1786 }, 2109 },
1787 "creationTime": { 2110 "creationTime": {
1788 "description": "Timestamp when this course work was created. Read-only.", 2111 "description": "Timestamp when this course work was created. Read-only.",
1789 "type": "string" 2112 "type": "string"
1790 }, 2113 },
1791 "updateTime": { 2114 "updateTime": {
1792 "description": "Timestamp of the most recent change to this course work. Read-only.", 2115 "description": "Timestamp of the most recent change to this course work. Read-only.",
1793 "type": "string" 2116 "type": "string"
1794 }, 2117 },
1795 "dueDate": { 2118 "dueDate": {
1796 "$ref": "Date", 2119 "$ref": "Date",
1797 "description": "Optional date, in UTC, that submissions for this this course work are due. This must be specified if `due_time` is specified ." 2120 "description": "Optional date, in UTC, that submissions for this this course work are due. This must be specified if `due_time` is specified ."
1798 }, 2121 },
1799 "dueTime": { 2122 "dueTime": {
1800 "$ref": "TimeOfDay", 2123 "$ref": "TimeOfDay",
1801 "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." 2124 "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."
1802 }, 2125 },
1803 "maxPoints": { 2126 "maxPoints": {
1804 "description": "Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be an integer value.", 2127 "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.",
1805 "format": "double", 2128 "format": "double",
1806 "type": "number" 2129 "type": "number"
1807 }, 2130 },
1808 "workType": { 2131 "workType": {
1809 "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`.", 2132 "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`.",
1810 "enum": [ 2133 "enum": [
1811 "COURSE_WORK_TYPE_UNSPECIFIED", 2134 "COURSE_WORK_TYPE_UNSPECIFIED",
1812 "ASSIGNMENT", 2135 "ASSIGNMENT",
1813 "SHORT_ANSWER_QUESTION", 2136 "SHORT_ANSWER_QUESTION",
1814 "MULTIPLE_CHOICE_QUESTION" 2137 "MULTIPLE_CHOICE_QUESTION"
(...skipping 174 matching lines...) Expand 10 before | Expand all | Expand 10 after
1989 }, 2312 },
1990 "id": { 2313 "id": {
1991 "description": "Classroom-assigned Identifier for the studen t submission. This is unique among submissions for the relevant course work. Rea d-only.", 2314 "description": "Classroom-assigned Identifier for the studen t submission. This is unique among submissions for the relevant course work. Rea d-only.",
1992 "type": "string" 2315 "type": "string"
1993 }, 2316 },
1994 "userId": { 2317 "userId": {
1995 "description": "Identifier for the student that owns this su bmission. Read-only.", 2318 "description": "Identifier for the student that owns this su bmission. Read-only.",
1996 "type": "string" 2319 "type": "string"
1997 }, 2320 },
1998 "creationTime": { 2321 "creationTime": {
1999 "description": "Creation time of this submission.. This may be unset if the student has not accessed this item. Read-only.", 2322 "description": "Creation time of this submission. This may b e unset if the student has not accessed this item. Read-only.",
2000 "type": "string" 2323 "type": "string"
2001 }, 2324 },
2002 "updateTime": { 2325 "updateTime": {
2003 "description": "Last update time of this submission. This ma y be unset if the student has not accessed this item. Read-only.", 2326 "description": "Last update time of this submission. This ma y be unset if the student has not accessed this item. Read-only.",
2004 "type": "string" 2327 "type": "string"
2005 }, 2328 },
2006 "state": { 2329 "state": {
2007 "description": "State of this submission. Read-only.", 2330 "description": "State of this submission. Read-only.",
2008 "enum": [ 2331 "enum": [
2009 "SUBMISSION_STATE_UNSPECIFIED", 2332 "SUBMISSION_STATE_UNSPECIFIED",
2010 "NEW", 2333 "NEW",
2011 "CREATED", 2334 "CREATED",
2012 "TURNED_IN", 2335 "TURNED_IN",
2013 "RETURNED", 2336 "RETURNED",
2014 "RECLAIMED_BY_STUDENT" 2337 "RECLAIMED_BY_STUDENT"
2015 ], 2338 ],
2016 "type": "string" 2339 "type": "string"
2017 }, 2340 },
2018 "late": { 2341 "late": {
2019 "description": "Whether this submission is late. Read-only." , 2342 "description": "Whether this submission is late. Read-only." ,
2020 "type": "boolean" 2343 "type": "boolean"
2021 }, 2344 },
2022 "draftGrade": { 2345 "draftGrade": {
2023 "description": "Optional pending grade. If unset, no grade w as set. This must be an integer value. This is only visible to and modifiable by course teachers.", 2346 "description": "Optional pending grade. If unset, no grade w as set. This must be a non-negative integer value. This is only visible to and m odifiable by course teachers.",
2024 "format": "double", 2347 "format": "double",
2025 "type": "number" 2348 "type": "number"
2026 }, 2349 },
2027 "assignedGrade": { 2350 "assignedGrade": {
2028 "description": "Optional grade. If unset, no grade was set. This must be an integer value. This may be modified only by course teachers.", 2351 "description": "Optional grade. If unset, no grade was set. This must be a non-negative integer value. This may be modified only by course t eachers.",
2029 "format": "double", 2352 "format": "double",
2030 "type": "number" 2353 "type": "number"
2031 }, 2354 },
2032 "alternateLink": { 2355 "alternateLink": {
2033 "description": "Absolute link to the submission in the Class room web UI. Read-only.", 2356 "description": "Absolute link to the submission in the Class room web UI. Read-only.",
2034 "type": "string" 2357 "type": "string"
2035 }, 2358 },
2036 "courseWorkType": { 2359 "courseWorkType": {
2037 "description": "Type of course work this submission is for. Read-only.", 2360 "description": "Type of course work this submission is for. Read-only.",
2038 "enum": [ 2361 "enum": [
(...skipping 11 matching lines...) Expand all
2050 "assignmentSubmission": { 2373 "assignmentSubmission": {
2051 "$ref": "AssignmentSubmission", 2374 "$ref": "AssignmentSubmission",
2052 "description": "Submission content when course_work_type is ASSIGNMENT ." 2375 "description": "Submission content when course_work_type is ASSIGNMENT ."
2053 }, 2376 },
2054 "shortAnswerSubmission": { 2377 "shortAnswerSubmission": {
2055 "$ref": "ShortAnswerSubmission", 2378 "$ref": "ShortAnswerSubmission",
2056 "description": "Submission content when course_work_type is SHORT_ANSWER_QUESTION." 2379 "description": "Submission content when course_work_type is SHORT_ANSWER_QUESTION."
2057 }, 2380 },
2058 "multipleChoiceSubmission": { 2381 "multipleChoiceSubmission": {
2059 "$ref": "MultipleChoiceSubmission", 2382 "$ref": "MultipleChoiceSubmission",
2060 "description": "Submission content when course_work_type is MUTIPLE_CHOICE_QUESTION." 2383 "description": "Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION."
2061 } 2384 }
2062 }, 2385 },
2063 "type": "object" 2386 "type": "object"
2064 }, 2387 },
2065 "AssignmentSubmission": { 2388 "AssignmentSubmission": {
2066 "description": "Student work for an assignment.", 2389 "description": "Student work for an assignment.",
2067 "id": "AssignmentSubmission", 2390 "id": "AssignmentSubmission",
2068 "properties": { 2391 "properties": {
2069 "attachments": { 2392 "attachments": {
2070 "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.", 2393 "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.",
(...skipping 81 matching lines...) Expand 10 before | Expand all | Expand 10 after
2152 "ReturnStudentSubmissionRequest": { 2475 "ReturnStudentSubmissionRequest": {
2153 "description": "Request to return a student submission.", 2476 "description": "Request to return a student submission.",
2154 "id": "ReturnStudentSubmissionRequest", 2477 "id": "ReturnStudentSubmissionRequest",
2155 "type": "object" 2478 "type": "object"
2156 }, 2479 },
2157 "ModifyAttachmentsRequest": { 2480 "ModifyAttachmentsRequest": {
2158 "description": "Request to modify the attachments of a student submi ssion.", 2481 "description": "Request to modify the attachments of a student submi ssion.",
2159 "id": "ModifyAttachmentsRequest", 2482 "id": "ModifyAttachmentsRequest",
2160 "properties": { 2483 "properties": {
2161 "addAttachments": { 2484 "addAttachments": {
2162 "description": "Attachments to add. This may only contain li nk attachments.", 2485 "description": "Attachments to add. A student submission may not have more than 20 attachments. This may only contain link attachments.",
2163 "items": { 2486 "items": {
2164 "$ref": "Attachment" 2487 "$ref": "Attachment"
2165 }, 2488 },
2166 "type": "array" 2489 "type": "array"
2167 } 2490 }
2168 }, 2491 },
2169 "type": "object" 2492 "type": "object"
2170 } 2493 }
2171 }, 2494 },
2172 "servicePath": "", 2495 "servicePath": "",
2173 "title": "Google Classroom API", 2496 "title": "Google Classroom API",
2174 "version": "v1" 2497 "version": "v1"
2175 } 2498 }
OLDNEW
« no previous file with comments | « discovery/googleapis/civicinfo__v2.json ('k') | discovery/googleapis/cloudbuild__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698