| Index: discovery/googleapis/classroom__v1.json
|
| diff --git a/discovery/googleapis/classroom__v1.json b/discovery/googleapis/classroom__v1.json
|
| index 8f6fbe430cdf57664d97b4ed14bd8abd337e23b6..ae1a968d523adec047ac0a2168419ca7928dc3c7 100644
|
| --- a/discovery/googleapis/classroom__v1.json
|
| +++ b/discovery/googleapis/classroom__v1.json
|
| @@ -2,44 +2,41 @@
|
| "auth": {
|
| "oauth2": {
|
| "scopes": {
|
| - "https://www.googleapis.com/auth/classroom.course-work.readonly": {
|
| - "description": "View instructions for teacher-assigned work in your Google Classroom classes"
|
| + "https://www.googleapis.com/auth/classroom.rosters.readonly": {
|
| + "description": "View your Google Classroom class rosters"
|
| },
|
| - "https://www.googleapis.com/auth/classroom.courses": {
|
| - "description": "Manage your Google Classroom classes"
|
| + "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly": {
|
| + "description": "View your course work and grades in Google Classroom"
|
| + },
|
| + "https://www.googleapis.com/auth/classroom.coursework.students.readonly": {
|
| + "description": "View course work and grades for students in the Google Classroom classes you teach or administer"
|
| + },
|
| + "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly": {
|
| + "description": "View course work and grades for students in the Google Classroom classes you teach or administer"
|
| + },
|
| + "https://www.googleapis.com/auth/classroom.rosters": {
|
| + "description": "Manage your Google Classroom class rosters"
|
| + },
|
| + "https://www.googleapis.com/auth/classroom.coursework.me.readonly": {
|
| + "description": "View your course work and grades in Google Classroom"
|
| },
|
| "https://www.googleapis.com/auth/classroom.courses.readonly": {
|
| "description": "View your Google Classroom classes"
|
| },
|
| + "https://www.googleapis.com/auth/classroom.courses": {
|
| + "description": "Manage your Google Classroom classes"
|
| + },
|
| "https://www.googleapis.com/auth/classroom.coursework.me": {
|
| "description": "Manage your course work and view your grades in Google Classroom"
|
| },
|
| - "https://www.googleapis.com/auth/classroom.coursework.me.readonly": {
|
| - "description": "View your course work and grades in Google Classroom"
|
| - },
|
| "https://www.googleapis.com/auth/classroom.coursework.students": {
|
| "description": "Manage course work and grades for students in the Google Classroom classes you teach and view the course work and grades for classes you administer"
|
| },
|
| - "https://www.googleapis.com/auth/classroom.coursework.students.readonly": {
|
| - "description": "View course work and grades for students in the Google Classroom classes you teach or administer"
|
| - },
|
| - "https://www.googleapis.com/auth/classroom.profile.emails": {
|
| - "description": "View the email addresses of people in your classes"
|
| - },
|
| "https://www.googleapis.com/auth/classroom.profile.photos": {
|
| "description": "View the profile photos of people in your classes"
|
| },
|
| - "https://www.googleapis.com/auth/classroom.rosters": {
|
| - "description": "Manage your Google Classroom class rosters"
|
| - },
|
| - "https://www.googleapis.com/auth/classroom.rosters.readonly": {
|
| - "description": "View your Google Classroom class rosters"
|
| - },
|
| - "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly": {
|
| - "description": "View your course work and grades in Google Classroom"
|
| - },
|
| - "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly": {
|
| - "description": "View course work and grades for students in the Google Classroom classes you teach or administer"
|
| + "https://www.googleapis.com/auth/classroom.profile.emails": {
|
| + "description": "View the email addresses of people in your classes"
|
| }
|
| }
|
| }
|
| @@ -50,7 +47,6 @@
|
| "description": "Manages classes, rosters, and invitations in Google Classroom.",
|
| "discoveryVersion": "v1",
|
| "documentationLink": "https://developers.google.com/classroom/",
|
| - "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/VPjAdAuQhi94i4H_5Zyjop6mRoc\"",
|
| "icons": {
|
| "x16": "http://www.google.com/images/icons/product/search-16.gif",
|
| "x32": "http://www.google.com/images/icons/product/search-32.gif"
|
| @@ -66,9 +62,41 @@
|
| "location": "query",
|
| "type": "string"
|
| },
|
| + "prettyPrint": {
|
| + "default": "true",
|
| + "description": "Returns response with indentations and line breaks.",
|
| + "location": "query",
|
| + "type": "boolean"
|
| + },
|
| + "key": {
|
| + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "quotaUser": {
|
| + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "pp": {
|
| + "default": "true",
|
| + "description": "Pretty-print response.",
|
| + "location": "query",
|
| + "type": "boolean"
|
| + },
|
| + "fields": {
|
| + "description": "Selector specifying which fields to include in a partial response.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| "alt": {
|
| "default": "json",
|
| "description": "Data format for response.",
|
| + "enum": [
|
| + "json",
|
| + "media",
|
| + "proto"
|
| + ],
|
| "enumDescriptions": [
|
| "Responses with Content-Type of application/json",
|
| "Media download with context-dependent Content-Type",
|
| @@ -77,8 +105,16 @@
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "bearer_token": {
|
| - "description": "OAuth bearer token.",
|
| + "$.xgafv": {
|
| + "description": "V1 error format.",
|
| + "enum": [
|
| + "1",
|
| + "2"
|
| + ],
|
| + "enumDescriptions": [
|
| + "v1 error format",
|
| + "v2 error format"
|
| + ],
|
| "location": "query",
|
| "type": "string"
|
| },
|
| @@ -87,35 +123,18 @@
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "fields": {
|
| - "description": "Selector specifying which fields to include in a partial response.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "key": {
|
| - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| "oauth_token": {
|
| "description": "OAuth 2.0 token for the current user.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "pp": {
|
| - "default": "true",
|
| - "description": "Pretty-print response.",
|
| - "location": "query",
|
| - "type": "boolean"
|
| - },
|
| - "prettyPrint": {
|
| - "default": "true",
|
| - "description": "Returns response with indentations and line breaks.",
|
| + "uploadType": {
|
| + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| "location": "query",
|
| - "type": "boolean"
|
| + "type": "string"
|
| },
|
| - "quotaUser": {
|
| - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| + "bearer_token": {
|
| + "description": "OAuth bearer token.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| @@ -123,181 +142,178 @@
|
| "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| "location": "query",
|
| "type": "string"
|
| - },
|
| - "uploadType": {
|
| - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "$.xgafv": {
|
| - "description": "V1 error format.",
|
| - "enumDescriptions": [
|
| - "v1 error format",
|
| - "v2 error format"
|
| - ],
|
| - "location": "query",
|
| - "type": "string"
|
| }
|
| },
|
| "protocol": "rest",
|
| "resources": {
|
| - "courses": {
|
| + "invitations": {
|
| "methods": {
|
| "create": {
|
| - "description": "Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.",
|
| + "description": "Creates an invitation. Only one invitation for a user and course may exist\nat a time. Delete and re-create an invitation to make changes.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ninvitations for this course or for access errors.\n* `NOT_FOUND` if the course or the user does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled or if\nthe user already has this role or a role with greater permissions.\n* `ALREADY_EXISTS` if an invitation for the specified user and course\nalready exists.",
|
| "httpMethod": "POST",
|
| - "id": "classroom.courses.create",
|
| - "path": "v1/courses",
|
| + "id": "classroom.invitations.create",
|
| + "parameterOrder": [],
|
| + "parameters": {},
|
| + "path": "v1/invitations",
|
| "request": {
|
| - "$ref": "Course"
|
| + "$ref": "Invitation"
|
| },
|
| "response": {
|
| - "$ref": "Course"
|
| + "$ref": "Invitation"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.courses"
|
| + "https://www.googleapis.com/auth/classroom.rosters"
|
| ]
|
| },
|
| "get": {
|
| - "description": "Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.",
|
| + "description": "Returns an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.",
|
| "httpMethod": "GET",
|
| - "id": "classroom.courses.get",
|
| + "id": "classroom.invitations.get",
|
| "parameterOrder": [
|
| "id"
|
| ],
|
| "parameters": {
|
| "id": {
|
| - "description": "Identifier of the course to return. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| + "description": "Identifier of the invitation to return.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/courses/{id}",
|
| + "path": "v1/invitations/{id}",
|
| "response": {
|
| - "$ref": "Course"
|
| + "$ref": "Invitation"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.courses",
|
| - "https://www.googleapis.com/auth/classroom.courses.readonly"
|
| + "https://www.googleapis.com/auth/classroom.rosters",
|
| + "https://www.googleapis.com/auth/classroom.rosters.readonly"
|
| ]
|
| },
|
| - "update": {
|
| - "description": "Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable",
|
| - "httpMethod": "PUT",
|
| - "id": "classroom.courses.update",
|
| - "parameterOrder": [
|
| - "id"
|
| - ],
|
| + "list": {
|
| + "description": "Returns a list of invitations that the requesting user is permitted to\nview, restricted to those that match the list request.\n\n*Note:* At least one of `user_id` or `course_id` must be supplied. Both\nfields can be supplied.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.",
|
| + "httpMethod": "GET",
|
| + "id": "classroom.invitations.list",
|
| + "parameterOrder": [],
|
| "parameters": {
|
| - "id": {
|
| - "description": "Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| - "location": "path",
|
| - "required": true,
|
| + "courseId": {
|
| + "description": "Restricts returned invitations to those for a course with the specified\nidentifier.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "pageSize": {
|
| + "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| + },
|
| + "userId": {
|
| + "description": "Restricts returned invitations to those for a specific user. The identifier\ncan be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "pageToken": {
|
| + "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating\nthat the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
|
| + "location": "query",
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/courses/{id}",
|
| - "request": {
|
| - "$ref": "Course"
|
| - },
|
| + "path": "v1/invitations",
|
| "response": {
|
| - "$ref": "Course"
|
| + "$ref": "ListInvitationsResponse"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.courses"
|
| + "https://www.googleapis.com/auth/classroom.rosters",
|
| + "https://www.googleapis.com/auth/classroom.rosters.readonly"
|
| ]
|
| },
|
| - "patch": {
|
| - "description": "Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable",
|
| - "httpMethod": "PATCH",
|
| - "id": "classroom.courses.patch",
|
| + "delete": {
|
| + "description": "Deletes an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.",
|
| + "httpMethod": "DELETE",
|
| + "id": "classroom.invitations.delete",
|
| "parameterOrder": [
|
| "id"
|
| ],
|
| "parameters": {
|
| "id": {
|
| - "description": "Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| + "description": "Identifier of the invitation to delete.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| - },
|
| - "updateMask": {
|
| - "description": "Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `name` * `section` * `descriptionHeading` * `description` * `room` * `courseState` When set in a query parameter, this field should be specified as `updateMask=,,...`",
|
| - "location": "query",
|
| - "type": "string"
|
| }
|
| },
|
| - "path": "v1/courses/{id}",
|
| - "request": {
|
| - "$ref": "Course"
|
| - },
|
| + "path": "v1/invitations/{id}",
|
| "response": {
|
| - "$ref": "Course"
|
| + "$ref": "Empty"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.courses"
|
| + "https://www.googleapis.com/auth/classroom.rosters"
|
| ]
|
| },
|
| - "delete": {
|
| - "description": "Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.",
|
| - "httpMethod": "DELETE",
|
| - "id": "classroom.courses.delete",
|
| + "accept": {
|
| + "description": "Accepts an invitation, removing it and adding the invited user to the\nteachers or students (as appropriate) of the specified course. Only the\ninvited user may accept an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to accept the\nrequested invitation or for access errors.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `NOT_FOUND` if no invitation exists with the requested ID.",
|
| + "httpMethod": "POST",
|
| + "id": "classroom.invitations.accept",
|
| "parameterOrder": [
|
| "id"
|
| ],
|
| "parameters": {
|
| "id": {
|
| - "description": "Identifier of the course to delete. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| + "description": "Identifier of the invitation to accept.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/courses/{id}",
|
| + "path": "v1/invitations/{id}:accept",
|
| "response": {
|
| "$ref": "Empty"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.courses"
|
| + "https://www.googleapis.com/auth/classroom.rosters"
|
| ]
|
| - },
|
| + }
|
| + }
|
| + },
|
| + "courses": {
|
| + "methods": {
|
| "list": {
|
| - "description": "Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.",
|
| + "description": "Returns a list of courses that the requesting user is permitted to view,\nrestricted to those that match the request.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.\n* `INVALID_ARGUMENT` if the query argument is malformed.\n* `NOT_FOUND` if any users specified in the query arguments do not exist.",
|
| "httpMethod": "GET",
|
| "id": "classroom.courses.list",
|
| + "parameterOrder": [],
|
| "parameters": {
|
| - "studentId": {
|
| - "description": "Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "teacherId": {
|
| - "description": "Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| "courseStates": {
|
| - "description": "Restricts returned courses to those in one of the specified states",
|
| + "description": "Restricts returned courses to those in one of the specified states\nThe default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.",
|
| "enum": [
|
| "COURSE_STATE_UNSPECIFIED",
|
| "ACTIVE",
|
| "ARCHIVED",
|
| "PROVISIONED",
|
| - "DECLINED"
|
| + "DECLINED",
|
| + "SUSPENDED"
|
| ],
|
| "location": "query",
|
| "repeated": true,
|
| "type": "string"
|
| },
|
| "pageSize": {
|
| - "description": "Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.",
|
| + "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
|
| "format": "int32",
|
| "location": "query",
|
| "type": "integer"
|
| },
|
| + "teacherId": {
|
| + "description": "Restricts returned courses to those having a teacher with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "studentId": {
|
| + "description": "Restricts returned courses to those having a student with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| "pageToken": {
|
| - "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
|
| + "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
|
| "location": "query",
|
| "type": "string"
|
| }
|
| @@ -310,108 +326,135 @@
|
| "https://www.googleapis.com/auth/classroom.courses",
|
| "https://www.googleapis.com/auth/classroom.courses.readonly"
|
| ]
|
| - }
|
| - },
|
| - "resources": {
|
| - "aliases": {
|
| - "methods": {
|
| - "create": {
|
| - "description": "Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists.",
|
| - "httpMethod": "POST",
|
| - "id": "classroom.courses.aliases.create",
|
| - "parameterOrder": [
|
| - "courseId"
|
| - ],
|
| - "parameters": {
|
| - "courseId": {
|
| - "description": "Identifier of the course to alias. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/courses/{courseId}/aliases",
|
| - "request": {
|
| - "$ref": "CourseAlias"
|
| - },
|
| - "response": {
|
| - "$ref": "CourseAlias"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.courses"
|
| - ]
|
| - },
|
| - "delete": {
|
| - "description": "Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist.",
|
| - "httpMethod": "DELETE",
|
| - "id": "classroom.courses.aliases.delete",
|
| - "parameterOrder": [
|
| - "courseId",
|
| - "alias"
|
| - ],
|
| - "parameters": {
|
| - "courseId": {
|
| - "description": "Identifier of the course whose alias should be deleted. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| - "alias": {
|
| - "description": "Alias to delete. This may not be the Classroom-assigned identifier.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/courses/{courseId}/aliases/{alias}",
|
| - "response": {
|
| - "$ref": "Empty"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.courses"
|
| - ]
|
| + },
|
| + "get": {
|
| + "description": "Returns a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.",
|
| + "httpMethod": "GET",
|
| + "id": "classroom.courses.get",
|
| + "parameterOrder": [
|
| + "id"
|
| + ],
|
| + "parameters": {
|
| + "id": {
|
| + "description": "Identifier of the course to return.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/courses/{id}",
|
| + "response": {
|
| + "$ref": "Course"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/classroom.courses",
|
| + "https://www.googleapis.com/auth/classroom.courses.readonly"
|
| + ]
|
| + },
|
| + "create": {
|
| + "description": "Creates a course.\n\nThe user specified in `ownerId` is the owner of the created course\nand added as a teacher.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ncourses or for access errors.\n* `NOT_FOUND` if the primary teacher is not a valid user.\n* `FAILED_PRECONDITION` if the course owner's account is disabled or for\nthe following request errors:\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if an alias was specified in the `id` and\nalready exists.",
|
| + "httpMethod": "POST",
|
| + "id": "classroom.courses.create",
|
| + "parameterOrder": [],
|
| + "parameters": {},
|
| + "path": "v1/courses",
|
| + "request": {
|
| + "$ref": "Course"
|
| + },
|
| + "response": {
|
| + "$ref": "Course"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/classroom.courses"
|
| + ]
|
| + },
|
| + "update": {
|
| + "description": "Updates a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable",
|
| + "httpMethod": "PUT",
|
| + "id": "classroom.courses.update",
|
| + "parameterOrder": [
|
| + "id"
|
| + ],
|
| + "parameters": {
|
| + "id": {
|
| + "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/courses/{id}",
|
| + "request": {
|
| + "$ref": "Course"
|
| + },
|
| + "response": {
|
| + "$ref": "Course"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/classroom.courses"
|
| + ]
|
| + },
|
| + "patch": {
|
| + "description": "Updates one or more fields in a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `INVALID_ARGUMENT` if invalid fields are specified in the update mask or\nif no update mask is supplied.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable",
|
| + "httpMethod": "PATCH",
|
| + "id": "classroom.courses.patch",
|
| + "parameterOrder": [
|
| + "id"
|
| + ],
|
| + "parameters": {
|
| + "updateMask": {
|
| + "description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `name`\n* `section`\n* `descriptionHeading`\n* `description`\n* `room`\n* `courseState`\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=<field1>,<field2>,...`",
|
| + "format": "google-fieldmask",
|
| + "location": "query",
|
| + "type": "string"
|
| },
|
| - "list": {
|
| - "description": "Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.",
|
| - "httpMethod": "GET",
|
| - "id": "classroom.courses.aliases.list",
|
| - "parameterOrder": [
|
| - "courseId"
|
| - ],
|
| - "parameters": {
|
| - "courseId": {
|
| - "description": "The identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| - "pageSize": {
|
| - "description": "Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.",
|
| - "format": "int32",
|
| - "location": "query",
|
| - "type": "integer"
|
| - },
|
| - "pageToken": {
|
| - "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
|
| - "location": "query",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/courses/{courseId}/aliases",
|
| - "response": {
|
| - "$ref": "ListCourseAliasesResponse"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.courses",
|
| - "https://www.googleapis.com/auth/classroom.courses.readonly"
|
| - ]
|
| + "id": {
|
| + "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| }
|
| - }
|
| + },
|
| + "path": "v1/courses/{id}",
|
| + "request": {
|
| + "$ref": "Course"
|
| + },
|
| + "response": {
|
| + "$ref": "Course"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/classroom.courses"
|
| + ]
|
| },
|
| + "delete": {
|
| + "description": "Deletes a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.",
|
| + "httpMethod": "DELETE",
|
| + "id": "classroom.courses.delete",
|
| + "parameterOrder": [
|
| + "id"
|
| + ],
|
| + "parameters": {
|
| + "id": {
|
| + "description": "Identifier of the course to delete.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/courses/{id}",
|
| + "response": {
|
| + "$ref": "Empty"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/classroom.courses"
|
| + ]
|
| + }
|
| + },
|
| + "resources": {
|
| "teachers": {
|
| "methods": {
|
| "create": {
|
| - "description": "Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teacher or student in the course.",
|
| + "description": "Creates a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nteachers in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a teacher or student in the\ncourse.",
|
| "httpMethod": "POST",
|
| "id": "classroom.courses.teachers.create",
|
| "parameterOrder": [
|
| @@ -419,7 +462,7 @@
|
| ],
|
| "parameters": {
|
| "courseId": {
|
| - "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| @@ -439,7 +482,7 @@
|
| ]
|
| },
|
| "get": {
|
| - "description": "Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist.",
|
| + "description": "Returns a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.",
|
| "httpMethod": "GET",
|
| "id": "classroom.courses.teachers.get",
|
| "parameterOrder": [
|
| @@ -448,13 +491,13 @@
|
| ],
|
| "parameters": {
|
| "courseId": {
|
| - "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| "userId": {
|
| - "description": "Identifier of the teacher to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
|
| + "description": "Identifier of the teacher to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| @@ -471,38 +514,8 @@
|
| "https://www.googleapis.com/auth/classroom.rosters.readonly"
|
| ]
|
| },
|
| - "delete": {
|
| - "description": "Deletes a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course.",
|
| - "httpMethod": "DELETE",
|
| - "id": "classroom.courses.teachers.delete",
|
| - "parameterOrder": [
|
| - "courseId",
|
| - "userId"
|
| - ],
|
| - "parameters": {
|
| - "courseId": {
|
| - "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| - "userId": {
|
| - "description": "Identifier of the teacher to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/courses/{courseId}/teachers/{userId}",
|
| - "response": {
|
| - "$ref": "Empty"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.rosters"
|
| - ]
|
| - },
|
| "list": {
|
| - "description": "Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.",
|
| + "description": "Returns a list of teachers of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors.",
|
| "httpMethod": "GET",
|
| "id": "classroom.courses.teachers.list",
|
| "parameterOrder": [
|
| @@ -510,19 +523,19 @@
|
| ],
|
| "parameters": {
|
| "courseId": {
|
| - "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| "pageSize": {
|
| - "description": "Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.",
|
| + "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
|
| "format": "int32",
|
| "location": "query",
|
| "type": "integer"
|
| },
|
| "pageToken": {
|
| - "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
|
| + "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
|
| "location": "query",
|
| "type": "string"
|
| }
|
| @@ -537,244 +550,301 @@
|
| "https://www.googleapis.com/auth/classroom.rosters",
|
| "https://www.googleapis.com/auth/classroom.rosters.readonly"
|
| ]
|
| + },
|
| + "delete": {
|
| + "description": "Deletes a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.\n* `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher\nof this course.",
|
| + "httpMethod": "DELETE",
|
| + "id": "classroom.courses.teachers.delete",
|
| + "parameterOrder": [
|
| + "courseId",
|
| + "userId"
|
| + ],
|
| + "parameters": {
|
| + "courseId": {
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "userId": {
|
| + "description": "Identifier of the teacher to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/courses/{courseId}/teachers/{userId}",
|
| + "response": {
|
| + "$ref": "Empty"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/classroom.rosters"
|
| + ]
|
| }
|
| }
|
| },
|
| - "students": {
|
| + "aliases": {
|
| "methods": {
|
| "create": {
|
| - "description": "Adds a user as a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course.",
|
| + "description": "Creates an alias for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create the\nalias or for access errors.\n* `NOT_FOUND` if the course does not exist.\n* `ALREADY_EXISTS` if the alias already exists.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to access a domain-scoped alias).",
|
| "httpMethod": "POST",
|
| - "id": "classroom.courses.students.create",
|
| + "id": "classroom.courses.aliases.create",
|
| "parameterOrder": [
|
| "courseId"
|
| ],
|
| "parameters": {
|
| "courseId": {
|
| - "description": "Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| + "description": "Identifier of the course to alias.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| - },
|
| - "enrollmentCode": {
|
| - "description": "Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user.",
|
| - "location": "query",
|
| - "type": "string"
|
| }
|
| },
|
| - "path": "v1/courses/{courseId}/students",
|
| + "path": "v1/courses/{courseId}/aliases",
|
| "request": {
|
| - "$ref": "Student"
|
| + "$ref": "CourseAlias"
|
| },
|
| "response": {
|
| - "$ref": "Student"
|
| + "$ref": "CourseAlias"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.profile.emails",
|
| - "https://www.googleapis.com/auth/classroom.profile.photos",
|
| - "https://www.googleapis.com/auth/classroom.rosters"
|
| + "https://www.googleapis.com/auth/classroom.courses"
|
| ]
|
| },
|
| - "get": {
|
| - "description": "Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.",
|
| + "list": {
|
| + "description": "Returns a list of aliases for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\ncourse or for access errors.\n* `NOT_FOUND` if the course does not exist.",
|
| "httpMethod": "GET",
|
| - "id": "classroom.courses.students.get",
|
| + "id": "classroom.courses.aliases.list",
|
| "parameterOrder": [
|
| - "courseId",
|
| - "userId"
|
| + "courseId"
|
| ],
|
| "parameters": {
|
| "courseId": {
|
| - "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| + "description": "The identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "userId": {
|
| - "description": "Identifier of the student to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| + "pageSize": {
|
| + "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| + },
|
| + "pageToken": {
|
| + "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
|
| + "location": "query",
|
| + "type": "string"
|
| }
|
| },
|
| - "path": "v1/courses/{courseId}/students/{userId}",
|
| + "path": "v1/courses/{courseId}/aliases",
|
| "response": {
|
| - "$ref": "Student"
|
| + "$ref": "ListCourseAliasesResponse"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.profile.emails",
|
| - "https://www.googleapis.com/auth/classroom.profile.photos",
|
| - "https://www.googleapis.com/auth/classroom.rosters",
|
| - "https://www.googleapis.com/auth/classroom.rosters.readonly"
|
| + "https://www.googleapis.com/auth/classroom.courses",
|
| + "https://www.googleapis.com/auth/classroom.courses.readonly"
|
| ]
|
| },
|
| "delete": {
|
| - "description": "Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.",
|
| + "description": "Deletes an alias of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to remove the\nalias or for access errors.\n* `NOT_FOUND` if the alias does not exist.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to delete a domain-scoped alias).",
|
| "httpMethod": "DELETE",
|
| - "id": "classroom.courses.students.delete",
|
| + "id": "classroom.courses.aliases.delete",
|
| "parameterOrder": [
|
| "courseId",
|
| - "userId"
|
| + "alias"
|
| ],
|
| "parameters": {
|
| "courseId": {
|
| - "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| + "description": "Identifier of the course whose alias should be deleted.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "userId": {
|
| - "description": "Identifier of the student to delete. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
|
| + "alias": {
|
| + "description": "Alias to delete.\nThis may not be the Classroom-assigned identifier.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/courses/{courseId}/students/{userId}",
|
| + "path": "v1/courses/{courseId}/aliases/{alias}",
|
| "response": {
|
| "$ref": "Empty"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.rosters"
|
| + "https://www.googleapis.com/auth/classroom.courses"
|
| ]
|
| - },
|
| - "list": {
|
| - "description": "Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.",
|
| - "httpMethod": "GET",
|
| - "id": "classroom.courses.students.list",
|
| + }
|
| + }
|
| + },
|
| + "students": {
|
| + "methods": {
|
| + "create": {
|
| + "description": "Adds a user as a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nstudents in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a student or teacher in the\ncourse.",
|
| + "httpMethod": "POST",
|
| + "id": "classroom.courses.students.create",
|
| "parameterOrder": [
|
| "courseId"
|
| ],
|
| "parameters": {
|
| "courseId": {
|
| - "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| + "description": "Identifier of the course to create the student in.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "pageSize": {
|
| - "description": "Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.",
|
| - "format": "int32",
|
| - "location": "query",
|
| - "type": "integer"
|
| - },
|
| - "pageToken": {
|
| - "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
|
| + "enrollmentCode": {
|
| + "description": "Enrollment code of the course to create the student in.\nThis code is required if userId\ncorresponds to the requesting user; it may be omitted if the requesting\nuser has administrative permissions to create students for any user.",
|
| "location": "query",
|
| "type": "string"
|
| }
|
| },
|
| "path": "v1/courses/{courseId}/students",
|
| + "request": {
|
| + "$ref": "Student"
|
| + },
|
| "response": {
|
| - "$ref": "ListStudentsResponse"
|
| + "$ref": "Student"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/classroom.profile.emails",
|
| "https://www.googleapis.com/auth/classroom.profile.photos",
|
| - "https://www.googleapis.com/auth/classroom.rosters",
|
| - "https://www.googleapis.com/auth/classroom.rosters.readonly"
|
| + "https://www.googleapis.com/auth/classroom.rosters"
|
| ]
|
| - }
|
| - }
|
| - },
|
| - "courseWork": {
|
| - "methods": {
|
| - "create": {
|
| - "description": "Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/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 associated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible",
|
| - "httpMethod": "POST",
|
| - "id": "classroom.courses.courseWork.create",
|
| + },
|
| + "get": {
|
| + "description": "Returns a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nstudents of this course or for access errors.\n* `NOT_FOUND` if no student of this course has the requested ID or if the\ncourse does not exist.",
|
| + "httpMethod": "GET",
|
| + "id": "classroom.courses.students.get",
|
| "parameterOrder": [
|
| - "courseId"
|
| + "courseId",
|
| + "userId"
|
| ],
|
| "parameters": {
|
| "courseId": {
|
| - "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "userId": {
|
| + "description": "Identifier of the student to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/courses/{courseId}/courseWork",
|
| - "request": {
|
| - "$ref": "CourseWork"
|
| - },
|
| + "path": "v1/courses/{courseId}/students/{userId}",
|
| "response": {
|
| - "$ref": "CourseWork"
|
| + "$ref": "Student"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.coursework.students"
|
| + "https://www.googleapis.com/auth/classroom.profile.emails",
|
| + "https://www.googleapis.com/auth/classroom.profile.photos",
|
| + "https://www.googleapis.com/auth/classroom.rosters",
|
| + "https://www.googleapis.com/auth/classroom.rosters.readonly"
|
| ]
|
| },
|
| - "patch": {
|
| - "description": "Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.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 user is not permitted to make 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.",
|
| - "httpMethod": "PATCH",
|
| - "id": "classroom.courses.courseWork.patch",
|
| + "list": {
|
| + "description": "Returns a list of students of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors.",
|
| + "httpMethod": "GET",
|
| + "id": "classroom.courses.students.list",
|
| "parameterOrder": [
|
| - "courseId",
|
| - "id"
|
| + "courseId"
|
| ],
|
| "parameters": {
|
| "courseId": {
|
| - "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "id": {
|
| - "description": "Identifier of the course work.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| + "pageSize": {
|
| + "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| },
|
| - "updateMask": {
|
| - "description": "Mask that identifies which fields 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 returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `submission_modification_mode`",
|
| + "pageToken": {
|
| + "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.",
|
| "location": "query",
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/courses/{courseId}/courseWork/{id}",
|
| - "request": {
|
| - "$ref": "CourseWork"
|
| - },
|
| + "path": "v1/courses/{courseId}/students",
|
| "response": {
|
| - "$ref": "CourseWork"
|
| + "$ref": "ListStudentsResponse"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.coursework.students"
|
| + "https://www.googleapis.com/auth/classroom.profile.emails",
|
| + "https://www.googleapis.com/auth/classroom.profile.photos",
|
| + "https://www.googleapis.com/auth/classroom.rosters",
|
| + "https://www.googleapis.com/auth/classroom.rosters.readonly"
|
| ]
|
| },
|
| "delete": {
|
| - "description": "Deletes a course work. This request must be made by the Developer Console project of the [OAuth client ID](https://support.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.",
|
| + "description": "Deletes a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nstudents of this course or for access errors.\n* `NOT_FOUND` if no student of this course has the requested ID or if the\ncourse does not exist.",
|
| "httpMethod": "DELETE",
|
| - "id": "classroom.courses.courseWork.delete",
|
| + "id": "classroom.courses.students.delete",
|
| "parameterOrder": [
|
| "courseId",
|
| - "id"
|
| + "userId"
|
| ],
|
| "parameters": {
|
| "courseId": {
|
| - "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "id": {
|
| - "description": "Identifier of the course work to delete. This identifier is a Classroom-assigned identifier.",
|
| + "userId": {
|
| + "description": "Identifier of the student to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/courses/{courseId}/courseWork/{id}",
|
| + "path": "v1/courses/{courseId}/students/{userId}",
|
| "response": {
|
| "$ref": "Empty"
|
| },
|
| "scopes": [
|
| + "https://www.googleapis.com/auth/classroom.rosters"
|
| + ]
|
| + }
|
| + }
|
| + },
|
| + "courseWork": {
|
| + "methods": {
|
| + "create": {
|
| + "description": "Creates course work.\n\nThe resulting course work (and corresponding student submissions) are\nassociated with the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\nmake the request. Classroom API requests to modify course work and student\nsubmissions must be made with an OAuth client ID from the associated\nDeveloper Console project.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, create course work in the requested course, share a\nDrive attachment, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.\n* `FAILED_PRECONDITION` for the following request error:\n * AttachmentNotVisible",
|
| + "httpMethod": "POST",
|
| + "id": "classroom.courses.courseWork.create",
|
| + "parameterOrder": [
|
| + "courseId"
|
| + ],
|
| + "parameters": {
|
| + "courseId": {
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/courses/{courseId}/courseWork",
|
| + "request": {
|
| + "$ref": "CourseWork"
|
| + },
|
| + "response": {
|
| + "$ref": "CourseWork"
|
| + },
|
| + "scopes": [
|
| "https://www.googleapis.com/auth/classroom.coursework.students"
|
| ]
|
| },
|
| "get": {
|
| - "description": "Returns course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.",
|
| + "description": "Returns course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist.",
|
| "httpMethod": "GET",
|
| "id": "classroom.courses.courseWork.get",
|
| "parameterOrder": [
|
| @@ -783,7 +853,7 @@
|
| ],
|
| "parameters": {
|
| "courseId": {
|
| - "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| @@ -800,7 +870,6 @@
|
| "$ref": "CourseWork"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.course-work.readonly",
|
| "https://www.googleapis.com/auth/classroom.coursework.me",
|
| "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
|
| "https://www.googleapis.com/auth/classroom.coursework.students",
|
| @@ -808,7 +877,7 @@
|
| ]
|
| },
|
| "list": {
|
| - "description": "Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.",
|
| + "description": "Returns a list of course work that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` course work. Course teachers\nand domain administrators may view all course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.",
|
| "httpMethod": "GET",
|
| "id": "classroom.courses.courseWork.list",
|
| "parameterOrder": [
|
| @@ -816,13 +885,13 @@
|
| ],
|
| "parameters": {
|
| "courseId": {
|
| - "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| "courseWorkStates": {
|
| - "description": "Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned.",
|
| + "description": "Restriction on the work status to return. Only courseWork that matches\nis returned. If unspecified, items with a work status of `PUBLISHED`\nis returned.",
|
| "enum": [
|
| "COURSE_WORK_STATE_UNSPECIFIED",
|
| "PUBLISHED",
|
| @@ -833,19 +902,19 @@
|
| "repeated": true,
|
| "type": "string"
|
| },
|
| - "orderBy": {
|
| - "description": "Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported fields are `updateTime` and `dueDate`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| "pageSize": {
|
| - "description": "Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.",
|
| + "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
|
| "format": "int32",
|
| "location": "query",
|
| "type": "integer"
|
| },
|
| + "orderBy": {
|
| + "description": "Optional sort ordering for results. A comma-separated list of fields with\nan optional sort direction keyword. Supported fields are `updateTime`\nand `dueDate`. Supported direction keywords are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default behavior.\nExamples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| "pageToken": {
|
| - "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
|
| + "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
|
| "location": "query",
|
| "type": "string"
|
| }
|
| @@ -855,21 +924,89 @@
|
| "$ref": "ListCourseWorkResponse"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.course-work.readonly",
|
| "https://www.googleapis.com/auth/classroom.coursework.me",
|
| "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
|
| "https://www.googleapis.com/auth/classroom.coursework.students",
|
| "https://www.googleapis.com/auth/classroom.coursework.students.readonly"
|
| ]
|
| + },
|
| + "patch": {
|
| + "description": "Updates one or more fields of a course work.\n\nSee google.classroom.v1.CourseWork for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
|
| + "httpMethod": "PATCH",
|
| + "id": "classroom.courses.courseWork.patch",
|
| + "parameterOrder": [
|
| + "courseId",
|
| + "id"
|
| + ],
|
| + "parameters": {
|
| + "courseId": {
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "updateMask": {
|
| + "description": "Mask that identifies which fields on the course work to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the CourseWork object. If a\nfield that does not support empty values is included in the update mask and\nnot set in the CourseWork object, an `INVALID_ARGUMENT` error will be\nreturned.\n\nThe following fields may be specified by teachers:\n* `title`\n* `description`\n* `state`\n* `due_date`\n* `due_time`\n* `max_points`\n* `submission_modification_mode`",
|
| + "format": "google-fieldmask",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "id": {
|
| + "description": "Identifier of the course work.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/courses/{courseId}/courseWork/{id}",
|
| + "request": {
|
| + "$ref": "CourseWork"
|
| + },
|
| + "response": {
|
| + "$ref": "CourseWork"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/classroom.coursework.students"
|
| + ]
|
| + },
|
| + "delete": {
|
| + "description": "Deletes a course work.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the requesting user is not permitted\nto delete the requested course or for access errors.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the requested ID.",
|
| + "httpMethod": "DELETE",
|
| + "id": "classroom.courses.courseWork.delete",
|
| + "parameterOrder": [
|
| + "courseId",
|
| + "id"
|
| + ],
|
| + "parameters": {
|
| + "courseId": {
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "id": {
|
| + "description": "Identifier of the course work to delete.\nThis identifier is a Classroom-assigned identifier.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/courses/{courseId}/courseWork/{id}",
|
| + "response": {
|
| + "$ref": "Empty"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/classroom.coursework.students"
|
| + ]
|
| }
|
| },
|
| "resources": {
|
| "studentSubmissions": {
|
| "methods": {
|
| - "get": {
|
| - "description": "Returns a student submission. * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, course work, or student submission 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.",
|
| - "httpMethod": "GET",
|
| - "id": "classroom.courses.courseWork.studentSubmissions.get",
|
| + "modifyAttachments": {
|
| + "description": "Modifies attachments of student submission.\n\nAttachments may only be added to student submissions belonging to course\nwork objects with a `workType` of `ASSIGNMENT`.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, if the user is not permitted to modify\nattachments on the requested student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
|
| + "httpMethod": "POST",
|
| + "id": "classroom.courses.courseWork.studentSubmissions.modifyAttachments",
|
| "parameterOrder": [
|
| "courseId",
|
| "courseWorkId",
|
| @@ -877,7 +1014,7 @@
|
| ],
|
| "parameters": {
|
| "courseId": {
|
| - "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| @@ -895,23 +1032,22 @@
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
|
| + "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
|
| + "request": {
|
| + "$ref": "ModifyAttachmentsRequest"
|
| + },
|
| "response": {
|
| "$ref": "StudentSubmission"
|
| },
|
| "scopes": [
|
| "https://www.googleapis.com/auth/classroom.coursework.me",
|
| - "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
|
| - "https://www.googleapis.com/auth/classroom.coursework.students",
|
| - "https://www.googleapis.com/auth/classroom.coursework.students.readonly",
|
| - "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly",
|
| - "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"
|
| + "https://www.googleapis.com/auth/classroom.coursework.students"
|
| ]
|
| },
|
| - "patch": {
|
| - "description": "Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.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 user is not permitted to make the requested modification to the student submission, 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.",
|
| - "httpMethod": "PATCH",
|
| - "id": "classroom.courses.courseWork.studentSubmissions.patch",
|
| + "reclaim": {
|
| + "description": "Reclaims a student submission on behalf of the student that owns it.\n\nReclaiming a student submission transfers ownership of attached Drive\nfiles to the student and update the submission state.\n\nOnly the student that owns the requested student submission may call this\nmethod, and only for a student submission that has been turned in.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, unsubmit the requested student submission,\nor for access errors.\n* `FAILED_PRECONDITION` if the student submission has not been turned in.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
|
| + "httpMethod": "POST",
|
| + "id": "classroom.courses.courseWork.studentSubmissions.reclaim",
|
| "parameterOrder": [
|
| "courseId",
|
| "courseWorkId",
|
| @@ -919,7 +1055,7 @@
|
| ],
|
| "parameters": {
|
| "courseId": {
|
| - "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| @@ -935,53 +1071,70 @@
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| - },
|
| - "updateMask": {
|
| - "description": "Mask that identifies which fields on the student submission to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields may be specified by teachers: * `draft_grade` * `assigned_grade`",
|
| - "location": "query",
|
| - "type": "string"
|
| }
|
| },
|
| - "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
|
| + "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
|
| "request": {
|
| - "$ref": "StudentSubmission"
|
| + "$ref": "ReclaimStudentSubmissionRequest"
|
| },
|
| "response": {
|
| - "$ref": "StudentSubmission"
|
| + "$ref": "Empty"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.coursework.me",
|
| - "https://www.googleapis.com/auth/classroom.coursework.students"
|
| + "https://www.googleapis.com/auth/classroom.coursework.me"
|
| ]
|
| },
|
| - "list": {
|
| - "description": "Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. `-` may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.",
|
| - "httpMethod": "GET",
|
| - "id": "classroom.courses.courseWork.studentSubmissions.list",
|
| + "turnIn": {
|
| + "description": "Turns in a student submission.\n\nTurning in a student submission transfers ownership of attached Drive\nfiles to the teacher and may also update the submission state.\n\nThis may only be called by the student that owns the specified student\nsubmission.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, turn in the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
|
| + "httpMethod": "POST",
|
| + "id": "classroom.courses.courseWork.studentSubmissions.turnIn",
|
| "parameterOrder": [
|
| "courseId",
|
| - "courseWorkId"
|
| + "courseWorkId",
|
| + "id"
|
| ],
|
| "parameters": {
|
| "courseId": {
|
| - "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| "courseWorkId": {
|
| - "description": "Identifer of the student work to request. This may be set to the string literal `\"-\"` to request student work for all course work in the specified course.",
|
| + "description": "Identifier of the course work.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "userId": {
|
| - "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 identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
|
| - "location": "query",
|
| + "id": {
|
| + "description": "Identifier of the student submission.",
|
| + "location": "path",
|
| + "required": true,
|
| "type": "string"
|
| - },
|
| + }
|
| + },
|
| + "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
|
| + "request": {
|
| + "$ref": "TurnInStudentSubmissionRequest"
|
| + },
|
| + "response": {
|
| + "$ref": "Empty"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/classroom.coursework.me"
|
| + ]
|
| + },
|
| + "list": {
|
| + "description": "Returns a list of student submissions that the requester is permitted to\nview, factoring in the OAuth scopes of the request.\n`-` may be specified as the `course_work_id` to include student\nsubmissions for multiple course work items.\n\nCourse students may only view their own work. Course teachers\nand domain administrators may view all student submissions.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.",
|
| + "httpMethod": "GET",
|
| + "id": "classroom.courses.courseWork.studentSubmissions.list",
|
| + "parameterOrder": [
|
| + "courseId",
|
| + "courseWorkId"
|
| + ],
|
| + "parameters": {
|
| "states": {
|
| - "description": "Requested submission states. If specified, returned student submissions match one of the specified submission states.",
|
| + "description": "Requested submission states. If specified, returned student submissions\nmatch one of the specified submission states.",
|
| "enum": [
|
| "SUBMISSION_STATE_UNSPECIFIED",
|
| "NEW",
|
| @@ -994,8 +1147,25 @@
|
| "repeated": true,
|
| "type": "string"
|
| },
|
| + "userId": {
|
| + "description": "Optional argument to restrict returned student work to those owned by the\nstudent with the specified identifier. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "pageSize": {
|
| + "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| + },
|
| + "courseId": {
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| "late": {
|
| - "description": "Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of `late` value.",
|
| + "description": "Requested lateness value. If specified, returned student submissions are\nrestricted by the requested value.\nIf unspecified, submissions are returned regardless of `late` value.",
|
| "enum": [
|
| "LATE_VALUES_UNSPECIFIED",
|
| "LATE_ONLY",
|
| @@ -1004,14 +1174,14 @@
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "pageSize": {
|
| - "description": "Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.",
|
| - "format": "int32",
|
| - "location": "query",
|
| - "type": "integer"
|
| + "courseWorkId": {
|
| + "description": "Identifer of the student work to request.\nThis may be set to the string literal `\"-\"` to request student work for\nall course work in the specified course.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| },
|
| "pageToken": {
|
| - "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
|
| + "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
|
| "location": "query",
|
| "type": "string"
|
| }
|
| @@ -1029,50 +1199,10 @@
|
| "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"
|
| ]
|
| },
|
| - "turnIn": {
|
| - "description": "Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the [OAuth client ID](https://support.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, turn in the requested student submission, 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.",
|
| - "httpMethod": "POST",
|
| - "id": "classroom.courses.courseWork.studentSubmissions.turnIn",
|
| - "parameterOrder": [
|
| - "courseId",
|
| - "courseWorkId",
|
| - "id"
|
| - ],
|
| - "parameters": {
|
| - "courseId": {
|
| - "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| - "courseWorkId": {
|
| - "description": "Identifier of the course work.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| - "id": {
|
| - "description": "Identifier of the student submission.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
|
| - "request": {
|
| - "$ref": "TurnInStudentSubmissionRequest"
|
| - },
|
| - "response": {
|
| - "$ref": "Empty"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.coursework.me"
|
| - ]
|
| - },
|
| - "reclaim": {
|
| - "description": "Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and update the submission state. Only the student that owns 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://support.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. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.",
|
| - "httpMethod": "POST",
|
| - "id": "classroom.courses.courseWork.studentSubmissions.reclaim",
|
| + "get": {
|
| + "description": "Returns a student submission.\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, course work, or student submission or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
|
| + "httpMethod": "GET",
|
| + "id": "classroom.courses.courseWork.studentSubmissions.get",
|
| "parameterOrder": [
|
| "courseId",
|
| "courseWorkId",
|
| @@ -1080,7 +1210,7 @@
|
| ],
|
| "parameters": {
|
| "courseId": {
|
| - "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| @@ -1098,19 +1228,21 @@
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
|
| - "request": {
|
| - "$ref": "ReclaimStudentSubmissionRequest"
|
| - },
|
| + "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
|
| "response": {
|
| - "$ref": "Empty"
|
| + "$ref": "StudentSubmission"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.coursework.me"
|
| + "https://www.googleapis.com/auth/classroom.coursework.me",
|
| + "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
|
| + "https://www.googleapis.com/auth/classroom.coursework.students",
|
| + "https://www.googleapis.com/auth/classroom.coursework.students.readonly",
|
| + "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly",
|
| + "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly"
|
| ]
|
| },
|
| "return": {
|
| - "description": "Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the [OAuth client ID](https://support.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, return the requested student submission, 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.",
|
| + "description": "Returns a student submission.\n\nReturning a student submission transfers ownership of attached Drive\nfiles to the student and may also update the submission state.\nUnlike the Classroom application, returning a student submission does not\nset assignedGrade to the draftGrade value.\n\nOnly a teacher of the course that contains the requested student submission\nmay call this method.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, return the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
|
| "httpMethod": "POST",
|
| "id": "classroom.courses.courseWork.studentSubmissions.return",
|
| "parameterOrder": [
|
| @@ -1120,7 +1252,7 @@
|
| ],
|
| "parameters": {
|
| "courseId": {
|
| - "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| @@ -1149,10 +1281,10 @@
|
| "https://www.googleapis.com/auth/classroom.coursework.students"
|
| ]
|
| },
|
| - "modifyAttachments": {
|
| - "description": "Modifies attachments of student submission. Attachments may only be added to student submissions belonging to course work objects with a `workType` of `ASSIGNMENT`. This request must be made by the Developer Console project of the [OAuth client ID](https://support.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, if the user is not permitted to modify attachments on the requested student submission, 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.",
|
| - "httpMethod": "POST",
|
| - "id": "classroom.courses.courseWork.studentSubmissions.modifyAttachments",
|
| + "patch": {
|
| + "description": "Updates one or more fields of a student submission.\n\nSee google.classroom.v1.StudentSubmission for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.",
|
| + "httpMethod": "PATCH",
|
| + "id": "classroom.courses.courseWork.studentSubmissions.patch",
|
| "parameterOrder": [
|
| "courseId",
|
| "courseWorkId",
|
| @@ -1160,7 +1292,7 @@
|
| ],
|
| "parameters": {
|
| "courseId": {
|
| - "description": "Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.",
|
| + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| @@ -1171,6 +1303,12 @@
|
| "required": true,
|
| "type": "string"
|
| },
|
| + "updateMask": {
|
| + "description": "Mask that identifies which fields on the student submission to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified.\n\nThe following fields may be specified by teachers:\n* `draft_grade`\n* `assigned_grade`",
|
| + "format": "google-fieldmask",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| "id": {
|
| "description": "Identifier of the student submission.",
|
| "location": "path",
|
| @@ -1178,9 +1316,9 @@
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
|
| + "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
|
| "request": {
|
| - "$ref": "ModifyAttachmentsRequest"
|
| + "$ref": "StudentSubmission"
|
| },
|
| "response": {
|
| "$ref": "StudentSubmission"
|
| @@ -1199,7 +1337,7 @@
|
| "userProfiles": {
|
| "methods": {
|
| "get": {
|
| - "description": "Returns a user profile. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access this user profile, if no profile exists with the requested ID, or for access errors.",
|
| + "description": "Returns a user profile.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthis user profile, if no profile exists with the requested ID, or for\naccess errors.",
|
| "httpMethod": "GET",
|
| "id": "classroom.userProfiles.get",
|
| "parameterOrder": [
|
| @@ -1207,7 +1345,7 @@
|
| ],
|
| "parameters": {
|
| "userId": {
|
| - "description": "Identifier of the profile to return. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
|
| + "description": "Identifier of the profile to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| @@ -1226,57 +1364,104 @@
|
| }
|
| },
|
| "resources": {
|
| - "guardianInvitations": {
|
| + "guardians": {
|
| "methods": {
|
| - "list": {
|
| - "description": "Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian invitations for that student, if `\"-\"` is specified as the `student_id` and the user is not a domain administrator, 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 `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` or `state` is provided. * `NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student.",
|
| + "get": {
|
| + "description": "Returns a specific guardian.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to view guardian information for the student identified by the\n `student_id`, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if the requesting user is permitted to view guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student that matches the provided `guardian_id`.",
|
| "httpMethod": "GET",
|
| - "id": "classroom.userProfiles.guardianInvitations.list",
|
| + "id": "classroom.userProfiles.guardians.get",
|
| "parameterOrder": [
|
| - "studentId"
|
| + "studentId",
|
| + "guardianId"
|
| ],
|
| "parameters": {
|
| "studentId": {
|
| - "description": "The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user * the string literal `\"-\"`, indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations.",
|
| + "description": "The student whose guardian is being requested. One of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "guardianId": {
|
| + "description": "The `id` field from a `Guardian`.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
|
| + "response": {
|
| + "$ref": "Guardian"
|
| + }
|
| + },
|
| + "list": {
|
| + "description": "Returns a list of guardians that the requesting user is permitted to\nview, restricted to those that match the request.\n\nTo list guardians for any student that the requesting user may view\nguardians for, use the literal character `-` for the student ID.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian information for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n if the `invited_email_address` filter is set by a user who is not a\n domain administrator, or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student.",
|
| + "httpMethod": "GET",
|
| + "id": "classroom.userProfiles.guardians.list",
|
| + "parameterOrder": [
|
| + "studentId"
|
| + ],
|
| + "parameters": {
|
| + "pageSize": {
|
| + "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| },
|
| "invitedEmailAddress": {
|
| - "description": "If specified, only results with the specified `invited_email_address` will be returned.",
|
| + "description": "Filter results by the email address that the original invitation was sent\nto, resulting in this guardian link.\nThis filter can only be used by domain administrators.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| - "states": {
|
| - "description": "If specified, only results with the specified `state` values will be returned. Otherwise, results with a `state` of `PENDING` will be returned.",
|
| - "enum": [
|
| - "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
|
| - "PENDING",
|
| - "COMPLETE"
|
| - ],
|
| - "location": "query",
|
| - "repeated": true,
|
| + "studentId": {
|
| + "description": "Filter results by the student who the guardian is linked to.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user has access to view.",
|
| + "location": "path",
|
| + "required": true,
|
| "type": "string"
|
| },
|
| "pageToken": {
|
| - "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
|
| + "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
|
| "location": "query",
|
| "type": "string"
|
| - },
|
| - "pageSize": {
|
| - "description": "Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.",
|
| - "format": "int32",
|
| - "location": "query",
|
| - "type": "integer"
|
| }
|
| },
|
| - "path": "v1/userProfiles/{studentId}/guardianInvitations",
|
| + "path": "v1/userProfiles/{studentId}/guardians",
|
| "response": {
|
| - "$ref": "ListGuardianInvitationsResponse"
|
| + "$ref": "ListGuardiansResponse"
|
| }
|
| },
|
| + "delete": {
|
| + "description": "Deletes a guardian.\n\nThe guardian will no longer receive guardian notifications and the guardian\nwill no longer be accessible via the API.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to manage guardians for the student identified by the\n `student_id`, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API).\n* `NOT_FOUND` if the requesting user is permitted to modify guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student with the provided `guardian_id`.",
|
| + "httpMethod": "DELETE",
|
| + "id": "classroom.userProfiles.guardians.delete",
|
| + "parameterOrder": [
|
| + "studentId",
|
| + "guardianId"
|
| + ],
|
| + "parameters": {
|
| + "studentId": {
|
| + "description": "The student whose guardian is to be deleted. One of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + },
|
| + "guardianId": {
|
| + "description": "The `id` field from a `Guardian`.",
|
| + "location": "path",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
|
| + "response": {
|
| + "$ref": "Empty"
|
| + }
|
| + }
|
| + }
|
| + },
|
| + "guardianInvitations": {
|
| + "methods": {
|
| "get": {
|
| - "description": "Returns a specific guardian invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations 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 `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 find any record of the given student or `invitation_id`. May also be returned if the student exists, but the requesting user does not have access to see that student.",
|
| + "description": "Returns a specific guardian invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\n guardian invitations for the student identified by the `student_id`, if\n guardians are not enabled for the domain in question, or for other\n access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if Classroom cannot find any record of the given student or\n `invitation_id`. May also be returned if the student exists, but the\n requesting user does not have access to see that student.",
|
| "httpMethod": "GET",
|
| "id": "classroom.userProfiles.guardianInvitations.get",
|
| "parameterOrder": [
|
| @@ -1284,14 +1469,14 @@
|
| "invitationId"
|
| ],
|
| "parameters": {
|
| - "studentId": {
|
| - "description": "The ID of the student whose guardian invitation is being requested.",
|
| + "invitationId": {
|
| + "description": "The `id` field of the `GuardianInvitation` being requested.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "invitationId": {
|
| - "description": "The `id` field of the `GuardianInvitation` being requested.",
|
| + "studentId": {
|
| + "description": "The ID of the student whose guardian invitation is being requested.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| @@ -1303,7 +1488,7 @@
|
| }
|
| },
|
| "create": {
|
| - "description": "Creates a guardian invitation, and sends 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 to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an 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 guardians are not enabled for the domain in question, or for other access errors. * `RESOURCE_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 recognized (it is not an email address, nor a `user_id` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to 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_EXISTS` if there is already a pending guardian invitation for the student and `invited_email_address` provided, or if the provided `invited_email_address` matches the Google account of an existing `Guardian` for this user.",
|
| + "description": "Creates a guardian invitation, and sends an email to the guardian asking\nthem to confirm that they are the student's guardian.\n\nOnce the guardian accepts the invitation, their `state` will change to\n`COMPLETED` and they will start receiving guardian notifications. A\n`Guardian` resource will also be created to represent the active guardian.\n\nThe request object must have the `student_id` and\n`invited_email_address` fields set. Failing to set these fields, or\nsetting any other fields in the request, will result in an error.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if the guardian in question has already rejected\n too many requests for that student, if guardians are not enabled for the\n domain in question, or for other access errors.\n* `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian\n link limit.\n* `INVALID_ARGUMENT` if the guardian email address is not valid (for\n example, if it is too long), or if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API). This error will also be returned if read-only fields are set,\n or if the `state` field is set to to a value other than `PENDING`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student.\n* `ALREADY_EXISTS` if there is already a pending guardian invitation for\n the student and `invited_email_address` provided, or if the provided\n `invited_email_address` matches the Google account of an existing\n `Guardian` for this user.",
|
| "httpMethod": "POST",
|
| "id": "classroom.userProfiles.guardianInvitations.create",
|
| "parameterOrder": [
|
| @@ -1325,349 +1510,272 @@
|
| "$ref": "GuardianInvitation"
|
| }
|
| },
|
| - "patch": {
|
| - "description": "Modifies a guardian invitation. Currently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the current user does not have 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 student 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 than `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 Classroom.",
|
| - "httpMethod": "PATCH",
|
| - "id": "classroom.userProfiles.guardianInvitations.patch",
|
| + "list": {
|
| + "description": "Returns a list of guardian invitations that the requesting user is\npermitted to view, filtered by the parameters provided.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian invitations for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` or `state` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student.",
|
| + "httpMethod": "GET",
|
| + "id": "classroom.userProfiles.guardianInvitations.list",
|
| "parameterOrder": [
|
| - "studentId",
|
| - "invitationId"
|
| + "studentId"
|
| ],
|
| "parameters": {
|
| + "pageSize": {
|
| + "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| + },
|
| + "invitedEmailAddress": {
|
| + "description": "If specified, only results with the specified `invited_email_address`\nwill be returned.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "states": {
|
| + "description": "If specified, only results with the specified `state` values will be\nreturned. Otherwise, results with a `state` of `PENDING` will be returned.",
|
| + "enum": [
|
| + "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
|
| + "PENDING",
|
| + "COMPLETE"
|
| + ],
|
| + "location": "query",
|
| + "repeated": true,
|
| + "type": "string"
|
| + },
|
| "studentId": {
|
| - "description": "The ID of the student whose guardian invitation is to be modified.",
|
| + "description": "The ID of the student whose guardian invitations are to be returned.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user is permitted to view guardian\n invitations.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "invitationId": {
|
| - "description": "The `id` field of the `GuardianInvitation` to be modified.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| - "updateMask": {
|
| - "description": "Mask that identifies which fields on the course to update. This field is required to do an update. The update 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 `updateMask=,,...`",
|
| - "location": "query",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
|
| - "request": {
|
| - "$ref": "GuardianInvitation"
|
| - },
|
| - "response": {
|
| - "$ref": "GuardianInvitation"
|
| - }
|
| - }
|
| - }
|
| - },
|
| - "guardians": {
|
| - "methods": {
|
| - "list": {
|
| - "description": "Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. To list guardians for any student that the requesting user may view guardians for, use the literal character `-` for the student ID. This method returns the following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian information for that student, if `\"-\"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, if the `invited_email_address` filter is set by a user who is not a domain administrator, 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 `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.",
|
| - "httpMethod": "GET",
|
| - "id": "classroom.userProfiles.guardians.list",
|
| - "parameterOrder": [
|
| - "studentId"
|
| - ],
|
| - "parameters": {
|
| - "studentId": {
|
| - "description": "Filter results by the student who the guardian is linked to. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user * the string literal `\"-\"`, indicating that results should be returned for all students that the requesting user has access to view.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| - "invitedEmailAddress": {
|
| - "description": "Filter results by the email address that the original invitation was sent to, resulting in this guardian link. This filter can only be used by domain administrators.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| "pageToken": {
|
| - "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
|
| + "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.",
|
| "location": "query",
|
| "type": "string"
|
| - },
|
| - "pageSize": {
|
| - "description": "Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.",
|
| - "format": "int32",
|
| - "location": "query",
|
| - "type": "integer"
|
| }
|
| },
|
| - "path": "v1/userProfiles/{studentId}/guardians",
|
| + "path": "v1/userProfiles/{studentId}/guardianInvitations",
|
| "response": {
|
| - "$ref": "ListGuardiansResponse"
|
| + "$ref": "ListGuardianInvitationsResponse"
|
| }
|
| },
|
| - "get": {
|
| - "description": "Returns a specific guardian. This method returns the following error codes: * `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, 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 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 `student_id` from the API, nor the literal string `me`). * `NOT_FOUND` if the requesting user is permitted to view guardians for the requested `student_id`, but no `Guardian` record exists for that student that matches the provided `guardian_id`.",
|
| - "httpMethod": "GET",
|
| - "id": "classroom.userProfiles.guardians.get",
|
| + "patch": {
|
| + "description": "Modifies a guardian invitation.\n\nCurrently, the only valid modification is to change the `state` from\n`PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if guardians are not enabled for the domain in question\n or for other access errors.\n* `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state.\n* `INVALID_ARGUMENT` if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API), or if the passed `GuardianInvitation` has a `state` other than\n `COMPLETE`, or if it modifies fields other than `state`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student, or if the `id` field does not\n refer to a guardian invitation known to Classroom.",
|
| + "httpMethod": "PATCH",
|
| + "id": "classroom.userProfiles.guardianInvitations.patch",
|
| "parameterOrder": [
|
| "studentId",
|
| - "guardianId"
|
| + "invitationId"
|
| ],
|
| "parameters": {
|
| - "studentId": {
|
| - "description": "The student whose guardian is being requested. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
|
| + "invitationId": {
|
| + "description": "The `id` field of the `GuardianInvitation` to be modified.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "guardianId": {
|
| - "description": "The `id` field from a `Guardian`.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
|
| - "response": {
|
| - "$ref": "Guardian"
|
| - }
|
| - },
|
| - "delete": {
|
| - "description": "Deletes a guardian. The guardian will no longer receive guardian notifications and the guardian will no longer be accessible via the API. This method returns the following error codes: * `PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting 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 `student_id` is specified, but its format cannot be recognized (it is not an email address, 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`.",
|
| - "httpMethod": "DELETE",
|
| - "id": "classroom.userProfiles.guardians.delete",
|
| - "parameterOrder": [
|
| - "studentId",
|
| - "guardianId"
|
| - ],
|
| - "parameters": {
|
| - "studentId": {
|
| - "description": "The student whose guardian is to be deleted. One of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
|
| - "location": "path",
|
| - "required": true,
|
| + "updateMask": {
|
| + "description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `state`\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=<field1>,<field2>,...`",
|
| + "format": "google-fieldmask",
|
| + "location": "query",
|
| "type": "string"
|
| },
|
| - "guardianId": {
|
| - "description": "The `id` field from a `Guardian`.",
|
| + "studentId": {
|
| + "description": "The ID of the student whose guardian invitation is to be modified.",
|
| "location": "path",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
|
| + "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
|
| + "request": {
|
| + "$ref": "GuardianInvitation"
|
| + },
|
| "response": {
|
| - "$ref": "Empty"
|
| + "$ref": "GuardianInvitation"
|
| }
|
| }
|
| }
|
| }
|
| }
|
| - },
|
| - "invitations": {
|
| - "methods": {
|
| - "create": {
|
| - "description": "Creates an invitation. Only one invitation for 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_DENIED` 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 user already has this role or a role with greater permissions. * `ALREADY_EXISTS` if an invitation for the specified user and course already exists.",
|
| - "httpMethod": "POST",
|
| - "id": "classroom.invitations.create",
|
| - "path": "v1/invitations",
|
| - "request": {
|
| - "$ref": "Invitation"
|
| - },
|
| - "response": {
|
| - "$ref": "Invitation"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.rosters"
|
| - ]
|
| - },
|
| - "get": {
|
| - "description": "Returns an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.",
|
| - "httpMethod": "GET",
|
| - "id": "classroom.invitations.get",
|
| - "parameterOrder": [
|
| - "id"
|
| - ],
|
| - "parameters": {
|
| - "id": {
|
| - "description": "Identifier of the invitation to return.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/invitations/{id}",
|
| - "response": {
|
| - "$ref": "Invitation"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.rosters",
|
| - "https://www.googleapis.com/auth/classroom.rosters.readonly"
|
| - ]
|
| - },
|
| - "delete": {
|
| - "description": "Deletes an invitation. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation or for access errors. * `NOT_FOUND` if no invitation exists with the requested ID.",
|
| - "httpMethod": "DELETE",
|
| - "id": "classroom.invitations.delete",
|
| - "parameterOrder": [
|
| - "id"
|
| - ],
|
| - "parameters": {
|
| - "id": {
|
| - "description": "Identifier of the invitation to delete.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/invitations/{id}",
|
| - "response": {
|
| - "$ref": "Empty"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.rosters"
|
| - ]
|
| - },
|
| - "list": {
|
| - "description": "Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: * `PERMISSION_DENIED` for access errors.",
|
| - "httpMethod": "GET",
|
| - "id": "classroom.invitations.list",
|
| - "parameters": {
|
| - "userId": {
|
| - "description": "Restricts returned invitations to those for a specific user. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "courseId": {
|
| - "description": "Restricts returned invitations to those for a course with the specified identifier.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "pageSize": {
|
| - "description": "Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.",
|
| - "format": "int32",
|
| - "location": "query",
|
| - "type": "integer"
|
| - },
|
| - "pageToken": {
|
| - "description": "nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.",
|
| - "location": "query",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/invitations",
|
| - "response": {
|
| - "$ref": "ListInvitationsResponse"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.rosters",
|
| - "https://www.googleapis.com/auth/classroom.rosters.readonly"
|
| - ]
|
| - },
|
| - "accept": {
|
| - "description": "Accepts an invitation, removing it and adding 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 permitted to accept the requested invitation or for access errors. * `FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if no invitation exists with the requested ID.",
|
| - "httpMethod": "POST",
|
| - "id": "classroom.invitations.accept",
|
| - "parameterOrder": [
|
| - "id"
|
| - ],
|
| - "parameters": {
|
| - "id": {
|
| - "description": "Identifier of the invitation to accept.",
|
| - "location": "path",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/invitations/{id}:accept",
|
| - "response": {
|
| - "$ref": "Empty"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/classroom.rosters"
|
| - ]
|
| - }
|
| - }
|
| }
|
| },
|
| - "revision": "20170110",
|
| + "revision": "20170321",
|
| "rootUrl": "https://classroom.googleapis.com/",
|
| "schemas": {
|
| - "Course": {
|
| - "description": "A Course in Classroom.",
|
| - "id": "Course",
|
| + "Attachment": {
|
| + "description": "Attachment added to student assignment work.\n\nWhen creating attachments, setting the `form` field is not supported.",
|
| + "id": "Attachment",
|
| "properties": {
|
| - "id": {
|
| - "description": "Identifier for this course assigned by Classroom. 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 assigned by Classroom and cannot be updated after the course is created. Specifying this field in a course update mask results in an error.",
|
| - "type": "string"
|
| + "driveFile": {
|
| + "$ref": "DriveFile",
|
| + "description": "Google Drive file attachment."
|
| },
|
| - "name": {
|
| - "description": "Name of the course. For example, \"10th Grade Biology\". The name is required. It must be between 1 and 750 characters and a valid UTF-8 string.",
|
| - "type": "string"
|
| + "youTubeVideo": {
|
| + "$ref": "YouTubeVideo",
|
| + "description": "Youtube video attachment."
|
| },
|
| - "section": {
|
| - "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 characters.",
|
| + "link": {
|
| + "$ref": "Link",
|
| + "description": "Link attachment."
|
| + },
|
| + "form": {
|
| + "$ref": "Form",
|
| + "description": "Google Forms attachment."
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ListGuardianInvitationsResponse": {
|
| + "description": "Response when listing guardian invitations.",
|
| + "id": "ListGuardianInvitationsResponse",
|
| + "properties": {
|
| + "nextPageToken": {
|
| + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| "type": "string"
|
| },
|
| - "descriptionHeading": {
|
| - "description": "Optional heading for the description. For example, \"Welcome to 10th Grade Biology.\" If set, this field must be a valid UTF-8 string and no longer than 3600 characters.",
|
| + "guardianInvitations": {
|
| + "description": "Guardian invitations that matched the list request.",
|
| + "items": {
|
| + "$ref": "GuardianInvitation"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "CourseWork": {
|
| + "description": "Course work created by a teacher for students of the course.",
|
| + "id": "CourseWork",
|
| + "properties": {
|
| + "id": {
|
| + "description": "Classroom-assigned identifier of this course work, unique per course.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| "description": {
|
| - "description": "Optional description. For example, \"We'll be learning about the structure of living creatures from a combination of textbooks, guest lectures, and lab work. Expect to be excited!\" If set, this field must be a valid UTF-8 string and no longer than 30,000 characters.",
|
| + "description": "Optional description of this course work.\nIf set, the description must be a valid UTF-8 string containing no more\nthan 30,000 characters.",
|
| "type": "string"
|
| },
|
| - "room": {
|
| - "description": "Optional room location. For example, \"301\". If set, this field must be a valid UTF-8 string and no longer than 650 characters.",
|
| + "submissionModificationMode": {
|
| + "description": "Setting to determine when students are allowed to modify submissions.\nIf unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.",
|
| + "enum": [
|
| + "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED",
|
| + "MODIFIABLE_UNTIL_TURNED_IN",
|
| + "MODIFIABLE"
|
| + ],
|
| + "enumDescriptions": [
|
| + "No modification mode specified. This is never returned.",
|
| + "Submisisons can be modified before being turned in.",
|
| + "Submisisons can be modified at any time."
|
| + ],
|
| "type": "string"
|
| },
|
| - "ownerId": {
|
| - "description": "The identifier of the owner of a course. When specified as a parameter of a create course request, this field is required. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user This must be set in a create request. Specifying this field in a course update mask results in an `INVALID_ARGUMENT` error.",
|
| + "associatedWithDeveloper": {
|
| + "description": "Whether this course work item is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only.",
|
| + "type": "boolean"
|
| + },
|
| + "updateTime": {
|
| + "description": "Timestamp of the most recent change to this course work.\n\nRead-only.",
|
| + "format": "google-datetime",
|
| "type": "string"
|
| },
|
| - "creationTime": {
|
| - "description": "Creation time of the course. Specifying this field in a course update mask results in an error. Read-only.",
|
| + "title": {
|
| + "description": "Title of this course work.\nThe title must be a valid UTF-8 string containing between 1 and 3000\ncharacters.",
|
| "type": "string"
|
| },
|
| - "updateTime": {
|
| - "description": "Time of the most recent update to this course. Specifying this field in a course update mask results in an error. Read-only.",
|
| + "alternateLink": {
|
| + "description": "Absolute link to this course work in the Classroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "enrollmentCode": {
|
| - "description": "Enrollment code to use when joining this course. Specifying this field in a course update mask results in an error. Read-only.",
|
| + "workType": {
|
| + "description": "Type of this course work.\n\nThe type is set when the course work is created and cannot be changed.",
|
| + "enum": [
|
| + "COURSE_WORK_TYPE_UNSPECIFIED",
|
| + "ASSIGNMENT",
|
| + "SHORT_ANSWER_QUESTION",
|
| + "MULTIPLE_CHOICE_QUESTION"
|
| + ],
|
| + "enumDescriptions": [
|
| + "No work type specified. This is never returned.",
|
| + "An assignment.",
|
| + "A short answer question.",
|
| + "A multiple-choice question."
|
| + ],
|
| "type": "string"
|
| },
|
| - "courseState": {
|
| - "description": "State of the course. If unspecified, the default state is `PROVISIONED`.",
|
| + "materials": {
|
| + "description": "Additional materials.\n\nCourseWork must have no more than 20 material items.",
|
| + "items": {
|
| + "$ref": "Material"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "state": {
|
| + "description": "Status of this course work.\nIf unspecified, the default state is `DRAFT`.",
|
| "enum": [
|
| - "COURSE_STATE_UNSPECIFIED",
|
| - "ACTIVE",
|
| - "ARCHIVED",
|
| - "PROVISIONED",
|
| - "DECLINED"
|
| + "COURSE_WORK_STATE_UNSPECIFIED",
|
| + "PUBLISHED",
|
| + "DRAFT",
|
| + "DELETED"
|
| + ],
|
| + "enumDescriptions": [
|
| + "No state specified. This is never returned.",
|
| + "Status for work that has been published.\nThis is the default state.",
|
| + "Status for work that is not yet published.\nWork in this state is visible only to course teachers and domain\nadministrators.",
|
| + "Status for work that was published but is now deleted.\nWork in this state is visible only to course teachers and domain\nadministrators.\nWork in this state is deleted after some time."
|
| ],
|
| "type": "string"
|
| },
|
| - "alternateLink": {
|
| - "description": "Absolute link to this course in the Classroom web UI. Read-only.",
|
| + "dueDate": {
|
| + "$ref": "Date",
|
| + "description": "Optional date, in UTC, that submissions for this this course work are due.\nThis must be specified if `due_time` is specified."
|
| + },
|
| + "multipleChoiceQuestion": {
|
| + "$ref": "MultipleChoiceQuestion",
|
| + "description": "Multiple choice question details.\nFor read operations, this field is populated only when `work_type` is\n`MULTIPLE_CHOICE_QUESTION`.\nFor write operations, this field must be specified when creating course\nwork with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be\nset otherwise."
|
| + },
|
| + "creationTime": {
|
| + "description": "Timestamp when this course work was created.\n\nRead-only.",
|
| + "format": "google-datetime",
|
| "type": "string"
|
| },
|
| - "teacherGroupEmail": {
|
| - "description": "The email address of a Google group containing all teachers of the course. This group does not accept email and can only be used for permissions. Read-only.",
|
| + "courseId": {
|
| + "description": "Identifier of the course.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "courseGroupEmail": {
|
| - "description": "The email address of a Google group containing all members of the course. This group does not accept email and can only be used for permissions. Read-only.",
|
| + "maxPoints": {
|
| + "description": "Maximum grade for this course work.\nIf zero or unspecified, this assignment is considered ungraded.\nThis must be a non-negative integer value.",
|
| + "format": "double",
|
| + "type": "number"
|
| + },
|
| + "assignment": {
|
| + "$ref": "Assignment",
|
| + "description": "Assignment details.\nThis is populated only when `work_type` is `ASSIGNMENT`.\n\nRead-only."
|
| + },
|
| + "dueTime": {
|
| + "$ref": "TimeOfDay",
|
| + "description": "Optional time of day, in UTC, that submissions for this this course work\nare due.\nThis must be specified if `due_date` is specified."
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "DriveFile": {
|
| + "description": "Representation of a Google Drive file.",
|
| + "id": "DriveFile",
|
| + "properties": {
|
| + "thumbnailUrl": {
|
| + "description": "URL of a thumbnail image of the Drive item.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "teacherFolder": {
|
| - "$ref": "DriveFolder",
|
| - "description": "Information about a Drive Folder that is shared with all teachers of the course. This field will only be set for teachers of the course and domain administrators. Read-only."
|
| + "title": {
|
| + "description": "Title of the Drive item.\n\nRead-only.",
|
| + "type": "string"
|
| },
|
| - "courseMaterialSets": {
|
| - "description": "Sets of materials that appear on the \"about\" page of this course. Read-only.",
|
| - "items": {
|
| - "$ref": "CourseMaterialSet"
|
| - },
|
| - "type": "array"
|
| + "alternateLink": {
|
| + "description": "URL that can be used to access the Drive item.\n\nRead-only.",
|
| + "type": "string"
|
| },
|
| - "guardiansEnabled": {
|
| - "description": "Whether or not guardian notifications are enabled for this course. Read-only.",
|
| - "type": "boolean"
|
| + "id": {
|
| + "description": "Drive API resource ID.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1676,39 +1784,50 @@
|
| "description": "Representation of a Google Drive folder.",
|
| "id": "DriveFolder",
|
| "properties": {
|
| - "id": {
|
| - "description": "Drive API resource ID.",
|
| - "type": "string"
|
| - },
|
| "title": {
|
| - "description": "Title of the Drive folder. Read-only.",
|
| + "description": "Title of the Drive folder.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| "alternateLink": {
|
| - "description": "URL that can be used to access the Drive folder. Read-only.",
|
| + "description": "URL that can be used to access the Drive folder.\n\nRead-only.",
|
| + "type": "string"
|
| + },
|
| + "id": {
|
| + "description": "Drive API resource ID.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "CourseMaterialSet": {
|
| - "description": "A set of materials that appears on the \"About\" page of the course. These materials might include a syllabus, schedule, or other background information relating to the course as a whole.",
|
| - "id": "CourseMaterialSet",
|
| + "ListCourseAliasesResponse": {
|
| + "description": "Response when listing course aliases.",
|
| + "id": "ListCourseAliasesResponse",
|
| "properties": {
|
| - "title": {
|
| - "description": "Title for this set.",
|
| + "nextPageToken": {
|
| + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| "type": "string"
|
| },
|
| - "materials": {
|
| - "description": "Materials attached to this set.",
|
| + "aliases": {
|
| + "description": "The course aliases.",
|
| "items": {
|
| - "$ref": "CourseMaterial"
|
| + "$ref": "CourseAlias"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| + "ShortAnswerSubmission": {
|
| + "description": "Student work for a short answer question.",
|
| + "id": "ShortAnswerSubmission",
|
| + "properties": {
|
| + "answer": {
|
| + "description": "Student response to a short-answer question.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| "CourseMaterial": {
|
| "description": "A material attached to a course as part of a material set.",
|
| "id": "CourseMaterial",
|
| @@ -1732,67 +1851,73 @@
|
| },
|
| "type": "object"
|
| },
|
| - "DriveFile": {
|
| - "description": "Representation of a Google Drive file.",
|
| - "id": "DriveFile",
|
| + "MultipleChoiceSubmission": {
|
| + "description": "Student work for a multiple-choice question.",
|
| + "id": "MultipleChoiceSubmission",
|
| "properties": {
|
| - "id": {
|
| - "description": "Drive API resource ID.",
|
| - "type": "string"
|
| - },
|
| - "title": {
|
| - "description": "Title of the Drive item. Read-only.",
|
| - "type": "string"
|
| - },
|
| - "alternateLink": {
|
| - "description": "URL that can be used to access the Drive item. Read-only.",
|
| - "type": "string"
|
| - },
|
| - "thumbnailUrl": {
|
| - "description": "URL of a thumbnail image of the Drive item. Read-only.",
|
| + "answer": {
|
| + "description": "Student's select choice.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "YouTubeVideo": {
|
| - "description": "YouTube video item.",
|
| - "id": "YouTubeVideo",
|
| + "Link": {
|
| + "description": "URL item.",
|
| + "id": "Link",
|
| "properties": {
|
| - "id": {
|
| - "description": "YouTube API resource ID.",
|
| - "type": "string"
|
| - },
|
| - "title": {
|
| - "description": "Title of the YouTube video. Read-only.",
|
| + "url": {
|
| + "description": "URL to link to.\nThis must be a valid UTF-8 string containing between 1 and 2024 characters.",
|
| "type": "string"
|
| },
|
| - "alternateLink": {
|
| - "description": "URL that can be used to view the YouTube video. Read-only.",
|
| + "thumbnailUrl": {
|
| + "description": "URL of a thumbnail image of the target URL.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "thumbnailUrl": {
|
| - "description": "URL of a thumbnail image of the YouTube video. Read-only.",
|
| + "title": {
|
| + "description": "Title of the target of the URL.\n\nRead-only.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Link": {
|
| - "description": "URL item.",
|
| - "id": "Link",
|
| + "ModifyAttachmentsRequest": {
|
| + "description": "Request to modify the attachments of a student submission.",
|
| + "id": "ModifyAttachmentsRequest",
|
| "properties": {
|
| - "url": {
|
| - "description": "URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.",
|
| - "type": "string"
|
| + "addAttachments": {
|
| + "description": "Attachments to add.\nA student submission may not have more than 20 attachments.\n\nForm attachments are not supported.",
|
| + "items": {
|
| + "$ref": "Attachment"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "TimeOfDay": {
|
| + "description": "Represents a time of day. The date and time zone are either not significant\nor are specified elsewhere. An API may choose to allow leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp`.",
|
| + "id": "TimeOfDay",
|
| + "properties": {
|
| + "nanos": {
|
| + "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| },
|
| - "title": {
|
| - "description": "Title of the target of the URL. Read-only.",
|
| - "type": "string"
|
| + "hours": {
|
| + "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios like business closing time.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| },
|
| - "thumbnailUrl": {
|
| - "description": "URL of a thumbnail image of the target URL. Read-only.",
|
| - "type": "string"
|
| + "minutes": {
|
| + "description": "Minutes of hour of day. Must be from 0 to 59.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "seconds": {
|
| + "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1801,186 +1926,207 @@
|
| "description": "Google Forms item.",
|
| "id": "Form",
|
| "properties": {
|
| - "formUrl": {
|
| - "description": "URL of the form.",
|
| + "thumbnailUrl": {
|
| + "description": "URL of a thumbnail image of the Form.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "responseUrl": {
|
| - "description": "URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form. Read-only.",
|
| + "formUrl": {
|
| + "description": "URL of the form.",
|
| "type": "string"
|
| },
|
| "title": {
|
| - "description": "Title of the Form. Read-only.",
|
| + "description": "Title of the Form.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "thumbnailUrl": {
|
| - "description": "URL of a thumbnail image of the Form. Read-only.",
|
| + "responseUrl": {
|
| + "description": "URL of the form responses document.\nOnly set if respsonses have been recorded and only when the\nrequesting user is an editor of the form.\n\nRead-only.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Empty": {
|
| - "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 representation for `Empty` is empty JSON object `{}`.",
|
| - "id": "Empty",
|
| - "type": "object"
|
| - },
|
| - "ListCoursesResponse": {
|
| - "description": "Response when listing courses.",
|
| - "id": "ListCoursesResponse",
|
| + "MultipleChoiceQuestion": {
|
| + "description": "Additional details for multiple-choice questions.",
|
| + "id": "MultipleChoiceQuestion",
|
| "properties": {
|
| - "courses": {
|
| - "description": "Courses that match the list request.",
|
| + "choices": {
|
| + "description": "Possible choices.",
|
| "items": {
|
| - "$ref": "Course"
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| - },
|
| - "nextPageToken": {
|
| - "description": "Token identifying the next page of results to return. If empty, no further results are available.",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "CourseAlias": {
|
| - "description": "Alternative identifier for a course. An alias uniquely identifies a course. It must 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 can be created only by a domain admin. A domain-scoped alias is often used when a course has an identifier external to Classroom. * project: A project-scoped alias is visible to any request from an application using the Developer Console project ID that created the alias and can be created by any project. A project-scoped alias is often used when an application has alternative identifiers. 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 previous one has succeeded.",
|
| - "id": "CourseAlias",
|
| - "properties": {
|
| - "alias": {
|
| - "description": "Alias string. The format of the string indicates the desired alias scoping. * `d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a project-scoped alias. Example: `p:abc123` This field has a maximum length of 256 characters.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListCourseAliasesResponse": {
|
| - "description": "Response when listing course aliases.",
|
| - "id": "ListCourseAliasesResponse",
|
| + "CourseMaterialSet": {
|
| + "description": "A set of materials that appears on the \"About\" page of the course.\nThese materials might include a syllabus, schedule, or other background\ninformation relating to the course as a whole.",
|
| + "id": "CourseMaterialSet",
|
| "properties": {
|
| - "aliases": {
|
| - "description": "The course aliases.",
|
| + "materials": {
|
| + "description": "Materials attached to this set.",
|
| "items": {
|
| - "$ref": "CourseAlias"
|
| + "$ref": "CourseMaterial"
|
| },
|
| "type": "array"
|
| },
|
| - "nextPageToken": {
|
| - "description": "Token identifying the next page of results to return. If empty, no further results are available.",
|
| + "title": {
|
| + "description": "Title for this set.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListGuardianInvitationsResponse": {
|
| - "description": "Response when listing guardian invitations.",
|
| - "id": "ListGuardianInvitationsResponse",
|
| + "StudentSubmission": {
|
| + "description": "Student submission for course work.\n\nStudentSubmission items are generated when a CourseWork item is created.\n\nStudentSubmissions that have never been accessed (i.e. with `state` = NEW)\nmay not have a creation time or update time.",
|
| + "id": "StudentSubmission",
|
| "properties": {
|
| - "guardianInvitations": {
|
| - "description": "Guardian invitations that matched the list request.",
|
| - "items": {
|
| - "$ref": "GuardianInvitation"
|
| - },
|
| - "type": "array"
|
| + "id": {
|
| + "description": "Classroom-assigned Identifier for the student submission.\nThis is unique among submissions for the relevant course work.\n\nRead-only.",
|
| + "type": "string"
|
| },
|
| - "nextPageToken": {
|
| - "description": "Token identifying the next page of results to return. If empty, no further results are available.",
|
| + "courseWorkType": {
|
| + "description": "Type of course work this submission is for.\n\nRead-only.",
|
| + "enum": [
|
| + "COURSE_WORK_TYPE_UNSPECIFIED",
|
| + "ASSIGNMENT",
|
| + "SHORT_ANSWER_QUESTION",
|
| + "MULTIPLE_CHOICE_QUESTION"
|
| + ],
|
| + "enumDescriptions": [
|
| + "No work type specified. This is never returned.",
|
| + "An assignment.",
|
| + "A short answer question.",
|
| + "A multiple-choice question."
|
| + ],
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "GuardianInvitation": {
|
| - "description": "An invitation to become the guardian of a specified user, sent to a specified email address.",
|
| - "id": "GuardianInvitation",
|
| - "properties": {
|
| - "studentId": {
|
| - "description": "ID of the student (in standard format)",
|
| + },
|
| + "assignedGrade": {
|
| + "description": "Optional grade. If unset, no grade was set.\nThis must be a non-negative integer value.\n\nThis may be modified only by course teachers.",
|
| + "format": "double",
|
| + "type": "number"
|
| + },
|
| + "associatedWithDeveloper": {
|
| + "description": "Whether this student submission is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only.",
|
| + "type": "boolean"
|
| + },
|
| + "updateTime": {
|
| + "description": "Last update time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.",
|
| + "format": "google-datetime",
|
| "type": "string"
|
| },
|
| - "invitationId": {
|
| - "description": "Unique identifier for this invitation. Read-only.",
|
| + "alternateLink": {
|
| + "description": "Absolute link to the submission in the Classroom web UI.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "invitedEmailAddress": {
|
| - "description": "Email address that the invitation was sent to. This field is only visible to domain administrators.",
|
| + "draftGrade": {
|
| + "description": "Optional pending grade. If unset, no grade was set.\nThis must be a non-negative integer value.\n\nThis is only visible to and modifiable by course teachers.",
|
| + "format": "double",
|
| + "type": "number"
|
| + },
|
| + "userId": {
|
| + "description": "Identifier for the student that owns this submission.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| + "multipleChoiceSubmission": {
|
| + "$ref": "MultipleChoiceSubmission",
|
| + "description": "Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION."
|
| + },
|
| "state": {
|
| - "description": "The state that this invitation is in.",
|
| + "description": "State of this submission.\n\nRead-only.",
|
| "enum": [
|
| - "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
|
| - "PENDING",
|
| - "COMPLETE"
|
| + "SUBMISSION_STATE_UNSPECIFIED",
|
| + "NEW",
|
| + "CREATED",
|
| + "TURNED_IN",
|
| + "RETURNED",
|
| + "RECLAIMED_BY_STUDENT"
|
| + ],
|
| + "enumDescriptions": [
|
| + "No state specified. This should never be returned.",
|
| + "The student has never accessed this submission. Attachments are not\nreturned and timestamps is not set.",
|
| + "Has been created.",
|
| + "Has been turned in to the teacher.",
|
| + "Has been returned to the student.",
|
| + "Student chose to \"unsubmit\" the assignment."
|
| ],
|
| "type": "string"
|
| },
|
| + "assignmentSubmission": {
|
| + "$ref": "AssignmentSubmission",
|
| + "description": "Submission content when course_work_type is ASSIGNMENT ."
|
| + },
|
| "creationTime": {
|
| - "description": "The time that this invitation was created. Read-only.",
|
| + "description": "Creation time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.",
|
| + "format": "google-datetime",
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "UserProfile": {
|
| - "description": "Global information for a user.",
|
| - "id": "UserProfile",
|
| - "properties": {
|
| - "id": {
|
| - "description": "Identifier of the user. Read-only.",
|
| + },
|
| + "courseId": {
|
| + "description": "Identifier of the course.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "name": {
|
| - "$ref": "Name",
|
| - "description": "Name of the user. Read-only."
|
| + "shortAnswerSubmission": {
|
| + "$ref": "ShortAnswerSubmission",
|
| + "description": "Submission content when course_work_type is SHORT_ANSWER_QUESTION."
|
| },
|
| - "emailAddress": {
|
| - "description": "Email address of the user. Read-only.",
|
| - "type": "string"
|
| + "late": {
|
| + "description": "Whether this submission is late.\n\nRead-only.",
|
| + "type": "boolean"
|
| },
|
| - "photoUrl": {
|
| - "description": "URL of user's profile photo. Read-only.",
|
| + "courseWorkId": {
|
| + "description": "Identifier for the course work this corresponds to.\n\nRead-only.",
|
| "type": "string"
|
| - },
|
| - "permissions": {
|
| - "description": "Global permissions of the user. Read-only.",
|
| - "items": {
|
| - "$ref": "GlobalPermission"
|
| - },
|
| - "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Name": {
|
| - "description": "Details of the user's name.",
|
| - "id": "Name",
|
| + "CourseAlias": {
|
| + "description": "Alternative identifier for a course.\n\nAn alias uniquely identifies a course. It must be unique within one of the\nfollowing scopes:\n\n* domain: A domain-scoped alias is visible to all users within the alias\ncreator's domain and can be created only by a domain admin. A domain-scoped\nalias is often used when a course has an identifier external to Classroom.\n\n* project: A project-scoped alias is visible to any request from an\napplication using the Developer Console project ID that created the alias\nand can be created by any project. A project-scoped alias is often used when\nan application has alternative identifiers. A random value can also be used\nto avoid duplicate courses in the event of transmission failures, as retrying\na request will return `ALREADY_EXISTS` if a previous one has succeeded.",
|
| + "id": "CourseAlias",
|
| "properties": {
|
| - "givenName": {
|
| - "description": "The user's first name. Read-only.",
|
| - "type": "string"
|
| - },
|
| - "familyName": {
|
| - "description": "The user's last name. Read-only.",
|
| + "alias": {
|
| + "description": "Alias string. The format of the string indicates the desired alias scoping.\n\n* `d:<name>` indicates a domain-scoped alias.\n Example: `d:math_101`\n* `p:<name>` indicates a project-scoped alias.\n Example: `p:abc123`\n\nThis field has a maximum length of 256 characters.",
|
| "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ListGuardiansResponse": {
|
| + "description": "Response when listing guardians.",
|
| + "id": "ListGuardiansResponse",
|
| + "properties": {
|
| + "guardians": {
|
| + "description": "Guardians on this page of results that met the criteria specified in\nthe request.",
|
| + "items": {
|
| + "$ref": "Guardian"
|
| + },
|
| + "type": "array"
|
| },
|
| - "fullName": {
|
| - "description": "The user's full name formed by concatenating the first and last name values. Read-only.",
|
| + "nextPageToken": {
|
| + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "GlobalPermission": {
|
| - "description": "Global user permission description.",
|
| - "id": "GlobalPermission",
|
| + "Guardian": {
|
| + "description": "Association between a student and a guardian of that student. The guardian\nmay receive information about the student's course work.",
|
| + "id": "Guardian",
|
| "properties": {
|
| - "permission": {
|
| - "description": "Permission value.",
|
| - "enum": [
|
| - "PERMISSION_UNSPECIFIED",
|
| - "CREATE_COURSE"
|
| - ],
|
| + "guardianProfile": {
|
| + "$ref": "UserProfile",
|
| + "description": "User profile for the guardian."
|
| + },
|
| + "invitedEmailAddress": {
|
| + "description": "The email address to which the initial guardian invitation was sent.\nThis field is only visible to domain administrators.",
|
| + "type": "string"
|
| + },
|
| + "studentId": {
|
| + "description": "Identifier for the student to whom the guardian relationship applies.",
|
| + "type": "string"
|
| + },
|
| + "guardianId": {
|
| + "description": "Identifier for the guardian.",
|
| "type": "string"
|
| }
|
| },
|
| @@ -1991,278 +2137,352 @@
|
| "id": "Teacher",
|
| "properties": {
|
| "courseId": {
|
| - "description": "Identifier of the course. Read-only.",
|
| - "type": "string"
|
| - },
|
| - "userId": {
|
| - "description": "Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
|
| + "description": "Identifier of the course.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| "profile": {
|
| "$ref": "UserProfile",
|
| - "description": "Global user information for the teacher. Read-only."
|
| + "description": "Global user information for the teacher.\n\nRead-only."
|
| + },
|
| + "userId": {
|
| + "description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListTeachersResponse": {
|
| - "description": "Response when listing teachers.",
|
| - "id": "ListTeachersResponse",
|
| + "UserProfile": {
|
| + "description": "Global information for a user.",
|
| + "id": "UserProfile",
|
| "properties": {
|
| - "teachers": {
|
| - "description": "Teachers who match the list request.",
|
| + "emailAddress": {
|
| + "description": "Email address of the user.\n\nRead-only.",
|
| + "type": "string"
|
| + },
|
| + "permissions": {
|
| + "description": "Global permissions of the user.\n\nRead-only.",
|
| "items": {
|
| - "$ref": "Teacher"
|
| + "$ref": "GlobalPermission"
|
| },
|
| "type": "array"
|
| },
|
| - "nextPageToken": {
|
| - "description": "Token identifying the next page of results to return. If empty, no further results are available.",
|
| + "id": {
|
| + "description": "Identifier of the user.\n\nRead-only.",
|
| + "type": "string"
|
| + },
|
| + "name": {
|
| + "$ref": "Name",
|
| + "description": "Name of the user.\n\nRead-only."
|
| + },
|
| + "photoUrl": {
|
| + "description": "URL of user's profile photo.\n\nRead-only.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| + "ReclaimStudentSubmissionRequest": {
|
| + "description": "Request to reclaim a student submission.",
|
| + "id": "ReclaimStudentSubmissionRequest",
|
| + "properties": {},
|
| + "type": "object"
|
| + },
|
| "Student": {
|
| "description": "Student in a course.",
|
| "id": "Student",
|
| - "properties": {
|
| - "courseId": {
|
| - "description": "Identifier of the course. Read-only.",
|
| - "type": "string"
|
| - },
|
| - "userId": {
|
| - "description": "Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
|
| - "type": "string"
|
| - },
|
| - "profile": {
|
| - "$ref": "UserProfile",
|
| - "description": "Global user information for the student. Read-only."
|
| - },
|
| - "studentWorkFolder": {
|
| - "$ref": "DriveFolder",
|
| - "description": "Information about a Drive Folder for this student's work in this course. Only visible to the student and domain administrators. Read-only."
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ListStudentsResponse": {
|
| - "description": "Response when listing students.",
|
| - "id": "ListStudentsResponse",
|
| - "properties": {
|
| - "students": {
|
| - "description": "Students who match the list request.",
|
| - "items": {
|
| - "$ref": "Student"
|
| - },
|
| - "type": "array"
|
| + "properties": {
|
| + "courseId": {
|
| + "description": "Identifier of the course.\n\nRead-only.",
|
| + "type": "string"
|
| },
|
| - "nextPageToken": {
|
| - "description": "Token identifying the next page of results to return. If empty, no further results are available.",
|
| + "profile": {
|
| + "$ref": "UserProfile",
|
| + "description": "Global user information for the student.\n\nRead-only."
|
| + },
|
| + "studentWorkFolder": {
|
| + "$ref": "DriveFolder",
|
| + "description": "Information about a Drive Folder for this student's work in this course.\nOnly visible to the student and domain administrators.\n\nRead-only."
|
| + },
|
| + "userId": {
|
| + "description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListGuardiansResponse": {
|
| - "description": "Response when listing guardians.",
|
| - "id": "ListGuardiansResponse",
|
| + "ListTeachersResponse": {
|
| + "description": "Response when listing teachers.",
|
| + "id": "ListTeachersResponse",
|
| "properties": {
|
| - "guardians": {
|
| - "description": "Guardians on this page of results that met the criteria specified in the request.",
|
| + "nextPageToken": {
|
| + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| + "type": "string"
|
| + },
|
| + "teachers": {
|
| + "description": "Teachers who match the list request.",
|
| "items": {
|
| - "$ref": "Guardian"
|
| + "$ref": "Teacher"
|
| },
|
| "type": "array"
|
| - },
|
| - "nextPageToken": {
|
| - "description": "Token identifying the next page of results to return. If empty, no further results are available.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Guardian": {
|
| - "description": "Association between a student and a guardian of that student. The guardian may receive information about the student's course work.",
|
| - "id": "Guardian",
|
| + "Course": {
|
| + "description": "A Course in Classroom.",
|
| + "id": "Course",
|
| "properties": {
|
| - "studentId": {
|
| - "description": "Identifier for the student to whom the guardian relationship applies.",
|
| + "id": {
|
| + "description": "Identifier for this course assigned by Classroom.\n\nWhen\ncreating a course,\nyou may optionally set this identifier to an\nalias string in the\nrequest to create a corresponding alias. The `id` is still assigned by\nClassroom and cannot be updated after the course is created.\n\nSpecifying this field in a course update mask results in an error.",
|
| "type": "string"
|
| },
|
| - "guardianId": {
|
| - "description": "Identifier for the guardian.",
|
| + "description": {
|
| + "description": "Optional description.\nFor example, \"We'll be learning about the structure of living\ncreatures from a combination of textbooks, guest lectures, and lab work.\nExpect to be excited!\"\nIf set, this field must be a valid UTF-8 string and no longer than 30,000\ncharacters.",
|
| "type": "string"
|
| },
|
| - "guardianProfile": {
|
| - "$ref": "UserProfile",
|
| - "description": "User profile for the guardian."
|
| + "updateTime": {
|
| + "description": "Time of the most recent update to this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
|
| + "format": "google-datetime",
|
| + "type": "string"
|
| },
|
| - "invitedEmailAddress": {
|
| - "description": "The email address to which the initial guardian invitation was sent. This field is only visible to domain administrators.",
|
| + "section": {
|
| + "description": "Section of the course.\nFor example, \"Period 2\".\nIf set, this field must be a valid UTF-8 string and no longer than 2800\ncharacters.",
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "Invitation": {
|
| - "description": "An invitation to join a course.",
|
| - "id": "Invitation",
|
| - "properties": {
|
| - "id": {
|
| - "description": "Identifier assigned by Classroom. Read-only.",
|
| + },
|
| + "alternateLink": {
|
| + "description": "Absolute link to this course in the Classroom web UI.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "userId": {
|
| - "description": "Identifier of the invited user. When specified as a parameter of a request, this identifier can be set to one of the following: * the numeric identifier for the user * the email address of the user * the string literal `\"me\"`, indicating the requesting user",
|
| + "teacherGroupEmail": {
|
| + "description": "The email address of a Google group containing all teachers of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "courseId": {
|
| - "description": "Identifier of the course to invite the user to.",
|
| + "guardiansEnabled": {
|
| + "description": "Whether or not guardian notifications are enabled for this course.\n\nRead-only.",
|
| + "type": "boolean"
|
| + },
|
| + "ownerId": {
|
| + "description": "The identifier of the owner of a course.\n\nWhen specified as a parameter of a\ncreate course request, this\nfield is required.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n\nThis must be set in a create request. Specifying this field in a course\nupdate mask results in an `INVALID_ARGUMENT` error.",
|
| "type": "string"
|
| },
|
| - "role": {
|
| - "description": "Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`.",
|
| + "descriptionHeading": {
|
| + "description": "Optional heading for the description.\nFor example, \"Welcome to 10th Grade Biology.\"\nIf set, this field must be a valid UTF-8 string and no longer than 3600\ncharacters.",
|
| + "type": "string"
|
| + },
|
| + "courseGroupEmail": {
|
| + "description": "The email address of a Google group containing all members of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.",
|
| + "type": "string"
|
| + },
|
| + "courseState": {
|
| + "description": "State of the course.\nIf unspecified, the default state is `PROVISIONED`.",
|
| "enum": [
|
| - "COURSE_ROLE_UNSPECIFIED",
|
| - "STUDENT",
|
| - "TEACHER"
|
| + "COURSE_STATE_UNSPECIFIED",
|
| + "ACTIVE",
|
| + "ARCHIVED",
|
| + "PROVISIONED",
|
| + "DECLINED",
|
| + "SUSPENDED"
|
| + ],
|
| + "enumDescriptions": [
|
| + "No course state. No returned Course message will use this value.",
|
| + "The course is active.",
|
| + "The course has been archived. You cannot modify it except to change it\nto a different state.",
|
| + "The course has been created, but not yet activated. It is accessible by\nthe primary teacher and domain administrators, who may modify it or\nchange it to the `ACTIVE` or `DECLINED` states.\nA course may only be changed to `PROVISIONED` if it is in the `DECLINED`\nstate.",
|
| + "The course has been created, but declined. It is accessible by the\ncourse owner and domain administrators, though it will not be\ndisplayed in the web UI. You cannot modify the course except to change it\nto the `PROVISIONED` state.\nA course may only be changed to `DECLINED` if it is in the `PROVISIONED`\nstate.",
|
| + "The course has been suspended. You cannot modify the course, and only the\nuser identified by the `owner_id` can view the course.\nA course may be placed in this state if it potentially violates the\nTerms of Service."
|
| ],
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ListInvitationsResponse": {
|
| - "description": "Response when listing invitations.",
|
| - "id": "ListInvitationsResponse",
|
| - "properties": {
|
| - "invitations": {
|
| - "description": "Invitations that match the list request.",
|
| - "items": {
|
| - "$ref": "Invitation"
|
| - },
|
| - "type": "array"
|
| },
|
| - "nextPageToken": {
|
| - "description": "Token identifying the next page of results to return. If empty, no further results are available.",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "CourseWork": {
|
| - "description": "Course work created by a teacher for students of the course.",
|
| - "id": "CourseWork",
|
| - "properties": {
|
| - "courseId": {
|
| - "description": "Identifier of the course. Read-only.",
|
| + "room": {
|
| + "description": "Optional room location.\nFor example, \"301\".\nIf set, this field must be a valid UTF-8 string and no longer than 650\ncharacters.",
|
| "type": "string"
|
| },
|
| - "id": {
|
| - "description": "Classroom-assigned identifier of this course work, unique per course. Read-only.",
|
| + "name": {
|
| + "description": "Name of the course.\nFor example, \"10th Grade Biology\".\nThe name is required. It must be between 1 and 750 characters and a valid\nUTF-8 string.",
|
| "type": "string"
|
| },
|
| - "title": {
|
| - "description": "Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.",
|
| + "creationTime": {
|
| + "description": "Creation time of the course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
|
| + "format": "google-datetime",
|
| "type": "string"
|
| },
|
| - "description": {
|
| - "description": "Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters.",
|
| + "enrollmentCode": {
|
| + "description": "Enrollment code to use when joining this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "materials": {
|
| - "description": "Additional materials. CourseWork must have no more than 20 material items.",
|
| + "teacherFolder": {
|
| + "$ref": "DriveFolder",
|
| + "description": "Information about a Drive Folder that is shared with all teachers of the\ncourse.\n\nThis field will only be set for teachers of the course and domain administrators.\n\nRead-only."
|
| + },
|
| + "courseMaterialSets": {
|
| + "description": "Sets of materials that appear on the \"about\" page of this course.\n\nRead-only.",
|
| "items": {
|
| - "$ref": "Material"
|
| + "$ref": "CourseMaterialSet"
|
| },
|
| "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ReturnStudentSubmissionRequest": {
|
| + "description": "Request to return a student submission.",
|
| + "id": "ReturnStudentSubmissionRequest",
|
| + "properties": {},
|
| + "type": "object"
|
| + },
|
| + "GuardianInvitation": {
|
| + "description": "An invitation to become the guardian of a specified user, sent to a specified\nemail address.",
|
| + "id": "GuardianInvitation",
|
| + "properties": {
|
| + "creationTime": {
|
| + "description": "The time that this invitation was created.\n\nRead-only.",
|
| + "format": "google-datetime",
|
| + "type": "string"
|
| + },
|
| + "invitationId": {
|
| + "description": "Unique identifier for this invitation.\n\nRead-only.",
|
| + "type": "string"
|
| },
|
| "state": {
|
| - "description": "Status of this course work. If unspecified, the default state is `DRAFT`.",
|
| + "description": "The state that this invitation is in.",
|
| "enum": [
|
| - "COURSE_WORK_STATE_UNSPECIFIED",
|
| - "PUBLISHED",
|
| - "DRAFT",
|
| - "DELETED"
|
| + "GUARDIAN_INVITATION_STATE_UNSPECIFIED",
|
| + "PENDING",
|
| + "COMPLETE"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Should never be returned.",
|
| + "The invitation is active and awaiting a response.",
|
| + "The invitation is no longer active. It may have been accepted, declined,\nwithdrawn or it may have expired."
|
| ],
|
| "type": "string"
|
| },
|
| - "alternateLink": {
|
| - "description": "Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.",
|
| + "invitedEmailAddress": {
|
| + "description": "Email address that the invitation was sent to.\nThis field is only visible to domain administrators.",
|
| "type": "string"
|
| },
|
| - "creationTime": {
|
| - "description": "Timestamp when this course work was created. Read-only.",
|
| + "studentId": {
|
| + "description": "ID of the student (in standard format)",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "TurnInStudentSubmissionRequest": {
|
| + "description": "Request to turn in a student submission.",
|
| + "id": "TurnInStudentSubmissionRequest",
|
| + "properties": {},
|
| + "type": "object"
|
| + },
|
| + "YouTubeVideo": {
|
| + "description": "YouTube video item.",
|
| + "id": "YouTubeVideo",
|
| + "properties": {
|
| + "thumbnailUrl": {
|
| + "description": "URL of a thumbnail image of the YouTube video.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "updateTime": {
|
| - "description": "Timestamp of the most recent change to this course work. Read-only.",
|
| + "title": {
|
| + "description": "Title of the YouTube video.\n\nRead-only.",
|
| "type": "string"
|
| },
|
| - "dueDate": {
|
| - "$ref": "Date",
|
| - "description": "Optional date, in UTC, that submissions for this this course work are due. This must be specified if `due_time` is specified."
|
| + "alternateLink": {
|
| + "description": "URL that can be used to view the YouTube video.\n\nRead-only.",
|
| + "type": "string"
|
| },
|
| - "dueTime": {
|
| - "$ref": "TimeOfDay",
|
| - "description": "Optional time of day, in UTC, that submissions for this this course work are due. This must be specified if `due_date` is specified."
|
| + "id": {
|
| + "description": "YouTube API resource ID.",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "Empty": {
|
| + "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
|
| + "id": "Empty",
|
| + "properties": {},
|
| + "type": "object"
|
| + },
|
| + "ListCourseWorkResponse": {
|
| + "description": "Response when listing course work.",
|
| + "id": "ListCourseWorkResponse",
|
| + "properties": {
|
| + "nextPageToken": {
|
| + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| + "type": "string"
|
| },
|
| - "maxPoints": {
|
| - "description": "Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value.",
|
| - "format": "double",
|
| - "type": "number"
|
| + "courseWork": {
|
| + "description": "Course work items that match the request.",
|
| + "items": {
|
| + "$ref": "CourseWork"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "SharedDriveFile": {
|
| + "description": "Drive file that is used as material for course work.",
|
| + "id": "SharedDriveFile",
|
| + "properties": {
|
| + "driveFile": {
|
| + "$ref": "DriveFile",
|
| + "description": "Drive file details."
|
| },
|
| - "workType": {
|
| - "description": "Type of this course work. The type is set when the course work is created and cannot be changed.",
|
| + "shareMode": {
|
| + "description": "Mechanism by which students access the Drive item.",
|
| "enum": [
|
| - "COURSE_WORK_TYPE_UNSPECIFIED",
|
| - "ASSIGNMENT",
|
| - "SHORT_ANSWER_QUESTION",
|
| - "MULTIPLE_CHOICE_QUESTION"
|
| + "UNKNOWN_SHARE_MODE",
|
| + "VIEW",
|
| + "EDIT",
|
| + "STUDENT_COPY"
|
| + ],
|
| + "enumDescriptions": [
|
| + "No sharing mode specified. This should never be returned.",
|
| + "Students can view the shared file.",
|
| + "Students can edit the shared file.",
|
| + "Students have a personal copy of the shared file."
|
| ],
|
| "type": "string"
|
| - },
|
| - "associatedWithDeveloper": {
|
| - "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.",
|
| - "type": "boolean"
|
| - },
|
| - "submissionModificationMode": {
|
| - "description": "Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.",
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "GlobalPermission": {
|
| + "description": "Global user permission description.",
|
| + "id": "GlobalPermission",
|
| + "properties": {
|
| + "permission": {
|
| + "description": "Permission value.",
|
| "enum": [
|
| - "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED",
|
| - "MODIFIABLE_UNTIL_TURNED_IN",
|
| - "MODIFIABLE"
|
| + "PERMISSION_UNSPECIFIED",
|
| + "CREATE_COURSE"
|
| + ],
|
| + "enumDescriptions": [
|
| + "No permission is specified. This is not returned and is not a\nvalid value.",
|
| + "User is permitted to create a course."
|
| ],
|
| "type": "string"
|
| - },
|
| - "assignment": {
|
| - "$ref": "Assignment",
|
| - "description": "Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only."
|
| - },
|
| - "multipleChoiceQuestion": {
|
| - "$ref": "MultipleChoiceQuestion",
|
| - "description": "Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. 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 otherwise."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| "Material": {
|
| - "description": "Material attached to course work. When creating attachments, setting the `form` field is not supported.",
|
| + "description": "Material attached to course work.\n\nWhen creating attachments, setting the `form` field is not supported.",
|
| "id": "Material",
|
| "properties": {
|
| "driveFile": {
|
| "$ref": "SharedDriveFile",
|
| "description": "Google Drive file material."
|
| },
|
| + "link": {
|
| + "$ref": "Link",
|
| + "description": "Link material. On creation, will be upgraded to a more appropriate type\nif possible, and this will be reflected in the response."
|
| + },
|
| "youtubeVideo": {
|
| "$ref": "YouTubeVideo",
|
| "description": "YouTube video material."
|
| },
|
| - "link": {
|
| - "$ref": "Link",
|
| - "description": "Link material. On creation, will be upgraded to a more appropriate type if possible, and this will be reflected in the response."
|
| - },
|
| "form": {
|
| "$ref": "Form",
|
| "description": "Google Forms material."
|
| @@ -2270,70 +2490,36 @@
|
| },
|
| "type": "object"
|
| },
|
| - "SharedDriveFile": {
|
| - "description": "Drive file that is used as material for course work.",
|
| - "id": "SharedDriveFile",
|
| + "AssignmentSubmission": {
|
| + "description": "Student work for an assignment.",
|
| + "id": "AssignmentSubmission",
|
| "properties": {
|
| - "driveFile": {
|
| - "$ref": "DriveFile",
|
| - "description": "Drive file details."
|
| - },
|
| - "shareMode": {
|
| - "description": "Mechanism by which students access the Drive item.",
|
| - "enum": [
|
| - "UNKNOWN_SHARE_MODE",
|
| - "VIEW",
|
| - "EDIT",
|
| - "STUDENT_COPY"
|
| - ],
|
| - "type": "string"
|
| + "attachments": {
|
| + "description": "Attachments added by the student.\nDrive files that correspond to materials with a share mode of\nSTUDENT_COPY may not exist yet if the student has not accessed the\nassignment in Classroom.\n\nSome attachment metadata is only populated if the requesting user has\npermission to access it. Identifier and alternate_link fields are always\navailable, but others (e.g. title) may not be.",
|
| + "items": {
|
| + "$ref": "Attachment"
|
| + },
|
| + "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| "Date": {
|
| - "description": "Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.",
|
| + "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
|
| "id": "Date",
|
| "properties": {
|
| - "year": {
|
| - "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| "month": {
|
| "description": "Month of year. Must be from 1 to 12.",
|
| "format": "int32",
|
| "type": "integer"
|
| },
|
| - "day": {
|
| - "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "TimeOfDay": {
|
| - "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may chose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.",
|
| - "id": "TimeOfDay",
|
| - "properties": {
|
| - "hours": {
|
| - "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| - "minutes": {
|
| - "description": "Minutes of hour of day. Must be from 0 to 59.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| - "seconds": {
|
| - "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.",
|
| + "year": {
|
| + "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
|
| "format": "int32",
|
| "type": "integer"
|
| },
|
| - "nanos": {
|
| - "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
|
| + "day": {
|
| + "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
|
| "format": "int32",
|
| "type": "integer"
|
| }
|
| @@ -2346,230 +2532,129 @@
|
| "properties": {
|
| "studentWorkFolder": {
|
| "$ref": "DriveFolder",
|
| - "description": "Drive folder where attachments from student submissions are placed. This is only populated for course teachers."
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "MultipleChoiceQuestion": {
|
| - "description": "Additional details for multiple-choice questions.",
|
| - "id": "MultipleChoiceQuestion",
|
| - "properties": {
|
| - "choices": {
|
| - "description": "Possible choices.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| + "description": "Drive folder where attachments from student submissions are placed.\nThis is only populated for course teachers."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "ListCourseWorkResponse": {
|
| - "description": "Response when listing course work.",
|
| - "id": "ListCourseWorkResponse",
|
| + "ListCoursesResponse": {
|
| + "description": "Response when listing courses.",
|
| + "id": "ListCoursesResponse",
|
| "properties": {
|
| - "courseWork": {
|
| - "description": "Course work items that match the request.",
|
| + "nextPageToken": {
|
| + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| + "type": "string"
|
| + },
|
| + "courses": {
|
| + "description": "Courses that match the list request.",
|
| "items": {
|
| - "$ref": "CourseWork"
|
| + "$ref": "Course"
|
| },
|
| "type": "array"
|
| - },
|
| - "nextPageToken": {
|
| - "description": "Token identifying the next page of results to return. If empty, no further results are available.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "StudentSubmission": {
|
| - "description": "Student submission for course work. StudentSubmission items are generated when a CourseWork item is created. StudentSubmissions that have never been accessed (i.e. with `state` = NEW) may not have a creation time or update time.",
|
| - "id": "StudentSubmission",
|
| + "Invitation": {
|
| + "description": "An invitation to join a course.",
|
| + "id": "Invitation",
|
| "properties": {
|
| "courseId": {
|
| - "description": "Identifier of the course. Read-only.",
|
| - "type": "string"
|
| - },
|
| - "courseWorkId": {
|
| - "description": "Identifier for the course work this corresponds to. Read-only.",
|
| - "type": "string"
|
| - },
|
| - "id": {
|
| - "description": "Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work. Read-only.",
|
| - "type": "string"
|
| - },
|
| - "userId": {
|
| - "description": "Identifier for the student that owns this submission. Read-only.",
|
| - "type": "string"
|
| - },
|
| - "creationTime": {
|
| - "description": "Creation time of this submission. This may be unset if the student has not accessed this item. Read-only.",
|
| - "type": "string"
|
| - },
|
| - "updateTime": {
|
| - "description": "Last update time of this submission. This may be unset if the student has not accessed this item. Read-only.",
|
| + "description": "Identifier of the course to invite the user to.",
|
| "type": "string"
|
| },
|
| - "state": {
|
| - "description": "State of this submission. Read-only.",
|
| + "role": {
|
| + "description": "Role to invite the user to have.\nMust not be `COURSE_ROLE_UNSPECIFIED`.",
|
| "enum": [
|
| - "SUBMISSION_STATE_UNSPECIFIED",
|
| - "NEW",
|
| - "CREATED",
|
| - "TURNED_IN",
|
| - "RETURNED",
|
| - "RECLAIMED_BY_STUDENT"
|
| + "COURSE_ROLE_UNSPECIFIED",
|
| + "STUDENT",
|
| + "TEACHER"
|
| + ],
|
| + "enumDescriptions": [
|
| + "No course role.",
|
| + "Student in the course.",
|
| + "Teacher of the course."
|
| ],
|
| "type": "string"
|
| },
|
| - "late": {
|
| - "description": "Whether this submission is late. Read-only.",
|
| - "type": "boolean"
|
| - },
|
| - "draftGrade": {
|
| - "description": "Optional pending grade. If unset, no grade was set. This must be a non-negative integer value. This is only visible to and modifiable by course teachers.",
|
| - "format": "double",
|
| - "type": "number"
|
| - },
|
| - "assignedGrade": {
|
| - "description": "Optional grade. If unset, no grade was set. This must be a non-negative integer value. This may be modified only by course teachers.",
|
| - "format": "double",
|
| - "type": "number"
|
| - },
|
| - "alternateLink": {
|
| - "description": "Absolute link to the submission in the Classroom web UI. Read-only.",
|
| + "userId": {
|
| + "description": "Identifier of the invited user.\n\nWhen specified as a parameter of a request, this identifier can be set to\none of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user",
|
| "type": "string"
|
| },
|
| - "courseWorkType": {
|
| - "description": "Type of course work this submission is for. Read-only.",
|
| - "enum": [
|
| - "COURSE_WORK_TYPE_UNSPECIFIED",
|
| - "ASSIGNMENT",
|
| - "SHORT_ANSWER_QUESTION",
|
| - "MULTIPLE_CHOICE_QUESTION"
|
| - ],
|
| + "id": {
|
| + "description": "Identifier assigned by Classroom.\n\nRead-only.",
|
| "type": "string"
|
| - },
|
| - "associatedWithDeveloper": {
|
| - "description": "Whether this student submission is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only.",
|
| - "type": "boolean"
|
| - },
|
| - "assignmentSubmission": {
|
| - "$ref": "AssignmentSubmission",
|
| - "description": "Submission content when course_work_type is ASSIGNMENT ."
|
| - },
|
| - "shortAnswerSubmission": {
|
| - "$ref": "ShortAnswerSubmission",
|
| - "description": "Submission content when course_work_type is SHORT_ANSWER_QUESTION."
|
| - },
|
| - "multipleChoiceSubmission": {
|
| - "$ref": "MultipleChoiceSubmission",
|
| - "description": "Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION."
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "AssignmentSubmission": {
|
| - "description": "Student work for an assignment.",
|
| - "id": "AssignmentSubmission",
|
| + "ListStudentSubmissionsResponse": {
|
| + "description": "Response when listing student submissions.",
|
| + "id": "ListStudentSubmissionsResponse",
|
| "properties": {
|
| - "attachments": {
|
| - "description": "Attachments added by the student. Drive files that correspond to materials with a share mode of STUDENT_COPY may not exist yet 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. Identifier and alternate_link fields are always available, but others (e.g. title) may not be.",
|
| + "nextPageToken": {
|
| + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| + "type": "string"
|
| + },
|
| + "studentSubmissions": {
|
| + "description": "Student work that matches the request.",
|
| "items": {
|
| - "$ref": "Attachment"
|
| + "$ref": "StudentSubmission"
|
| },
|
| "type": "array"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "Attachment": {
|
| - "description": "Attachment added to student assignment work. When creating attachments, setting the `form` field is not supported.",
|
| - "id": "Attachment",
|
| + "Name": {
|
| + "description": "Details of the user's name.",
|
| + "id": "Name",
|
| "properties": {
|
| - "driveFile": {
|
| - "$ref": "DriveFile",
|
| - "description": "Google Drive file attachment."
|
| - },
|
| - "youTubeVideo": {
|
| - "$ref": "YouTubeVideo",
|
| - "description": "Youtube video attachment."
|
| + "givenName": {
|
| + "description": "The user's first name.\n\nRead-only.",
|
| + "type": "string"
|
| },
|
| - "link": {
|
| - "$ref": "Link",
|
| - "description": "Link attachment."
|
| + "familyName": {
|
| + "description": "The user's last name.\n\nRead-only.",
|
| + "type": "string"
|
| },
|
| - "form": {
|
| - "$ref": "Form",
|
| - "description": "Google Forms attachment."
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ShortAnswerSubmission": {
|
| - "description": "Student work for a short answer question.",
|
| - "id": "ShortAnswerSubmission",
|
| - "properties": {
|
| - "answer": {
|
| - "description": "Student response to a short-answer question.",
|
| + "fullName": {
|
| + "description": "The user's full name formed by concatenating the first and last name\nvalues.\n\nRead-only.",
|
| "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "MultipleChoiceSubmission": {
|
| - "description": "Student work for a multiple-choice question.",
|
| - "id": "MultipleChoiceSubmission",
|
| + "ListInvitationsResponse": {
|
| + "description": "Response when listing invitations.",
|
| + "id": "ListInvitationsResponse",
|
| "properties": {
|
| - "answer": {
|
| - "description": "Student's select choice.",
|
| + "nextPageToken": {
|
| + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ListStudentSubmissionsResponse": {
|
| - "description": "Response when listing student submissions.",
|
| - "id": "ListStudentSubmissionsResponse",
|
| - "properties": {
|
| - "studentSubmissions": {
|
| - "description": "Student work that matches the request.",
|
| + },
|
| + "invitations": {
|
| + "description": "Invitations that match the list request.",
|
| "items": {
|
| - "$ref": "StudentSubmission"
|
| + "$ref": "Invitation"
|
| },
|
| "type": "array"
|
| - },
|
| - "nextPageToken": {
|
| - "description": "Token identifying the next page of results to return. If empty, no further results are available.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "TurnInStudentSubmissionRequest": {
|
| - "description": "Request to turn in a student submission.",
|
| - "id": "TurnInStudentSubmissionRequest",
|
| - "type": "object"
|
| - },
|
| - "ReclaimStudentSubmissionRequest": {
|
| - "description": "Request to reclaim a student submission.",
|
| - "id": "ReclaimStudentSubmissionRequest",
|
| - "type": "object"
|
| - },
|
| - "ReturnStudentSubmissionRequest": {
|
| - "description": "Request to return a student submission.",
|
| - "id": "ReturnStudentSubmissionRequest",
|
| - "type": "object"
|
| - },
|
| - "ModifyAttachmentsRequest": {
|
| - "description": "Request to modify the attachments of a student submission.",
|
| - "id": "ModifyAttachmentsRequest",
|
| + "ListStudentsResponse": {
|
| + "description": "Response when listing students.",
|
| + "id": "ListStudentsResponse",
|
| "properties": {
|
| - "addAttachments": {
|
| - "description": "Attachments to add. A student submission may not have more than 20 attachments. Form attachments are not supported.",
|
| + "nextPageToken": {
|
| + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
|
| + "type": "string"
|
| + },
|
| + "students": {
|
| + "description": "Students who match the list request.",
|
| "items": {
|
| - "$ref": "Attachment"
|
| + "$ref": "Student"
|
| },
|
| "type": "array"
|
| }
|
|
|
Chromium Code Reviews
Issue 2779563003:
Api-roll 47: 2017-03-27 (Closed)
