TrueCloudLab/rclone
16
0
Fork 2
Code Issues 1 Pull requests 1 Projects Releases Packages Wiki Activity Actions 2
rclone/vendor/google.golang.org/api/classroom/v1/classroom-api.json
Nick Craig-Wood eb87cf6f12 vendor: update all dependencies
2017-07-23 08:51:42 +01:00

2759 lines
137 KiB
JSON
Raw Blame History

{
"revision": "20170627",
"documentationLink": "https://developers.google.com/classroom/",
"id": "classroom:v1",
"title": "Google Classroom API",
"discoveryVersion": "v1",
"ownerName": "Google",
"resources": {
"invitations": {
"methods": {
"delete": {
"httpMethod": "DELETE",
"parameterOrder": [
"id"
],
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/classroom.rosters"
],
"parameters": {
"id": {
"description": "Identifier of the invitation to delete.",
"type": "string",
"required": true,
"location": "path"
}
},
"flatPath": "v1/invitations/{id}",
"path": "v1/invitations/{id}",
"id": "classroom.invitations.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."
},
"list": {
"id": "classroom.invitations.list",
"path": "v1/invitations",
"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.",
"response": {
"$ref": "ListInvitationsResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
"pageSize": {
"format": "int32",
"description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
"type": "integer",
"location": "query"
},
"courseId": {
"location": "query",
"description": "Restricts returned invitations to those for a course with the specified\nidentifier.",
"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.",
"type": "string",
"location": "query"
},
"userId": {
"location": "query",
"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",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/classroom.rosters",
"https://www.googleapis.com/auth/classroom.rosters.readonly"
],
"flatPath": "v1/invitations"
},
"get": {
"response": {
"$ref": "Invitation"
},
"parameterOrder": [
"id"
],
"httpMethod": "GET",
"parameters": {
"id": {
"location": "path",
"description": "Identifier of the invitation to return.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/classroom.rosters",
"https://www.googleapis.com/auth/classroom.rosters.readonly"
],
"flatPath": "v1/invitations/{id}",
"id": "classroom.invitations.get",
"path": "v1/invitations/{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."
},
"create": {
"id": "classroom.invitations.create",
"path": "v1/invitations",
"request": {
"$ref": "Invitation"
},
"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.",
"response": {
"$ref": "Invitation"
},
"parameterOrder": [],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/classroom.rosters"
],
"parameters": {},
"flatPath": "v1/invitations"
},
"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.",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"id"
],
"httpMethod": "POST",
"parameters": {
"id": {
"location": "path",
"description": "Identifier of the invitation to accept.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/classroom.rosters"
],
"flatPath": "v1/invitations/{id}:accept",
"id": "classroom.invitations.accept",
"path": "v1/invitations/{id}:accept"
}
}
},
"userProfiles": {
"methods": {
"get": {
"response": {
"$ref": "UserProfile"
},
"parameterOrder": [
"userId"
],
"httpMethod": "GET",
"parameters": {
"userId": {
"location": "path",
"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",
"type": "string",
"required": true
}
},
"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"
],
"flatPath": "v1/userProfiles/{userId}",
"id": "classroom.userProfiles.get",
"path": "v1/userProfiles/{userId}",
"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."
}
},
"resources": {
"guardians": {
"methods": {
"get": {
"httpMethod": "GET",
"response": {
"$ref": "Guardian"
},
"parameterOrder": [
"studentId",
"guardianId"
],
"scopes": [
"https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly",
"https://www.googleapis.com/auth/classroom.guardianlinks.students",
"https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
],
"parameters": {
"studentId": {
"location": "path",
"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",
"type": "string",
"required": true
},
"guardianId": {
"description": "The `id` field from a `Guardian`.",
"type": "string",
"required": true,
"location": "path"
}
},
"flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}",
"path": "v1/userProfiles/{studentId}/guardians/{guardianId}",
"id": "classroom.userProfiles.guardians.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`."
},
"list": {
"id": "classroom.userProfiles.guardians.list",
"path": "v1/userProfiles/{studentId}/guardians",
"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.",
"response": {
"$ref": "ListGuardiansResponse"
},
"httpMethod": "GET",
"parameterOrder": [
"studentId"
],
"scopes": [
"https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly",
"https://www.googleapis.com/auth/classroom.guardianlinks.students",
"https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
],
"parameters": {
"studentId": {
"location": "path",
"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.",
"type": "string",
"required": true
},
"pageToken": {
"location": "query",
"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.",
"type": "string"
},
"pageSize": {
"format": "int32",
"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.",
"type": "integer",
"location": "query"
},
"invitedEmailAddress": {
"location": "query",
"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.",
"type": "string"
}
},
"flatPath": "v1/userProfiles/{studentId}/guardians"
},
"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`.",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"studentId",
"guardianId"
],
"httpMethod": "DELETE",
"parameters": {
"studentId": {
"location": "path",
"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",
"type": "string",
"required": true
},
"guardianId": {
"location": "path",
"description": "The `id` field from a `Guardian`.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/classroom.guardianlinks.students"
],
"flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}",
"id": "classroom.userProfiles.guardians.delete",
"path": "v1/userProfiles/{studentId}/guardians/{guardianId}"
}
}
},
"guardianInvitations": {
"methods": {
"patch": {
"response": {
"$ref": "GuardianInvitation"
},
"parameterOrder": [
"studentId",
"invitationId"
],
"httpMethod": "PATCH",
"parameters": {
"updateMask": {
"location": "query",
"format": "google-fieldmask",
"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=\u003cfield1\u003e,\u003cfield2\u003e,...`",
"type": "string"
},
"invitationId": {
"location": "path",
"description": "The `id` field of the `GuardianInvitation` to be modified.",
"type": "string",
"required": true
},
"studentId": {
"location": "path",
"description": "The ID of the student whose guardian invitation is to be modified.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/classroom.guardianlinks.students"
],
"flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
"id": "classroom.userProfiles.guardianInvitations.patch",
"path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
"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.",
"request": {
"$ref": "GuardianInvitation"
}
},
"get": {
"id": "classroom.userProfiles.guardianInvitations.get",
"path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}",
"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.",
"response": {
"$ref": "GuardianInvitation"
},
"parameterOrder": [
"studentId",
"invitationId"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/classroom.guardianlinks.students",
"https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
],
"parameters": {
"invitationId": {
"location": "path",
"description": "The `id` field of the `GuardianInvitation` being requested.",
"type": "string",
"required": true
},
"studentId": {
"type": "string",
"required": true,
"location": "path",
"description": "The ID of the student whose guardian invitation is being requested."
}
},
"flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}"
},
"list": {
"response": {
"$ref": "ListGuardianInvitationsResponse"
},
"parameterOrder": [
"studentId"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/classroom.guardianlinks.students",
"https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly"
],
"parameters": {
"studentId": {
"type": "string",
"required": true,
"location": "path",
"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."
},
"pageToken": {
"location": "query",
"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.",
"type": "string"
},
"pageSize": {
"format": "int32",
"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.",
"type": "integer",
"location": "query"
},
"states": {
"repeated": true,
"location": "query",
"enum": [
"GUARDIAN_INVITATION_STATE_UNSPECIFIED",
"PENDING",
"COMPLETE"
],
"description": "If specified, only results with the specified `state` values will be\nreturned. Otherwise, results with a `state` of `PENDING` will be returned.",
"type": "string"
},
"invitedEmailAddress": {
"location": "query",
"description": "If specified, only results with the specified `invited_email_address`\nwill be returned.",
"type": "string"
}
},
"flatPath": "v1/userProfiles/{studentId}/guardianInvitations",
"id": "classroom.userProfiles.guardianInvitations.list",
"path": "v1/userProfiles/{studentId}/guardianInvitations",
"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."
},
"create": {
"request": {
"$ref": "GuardianInvitation"
},
"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.",
"response": {
"$ref": "GuardianInvitation"
},
"parameterOrder": [
"studentId"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/classroom.guardianlinks.students"
],
"parameters": {
"studentId": {
"description": "ID of the student (in standard format)",
"type": "string",
"required": true,
"location": "path"
}
},
"flatPath": "v1/userProfiles/{studentId}/guardianInvitations",
"id": "classroom.userProfiles.guardianInvitations.create",
"path": "v1/userProfiles/{studentId}/guardianInvitations"
}
}
}
}
},
"courses": {
"methods": {
"list": {
"scopes": [
"https://www.googleapis.com/auth/classroom.courses",
"https://www.googleapis.com/auth/classroom.courses.readonly"
],
"parameters": {
"studentId": {
"type": "string",
"location": "query",
"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"
},
"pageToken": {
"location": "query",
"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.",
"type": "string"
},
"pageSize": {
"type": "integer",
"location": "query",
"format": "int32",
"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."
},
"courseStates": {
"repeated": true,
"location": "query",
"enum": [
"COURSE_STATE_UNSPECIFIED",
"ACTIVE",
"ARCHIVED",
"PROVISIONED",
"DECLINED",
"SUSPENDED"
],
"description": "Restricts returned courses to those in one of the specified states\nThe default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.",
"type": "string"
},
"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",
"type": "string",
"location": "query"
}
},
"flatPath": "v1/courses",
"path": "v1/courses",
"id": "classroom.courses.list",
"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",
"parameterOrder": [],
"response": {
"$ref": "ListCoursesResponse"
}
},
"create": {
"id": "classroom.courses.create",
"path": "v1/courses",
"request": {
"$ref": "Course"
},
"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.",
"response": {
"$ref": "Course"
},
"parameterOrder": [],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/classroom.courses"
],
"parameters": {},
"flatPath": "v1/courses"
},
"get": {
"id": "classroom.courses.get",
"path": "v1/courses/{id}",
"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.",
"response": {
"$ref": "Course"
},
"parameterOrder": [
"id"
],
"httpMethod": "GET",
"parameters": {
"id": {
"description": "Identifier of the course to return.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true,
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/classroom.courses",
"https://www.googleapis.com/auth/classroom.courses.readonly"
],
"flatPath": "v1/courses/{id}"
},
"patch": {
"response": {
"$ref": "Course"
},
"parameterOrder": [
"id"
],
"httpMethod": "PATCH",
"scopes": [
"https://www.googleapis.com/auth/classroom.courses"
],
"parameters": {
"updateMask": {
"format": "google-fieldmask",
"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=\u003cfield1\u003e,\u003cfield2\u003e,...`",
"type": "string",
"location": "query"
},
"id": {
"description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true,
"location": "path"
}
},
"flatPath": "v1/courses/{id}",
"id": "classroom.courses.patch",
"path": "v1/courses/{id}",
"request": {
"$ref": "Course"
},
"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"
},
"update": {
"response": {
"$ref": "Course"
},
"parameterOrder": [
"id"
],
"httpMethod": "PUT",
"parameters": {
"id": {
"location": "path",
"description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/classroom.courses"
],
"flatPath": "v1/courses/{id}",
"id": "classroom.courses.update",
"path": "v1/courses/{id}",
"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",
"request": {
"$ref": "Course"
}
},
"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.",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"id"
],
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/classroom.courses"
],
"parameters": {
"id": {
"location": "path",
"description": "Identifier of the course to delete.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true
}
},
"flatPath": "v1/courses/{id}",
"id": "classroom.courses.delete",
"path": "v1/courses/{id}"
}
},
"resources": {
"students": {
"methods": {
"delete": {
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"courseId",
"userId"
],
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/classroom.rosters"
],
"parameters": {
"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",
"type": "string",
"required": true,
"location": "path"
},
"courseId": {
"location": "path",
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true
}
},
"flatPath": "v1/courses/{courseId}/students/{userId}",
"id": "classroom.courses.students.delete",
"path": "v1/courses/{courseId}/students/{userId}",
"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."
},
"list": {
"httpMethod": "GET",
"parameterOrder": [
"courseId"
],
"response": {
"$ref": "ListStudentsResponse"
},
"parameters": {
"pageToken": {
"location": "query",
"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.",
"type": "string"
},
"pageSize": {
"format": "int32",
"description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
"type": "integer",
"location": "query"
},
"courseId": {
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true,
"location": "path"
}
},
"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"
],
"flatPath": "v1/courses/{courseId}/students",
"path": "v1/courses/{courseId}/students",
"id": "classroom.courses.students.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."
},
"get": {
"parameters": {
"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",
"type": "string",
"required": true,
"location": "path"
},
"courseId": {
"location": "path",
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true
}
},
"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"
],
"flatPath": "v1/courses/{courseId}/students/{userId}",
"id": "classroom.courses.students.get",
"path": "v1/courses/{courseId}/students/{userId}",
"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.",
"response": {
"$ref": "Student"
},
"parameterOrder": [
"courseId",
"userId"
],
"httpMethod": "GET"
},
"create": {
"response": {
"$ref": "Student"
},
"parameterOrder": [
"courseId"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/classroom.profile.emails",
"https://www.googleapis.com/auth/classroom.profile.photos",
"https://www.googleapis.com/auth/classroom.rosters"
],
"parameters": {
"courseId": {
"location": "path",
"description": "Identifier of the course to create the student in.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true
},
"enrollmentCode": {
"location": "query",
"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.",
"type": "string"
}
},
"flatPath": "v1/courses/{courseId}/students",
"id": "classroom.courses.students.create",
"path": "v1/courses/{courseId}/students",
"request": {
"$ref": "Student"
},
"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."
}
}
},
"courseWork": {
"methods": {
"create": {
"response": {
"$ref": "CourseWork"
},
"parameterOrder": [
"courseId"
],
"httpMethod": "POST",
"parameters": {
"courseId": {
"location": "path",
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/classroom.coursework.students"
],
"flatPath": "v1/courses/{courseId}/courseWork",
"id": "classroom.courses.courseWork.create",
"path": "v1/courses/{courseId}/courseWork",
"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",
"request": {
"$ref": "CourseWork"
}
},
"delete": {
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"courseId",
"id"
],
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/classroom.coursework.students"
],
"parameters": {
"courseId": {
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true,
"location": "path"
},
"id": {
"location": "path",
"description": "Identifier of the course work to delete.\nThis identifier is a Classroom-assigned identifier.",
"type": "string",
"required": true
}
},
"flatPath": "v1/courses/{courseId}/courseWork/{id}",
"id": "classroom.courses.courseWork.delete",
"path": "v1/courses/{courseId}/courseWork/{id}",
"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."
},
"list": {
"response": {
"$ref": "ListCourseWorkResponse"
},
"parameterOrder": [
"courseId"
],
"httpMethod": "GET",
"parameters": {
"pageToken": {
"location": "query",
"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.",
"type": "string"
},
"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`",
"type": "string",
"location": "query"
},
"pageSize": {
"format": "int32",
"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.",
"type": "integer",
"location": "query"
},
"courseWorkStates": {
"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.",
"type": "string",
"repeated": true,
"location": "query",
"enum": [
"COURSE_WORK_STATE_UNSPECIFIED",
"PUBLISHED",
"DRAFT",
"DELETED"
]
},
"courseId": {
"location": "path",
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true
}
},
"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"
],
"flatPath": "v1/courses/{courseId}/courseWork",
"id": "classroom.courses.courseWork.list",
"path": "v1/courses/{courseId}/courseWork",
"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."
},
"get": {
"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.",
"response": {
"$ref": "CourseWork"
},
"parameterOrder": [
"courseId",
"id"
],
"httpMethod": "GET",
"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"
],
"parameters": {
"id": {
"location": "path",
"description": "Identifier of the course work.",
"type": "string",
"required": true
},
"courseId": {
"location": "path",
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true
}
},
"flatPath": "v1/courses/{courseId}/courseWork/{id}",
"id": "classroom.courses.courseWork.get",
"path": "v1/courses/{courseId}/courseWork/{id}"
},
"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.",
"request": {
"$ref": "CourseWork"
},
"httpMethod": "PATCH",
"parameterOrder": [
"courseId",
"id"
],
"response": {
"$ref": "CourseWork"
},
"parameters": {
"courseId": {
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true,
"location": "path"
},
"id": {
"location": "path",
"description": "Identifier of the course work.",
"type": "string",
"required": true
},
"updateMask": {
"location": "query",
"format": "google-fieldmask",
"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* `scheduled_time`\n* `submission_modification_mode`",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/classroom.coursework.students"
],
"flatPath": "v1/courses/{courseId}/courseWork/{id}",
"path": "v1/courses/{courseId}/courseWork/{id}",
"id": "classroom.courses.courseWork.patch"
}
},
"resources": {
"studentSubmissions": {
"methods": {
"turnIn": {
"request": {
"$ref": "TurnInStudentSubmissionRequest"
},
"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.",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"courseId",
"courseWorkId",
"id"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/classroom.coursework.me"
],
"parameters": {
"courseWorkId": {
"location": "path",
"description": "Identifier of the course work.",
"type": "string",
"required": true
},
"courseId": {
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true,
"location": "path"
},
"id": {
"location": "path",
"description": "Identifier of the student submission.",
"type": "string",
"required": true
}
},
"flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
"id": "classroom.courses.courseWork.studentSubmissions.turnIn",
"path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn"
},
"list": {
"response": {
"$ref": "ListStudentSubmissionsResponse"
},
"parameterOrder": [
"courseId",
"courseWorkId"
],
"httpMethod": "GET",
"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"
],
"parameters": {
"userId": {
"location": "query",
"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",
"type": "string"
},
"courseWorkId": {
"location": "path",
"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.",
"type": "string",
"required": true
},
"courseId": {
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true,
"location": "path"
},
"late": {
"location": "query",
"enum": [
"LATE_VALUES_UNSPECIFIED",
"LATE_ONLY",
"NOT_LATE_ONLY"
],
"description": "Requested lateness value. If specified, returned student submissions are\nrestricted by the requested value.\nIf unspecified, submissions are returned regardless of `late` value.",
"type": "string"
},
"pageToken": {
"type": "string",
"location": "query",
"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."
},
"pageSize": {
"format": "int32",
"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.",
"type": "integer",
"location": "query"
},
"states": {
"location": "query",
"enum": [
"SUBMISSION_STATE_UNSPECIFIED",
"NEW",
"CREATED",
"TURNED_IN",
"RETURNED",
"RECLAIMED_BY_STUDENT"
],
"description": "Requested submission states. If specified, returned student submissions\nmatch one of the specified submission states.",
"type": "string",
"repeated": true
}
},
"flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
"id": "classroom.courses.courseWork.studentSubmissions.list",
"path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions",
"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."
},
"modifyAttachments": {
"scopes": [
"https://www.googleapis.com/auth/classroom.coursework.me",
"https://www.googleapis.com/auth/classroom.coursework.students"
],
"parameters": {
"courseWorkId": {
"description": "Identifier of the course work.",
"type": "string",
"required": true,
"location": "path"
},
"courseId": {
"location": "path",
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true
},
"id": {
"type": "string",
"required": true,
"location": "path",
"description": "Identifier of the student submission."
}
},
"flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
"id": "classroom.courses.courseWork.studentSubmissions.modifyAttachments",
"path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
"request": {
"$ref": "ModifyAttachmentsRequest"
},
"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.",
"response": {
"$ref": "StudentSubmission"
},
"parameterOrder": [
"courseId",
"courseWorkId",
"id"
],
"httpMethod": "POST"
},
"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.",
"request": {
"$ref": "StudentSubmission"
},
"response": {
"$ref": "StudentSubmission"
},
"parameterOrder": [
"courseId",
"courseWorkId",
"id"
],
"httpMethod": "PATCH",
"parameters": {
"courseWorkId": {
"description": "Identifier of the course work.",
"type": "string",
"required": true,
"location": "path"
},
"courseId": {
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true,
"location": "path"
},
"id": {
"type": "string",
"required": true,
"location": "path",
"description": "Identifier of the student submission."
},
"updateMask": {
"type": "string",
"location": "query",
"format": "google-fieldmask",
"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`"
}
},
"scopes": [
"https://www.googleapis.com/auth/classroom.coursework.me",
"https://www.googleapis.com/auth/classroom.coursework.students"
],
"flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
"id": "classroom.courses.courseWork.studentSubmissions.patch",
"path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}"
},
"get": {
"httpMethod": "GET",
"parameterOrder": [
"courseId",
"courseWorkId",
"id"
],
"response": {
"$ref": "StudentSubmission"
},
"parameters": {
"courseWorkId": {
"description": "Identifier of the course work.",
"type": "string",
"required": true,
"location": "path"
},
"courseId": {
"type": "string",
"required": true,
"location": "path",
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
},
"id": {
"location": "path",
"description": "Identifier of the student submission.",
"type": "string",
"required": true
}
},
"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"
],
"flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
"path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
"id": "classroom.courses.courseWork.studentSubmissions.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."
},
"return": {
"httpMethod": "POST",
"parameterOrder": [
"courseId",
"courseWorkId",
"id"
],
"response": {
"$ref": "Empty"
},
"parameters": {
"courseWorkId": {
"description": "Identifier of the course work.",
"type": "string",
"required": true,
"location": "path"
},
"courseId": {
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true,
"location": "path"
},
"id": {
"type": "string",
"required": true,
"location": "path",
"description": "Identifier of the student submission."
}
},
"scopes": [
"https://www.googleapis.com/auth/classroom.coursework.students"
],
"flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return",
"path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return",
"id": "classroom.courses.courseWork.studentSubmissions.return",
"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.",
"request": {
"$ref": "ReturnStudentSubmissionRequest"
}
},
"reclaim": {
"request": {
"$ref": "ReclaimStudentSubmissionRequest"
},
"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.",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"courseId",
"courseWorkId",
"id"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/classroom.coursework.me"
],
"parameters": {
"courseWorkId": {
"location": "path",
"description": "Identifier of the course work.",
"type": "string",
"required": true
},
"courseId": {
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true,
"location": "path"
},
"id": {
"type": "string",
"required": true,
"location": "path",
"description": "Identifier of the student submission."
}
},
"flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
"id": "classroom.courses.courseWork.studentSubmissions.reclaim",
"path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim"
}
}
}
}
},
"teachers": {
"methods": {
"delete": {
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"courseId",
"userId"
],
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/classroom.rosters"
],
"parameters": {
"userId": {
"location": "path",
"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",
"type": "string",
"required": true
},
"courseId": {
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true,
"location": "path"
}
},
"flatPath": "v1/courses/{courseId}/teachers/{userId}",
"id": "classroom.courses.teachers.delete",
"path": "v1/courses/{courseId}/teachers/{userId}",
"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."
},
"list": {
"parameters": {
"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.",
"type": "string",
"location": "query"
},
"pageSize": {
"format": "int32",
"description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.",
"type": "integer",
"location": "query"
},
"courseId": {
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true,
"location": "path"
}
},
"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"
],
"flatPath": "v1/courses/{courseId}/teachers",
"id": "classroom.courses.teachers.list",
"path": "v1/courses/{courseId}/teachers",
"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.",
"response": {
"$ref": "ListTeachersResponse"
},
"parameterOrder": [
"courseId"
],
"httpMethod": "GET"
},
"get": {
"response": {
"$ref": "Teacher"
},
"parameterOrder": [
"courseId",
"userId"
],
"httpMethod": "GET",
"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"
],
"parameters": {
"courseId": {
"type": "string",
"required": true,
"location": "path",
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
},
"userId": {
"type": "string",
"required": true,
"location": "path",
"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"
}
},
"flatPath": "v1/courses/{courseId}/teachers/{userId}",
"id": "classroom.courses.teachers.get",
"path": "v1/courses/{courseId}/teachers/{userId}",
"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."
},
"create": {
"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.",
"request": {
"$ref": "Teacher"
},
"response": {
"$ref": "Teacher"
},
"parameterOrder": [
"courseId"
],
"httpMethod": "POST",
"parameters": {
"courseId": {
"location": "path",
"description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/classroom.profile.emails",
"https://www.googleapis.com/auth/classroom.profile.photos",
"https://www.googleapis.com/auth/classroom.rosters"
],
"flatPath": "v1/courses/{courseId}/teachers",
"id": "classroom.courses.teachers.create",
"path": "v1/courses/{courseId}/teachers"
}
}
},
"aliases": {
"methods": {
"delete": {
"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).",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"courseId",
"alias"
],
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/classroom.courses"
],
"parameters": {
"alias": {
"description": "Alias to delete.\nThis may not be the Classroom-assigned identifier.",
"type": "string",
"required": true,
"location": "path"
},
"courseId": {
"description": "Identifier of the course whose alias should be deleted.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true,
"location": "path"
}
},
"flatPath": "v1/courses/{courseId}/aliases/{alias}",
"id": "classroom.courses.aliases.delete",
"path": "v1/courses/{courseId}/aliases/{alias}"
},
"list": {
"id": "classroom.courses.aliases.list",
"path": "v1/courses/{courseId}/aliases",
"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.",
"response": {
"$ref": "ListCourseAliasesResponse"
},
"parameterOrder": [
"courseId"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/classroom.courses",
"https://www.googleapis.com/auth/classroom.courses.readonly"
],
"parameters": {
"pageToken": {
"location": "query",
"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.",
"type": "string"
},
"pageSize": {
"format": "int32",
"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.",
"type": "integer",
"location": "query"
},
"courseId": {
"type": "string",
"required": true,
"location": "path",
"description": "The identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias."
}
},
"flatPath": "v1/courses/{courseId}/aliases"
},
"create": {
"flatPath": "v1/courses/{courseId}/aliases",
"path": "v1/courses/{courseId}/aliases",
"id": "classroom.courses.aliases.create",
"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).",
"request": {
"$ref": "CourseAlias"
},
"httpMethod": "POST",
"parameterOrder": [
"courseId"
],
"response": {
"$ref": "CourseAlias"
},
"parameters": {
"courseId": {
"location": "path",
"description": "Identifier of the course to alias.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/classroom.courses"
]
}
}
}
}
}
},
"parameters": {
"access_token": {
"description": "OAuth access token.",
"type": "string",
"location": "query"
},
"key": {
"location": "query",
"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.",
"type": "string"
},
"quotaUser": {
"location": "query",
"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.",
"type": "string"
},
"pp": {
"description": "Pretty-print response.",
"default": "true",
"type": "boolean",
"location": "query"
},
"bearer_token": {
"type": "string",
"location": "query",
"description": "OAuth bearer token."
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
"prettyPrint": {
"location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
"type": "boolean"
},
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
"$.xgafv": {
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"enum": [
"1",
"2"
]
},
"callback": {
"description": "JSONP",
"type": "string",
"location": "query"
},
"alt": {
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"description": "Data format for response.",
"default": "json",
"enum": [
"json",
"media",
"proto"
],
"type": "string"
}
},
"schemas": {
"Date": {
"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`.",
"type": "object",
"properties": {
"day": {
"format": "int32",
"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.",
"type": "integer"
},
"year": {
"format": "int32",
"description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
"type": "integer"
},
"month": {
"format": "int32",
"description": "Month of year. Must be from 1 to 12.",
"type": "integer"
}
},
"id": "Date"
},
"MultipleChoiceSubmission": {
"id": "MultipleChoiceSubmission",
"description": "Student work for a multiple-choice question.",
"type": "object",
"properties": {
"answer": {
"description": "Student's select choice.",
"type": "string"
}
}
},
"CourseMaterial": {
"description": "A material attached to a course as part of a material set.",
"type": "object",
"properties": {
"form": {
"$ref": "Form",
"description": "Google Forms attachment."
},
"link": {
"$ref": "Link",
"description": "Link atatchment."
},
"youTubeVideo": {
"$ref": "YouTubeVideo",
"description": "Youtube video attachment."
},
"driveFile": {
"$ref": "DriveFile",
"description": "Google Drive file attachment."
}
},
"id": "CourseMaterial"
},
"Name": {
"type": "object",
"properties": {
"familyName": {
"description": "The user's last name.\n\nRead-only.",
"type": "string"
},
"givenName": {
"description": "The user's first name.\n\nRead-only.",
"type": "string"
},
"fullName": {
"description": "The user's full name formed by concatenating the first and last name\nvalues.\n\nRead-only.",
"type": "string"
}
},
"id": "Name",
"description": "Details of the user's name."
},
"Assignment": {
"type": "object",
"properties": {
"studentWorkFolder": {
"$ref": "DriveFolder",
"description": "Drive folder where attachments from student submissions are placed.\nThis is only populated for course teachers."
}
},
"id": "Assignment",
"description": "Additional details for assignments."
},
"SharedDriveFile": {
"description": "Drive file that is used as material for course work.",
"type": "object",
"properties": {
"shareMode": {
"type": "string",
"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."
],
"enum": [
"UNKNOWN_SHARE_MODE",
"VIEW",
"EDIT",
"STUDENT_COPY"
],
"description": "Mechanism by which students access the Drive item."
},
"driveFile": {
"$ref": "DriveFile",
"description": "Drive file details."
}
},
"id": "SharedDriveFile"
},
"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 `{}`.",
"type": "object",
"properties": {},
"id": "Empty"
},
"MultipleChoiceQuestion": {
"description": "Additional details for multiple-choice questions.",
"type": "object",
"properties": {
"choices": {
"description": "Possible choices.",
"items": {
"type": "string"
},
"type": "array"
}
},
"id": "MultipleChoiceQuestion"
},
"Course": {
"id": "Course",
"description": "A Course in Classroom.",
"type": "object",
"properties": {
"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"
},
"id": {
"type": "string",
"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."
},
"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"
},
"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"
},
"courseMaterialSets": {
"description": "Sets of materials that appear on the \"about\" page of this course.\n\nRead-only.",
"items": {
"$ref": "CourseMaterialSet"
},
"type": "array"
},
"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"
},
"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"
},
"updateTime": {
"format": "google-datetime",
"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.",
"type": "string"
},
"calendarId": {
"description": "The Calendar ID for a calendar that all course members can see, to which\nClassroom adds events for course work and announcements in the course.\n\nRead-only.",
"type": "string"
},
"alternateLink": {
"type": "string",
"description": "Absolute link to this course in the Classroom web UI.\n\nRead-only."
},
"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"
},
"courseState": {
"enum": [
"COURSE_STATE_UNSPECIFIED",
"ACTIVE",
"ARCHIVED",
"PROVISIONED",
"DECLINED",
"SUSPENDED"
],
"description": "State of the course.\nIf unspecified, the default state is `PROVISIONED`.",
"type": "string",
"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."
]
},
"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"
},
"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"
},
"creationTime": {
"format": "google-datetime",
"description": "Creation time of the course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.",
"type": "string"
},
"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"
},
"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."
}
}
},
"DriveFile": {
"type": "object",
"properties": {
"id": {
"description": "Drive API resource ID.",
"type": "string"
},
"title": {
"description": "Title of the Drive item.\n\nRead-only.",
"type": "string"
},
"alternateLink": {
"description": "URL that can be used to access the Drive item.\n\nRead-only.",
"type": "string"
},
"thumbnailUrl": {
"type": "string",
"description": "URL of a thumbnail image of the Drive item.\n\nRead-only."
}
},
"id": "DriveFile",
"description": "Representation of a Google Drive file."
},
"GlobalPermission": {
"description": "Global user permission description.",
"type": "object",
"properties": {
"permission": {
"enum": [
"PERMISSION_UNSPECIFIED",
"CREATE_COURSE"
],
"description": "Permission value.",
"type": "string",
"enumDescriptions": [
"No permission is specified. This is not returned and is not a\nvalid value.",
"User is permitted to create a course."
]
}
},
"id": "GlobalPermission"
},
"ReturnStudentSubmissionRequest": {
"description": "Request to return a student submission.",
"type": "object",
"properties": {},
"id": "ReturnStudentSubmissionRequest"
},
"Teacher": {
"type": "object",
"properties": {
"profile": {
"$ref": "UserProfile",
"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"
},
"courseId": {
"type": "string",
"description": "Identifier of the course.\n\nRead-only."
}
},
"id": "Teacher",
"description": "Teacher of a course."
},
"ReclaimStudentSubmissionRequest": {
"id": "ReclaimStudentSubmissionRequest",
"description": "Request to reclaim a student submission.",
"type": "object",
"properties": {}
},
"AssignmentSubmission": {
"description": "Student work for an assignment.",
"type": "object",
"properties": {
"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"
}
},
"id": "AssignmentSubmission"
},
"Material": {
"properties": {
"form": {
"$ref": "Form",
"description": "Google Forms material."
},
"link": {
"description": "Link material. On creation, will be upgraded to a more appropriate type\nif possible, and this will be reflected in the response.",
"$ref": "Link"
},
"youtubeVideo": {
"$ref": "YouTubeVideo",
"description": "YouTube video material."
},
"driveFile": {
"description": "Google Drive file material.",
"$ref": "SharedDriveFile"
}
},
"id": "Material",
"description": "Material attached to course work.\n\nWhen creating attachments, setting the `form` field is not supported.",
"type": "object"
},
"CourseWork": {
"id": "CourseWork",
"description": "Course work created by a teacher for students of the course.",
"type": "object",
"properties": {
"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"
},
"materials": {
"description": "Additional materials.\n\nCourseWork must have no more than 20 material items.",
"items": {
"$ref": "Material"
},
"type": "array"
},
"updateTime": {
"format": "google-datetime",
"description": "Timestamp of the most recent change to this course work.\n\nRead-only.",
"type": "string"
},
"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"
},
"maxPoints": {
"format": "double",
"description": "Maximum grade for this course work.\nIf zero or unspecified, this assignment is considered ungraded.\nThis must be a non-negative integer value.",
"type": "number"
},
"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.",
"$ref": "MultipleChoiceQuestion"
},
"assignment": {
"$ref": "Assignment",
"description": "Assignment details.\nThis is populated only when `work_type` is `ASSIGNMENT`.\n\nRead-only."
},
"workType": {
"enumDescriptions": [
"No work type specified. This is never returned.",
"An assignment.",
"A short answer question.",
"A multiple-choice question."
],
"enum": [
"COURSE_WORK_TYPE_UNSPECIFIED",
"ASSIGNMENT",
"SHORT_ANSWER_QUESTION",
"MULTIPLE_CHOICE_QUESTION"
],
"description": "Type of this course work.\n\nThe type is set when the course work is created and cannot be changed.",
"type": "string"
},
"scheduledTime": {
"format": "google-datetime",
"description": "Optional timestamp when this course work is scheduled to be published.",
"type": "string"
},
"description": {
"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"
},
"creationTime": {
"format": "google-datetime",
"description": "Timestamp when this course work was created.\n\nRead-only.",
"type": "string"
},
"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."
},
"submissionModificationMode": {
"description": "Setting to determine when students are allowed to modify submissions.\nIf unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.",
"type": "string",
"enumDescriptions": [
"No modification mode specified. This is never returned.",
"Submisisons can be modified before being turned in.",
"Submisisons can be modified at any time."
],
"enum": [
"SUBMISSION_MODIFICATION_MODE_UNSPECIFIED",
"MODIFIABLE_UNTIL_TURNED_IN",
"MODIFIABLE"
]
},
"state": {
"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."
],
"enum": [
"COURSE_WORK_STATE_UNSPECIFIED",
"PUBLISHED",
"DRAFT",
"DELETED"
],
"description": "Status of this course work.\nIf unspecified, the default state is `DRAFT`.",
"type": "string"
},
"courseId": {
"type": "string",
"description": "Identifier of the course.\n\nRead-only."
},
"id": {
"description": "Classroom-assigned identifier of this course work, unique per course.\n\nRead-only.",
"type": "string"
},
"dueTime": {
"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.",
"$ref": "TimeOfDay"
},
"title": {
"type": "string",
"description": "Title of this course work.\nThe title must be a valid UTF-8 string containing between 1 and 3000\ncharacters."
}
}
},
"Guardian": {
"type": "object",
"properties": {
"studentId": {
"description": "Identifier for the student to whom the guardian relationship applies.",
"type": "string"
},
"invitedEmailAddress": {
"description": "The email address to which the initial guardian invitation was sent.\nThis field is only visible to domain administrators.",
"type": "string"
},
"guardianId": {
"description": "Identifier for the guardian.",
"type": "string"
},
"guardianProfile": {
"$ref": "UserProfile",
"description": "User profile for the guardian."
}
},
"id": "Guardian",
"description": "Association between a student and a guardian of that student. The guardian\nmay receive information about the student's course work."
},
"ListStudentsResponse": {
"description": "Response when listing students.",
"type": "object",
"properties": {
"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": "Student"
},
"type": "array"
}
},
"id": "ListStudentsResponse"
},
"UserProfile": {
"description": "Global information for a user.",
"type": "object",
"properties": {
"emailAddress": {
"description": "Email address of the user.\n\nRead-only.",
"type": "string"
},
"photoUrl": {
"description": "URL of user's profile photo.\n\nRead-only.",
"type": "string"
},
"permissions": {
"description": "Global permissions of the user.\n\nRead-only.",
"items": {
"$ref": "GlobalPermission"
},
"type": "array"
},
"name": {
"description": "Name of the user.\n\nRead-only.",
"$ref": "Name"
},
"id": {
"description": "Identifier of the user.\n\nRead-only.",
"type": "string"
},
"verifiedTeacher": {
"description": "Represents whether a G Suite for Education user's domain administrator has\nexplicitly verified them as being a teacher. If the user is not a member of\na G Suite for Education domain, than this field will always be false.\n\nRead-only",
"type": "boolean"
}
},
"id": "UserProfile"
},
"Student": {
"description": "Student in a course.",
"type": "object",
"properties": {
"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"
},
"courseId": {
"description": "Identifier of the course.\n\nRead-only.",
"type": "string"
},
"studentWorkFolder": {
"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.",
"$ref": "DriveFolder"
},
"profile": {
"$ref": "UserProfile",
"description": "Global user information for the student.\n\nRead-only."
}
},
"id": "Student"
},
"Invitation": {
"properties": {
"courseId": {
"description": "Identifier of the course to invite the user to.",
"type": "string"
},
"id": {
"type": "string",
"description": "Identifier assigned by Classroom.\n\nRead-only."
},
"role": {
"enum": [
"COURSE_ROLE_UNSPECIFIED",
"STUDENT",
"TEACHER"
],
"description": "Role to invite the user to have.\nMust not be `COURSE_ROLE_UNSPECIFIED`.",
"type": "string",
"enumDescriptions": [
"No course role.",
"Student in the course.",
"Teacher of the course."
]
},
"userId": {
"type": "string",
"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"
}
},
"id": "Invitation",
"description": "An invitation to join a course.",
"type": "object"
},
"DriveFolder": {
"id": "DriveFolder",
"description": "Representation of a Google Drive folder.",
"type": "object",
"properties": {
"title": {
"description": "Title of the Drive folder.\n\nRead-only.",
"type": "string"
},
"alternateLink": {
"description": "URL that can be used to access the Drive folder.\n\nRead-only.",
"type": "string"
},
"id": {
"description": "Drive API resource ID.",
"type": "string"
}
}
},
"ShortAnswerSubmission": {
"description": "Student work for a short answer question.",
"type": "object",
"properties": {
"answer": {
"description": "Student response to a short-answer question.",
"type": "string"
}
},
"id": "ShortAnswerSubmission"
},
"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.",
"type": "object",
"properties": {
"state": {
"enum": [
"SUBMISSION_STATE_UNSPECIFIED",
"NEW",
"CREATED",
"TURNED_IN",
"RETURNED",
"RECLAIMED_BY_STUDENT"
],
"description": "State of this submission.\n\nRead-only.",
"type": "string",
"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."
]
},
"userId": {
"description": "Identifier for the student that owns this submission.\n\nRead-only.",
"type": "string"
},
"courseWorkId": {
"description": "Identifier for the course work this corresponds to.\n\nRead-only.",
"type": "string"
},
"courseId": {
"description": "Identifier of the course.\n\nRead-only.",
"type": "string"
},
"id": {
"description": "Classroom-assigned Identifier for the student submission.\nThis is unique among submissions for the relevant course work.\n\nRead-only.",
"type": "string"
},
"assignedGrade": {
"format": "double",
"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.",
"type": "number"
},
"multipleChoiceSubmission": {
"$ref": "MultipleChoiceSubmission",
"description": "Submission content when course_work_type is MULTIPLE_CHOICE_QUESTION."
},
"assignmentSubmission": {
"description": "Submission content when course_work_type is ASSIGNMENT .",
"$ref": "AssignmentSubmission"
},
"shortAnswerSubmission": {
"$ref": "ShortAnswerSubmission",
"description": "Submission content when course_work_type is SHORT_ANSWER_QUESTION."
},
"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": {
"format": "google-datetime",
"description": "Last update time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.",
"type": "string"
},
"alternateLink": {
"description": "Absolute link to the submission in the Classroom web UI.\n\nRead-only.",
"type": "string"
},
"late": {
"description": "Whether this submission is late.\n\nRead-only.",
"type": "boolean"
},
"draftGrade": {
"format": "double",
"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.",
"type": "number"
},
"courseWorkType": {
"enumDescriptions": [
"No work type specified. This is never returned.",
"An assignment.",
"A short answer question.",
"A multiple-choice question."
],
"enum": [
"COURSE_WORK_TYPE_UNSPECIFIED",
"ASSIGNMENT",
"SHORT_ANSWER_QUESTION",
"MULTIPLE_CHOICE_QUESTION"
],
"description": "Type of course work this submission is for.\n\nRead-only.",
"type": "string"
},
"creationTime": {
"format": "google-datetime",
"description": "Creation time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.",
"type": "string"
}
},
"id": "StudentSubmission"
},
"TurnInStudentSubmissionRequest": {
"description": "Request to turn in a student submission.",
"type": "object",
"properties": {},
"id": "TurnInStudentSubmissionRequest"
},
"ListStudentSubmissionsResponse": {
"id": "ListStudentSubmissionsResponse",
"description": "Response when listing student submissions.",
"type": "object",
"properties": {
"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": "StudentSubmission"
},
"type": "array"
}
}
},
"ListCourseWorkResponse": {
"id": "ListCourseWorkResponse",
"description": "Response when listing course work.",
"type": "object",
"properties": {
"nextPageToken": {
"type": "string",
"description": "Token identifying the next page of results to return. If empty, no further\nresults are available."
},
"courseWork": {
"description": "Course work items that match the request.",
"items": {
"$ref": "CourseWork"
},
"type": "array"
}
}
},
"ModifyAttachmentsRequest": {
"description": "Request to modify the attachments of a student submission.",
"type": "object",
"properties": {
"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"
}
},
"id": "ModifyAttachmentsRequest"
},
"YouTubeVideo": {
"description": "YouTube video item.",
"type": "object",
"properties": {
"thumbnailUrl": {
"type": "string",
"description": "URL of a thumbnail image of the YouTube video.\n\nRead-only."
},
"id": {
"description": "YouTube API resource ID.",
"type": "string"
},
"title": {
"description": "Title of the YouTube video.\n\nRead-only.",
"type": "string"
},
"alternateLink": {
"description": "URL that can be used to view the YouTube video.\n\nRead-only.",
"type": "string"
}
},
"id": "YouTubeVideo"
},
"ListInvitationsResponse": {
"type": "object",
"properties": {
"nextPageToken": {
"description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
"type": "string"
},
"invitations": {
"description": "Invitations that match the list request.",
"items": {
"$ref": "Invitation"
},
"type": "array"
}
},
"id": "ListInvitationsResponse",
"description": "Response when listing invitations."
},
"GuardianInvitation": {
"description": "An invitation to become the guardian of a specified user, sent to a specified\nemail address.",
"type": "object",
"properties": {
"creationTime": {
"format": "google-datetime",
"description": "The time that this invitation was created.\n\nRead-only.",
"type": "string"
},
"invitationId": {
"description": "Unique identifier for this invitation.\n\nRead-only.",
"type": "string"
},
"state": {
"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."
],
"enum": [
"GUARDIAN_INVITATION_STATE_UNSPECIFIED",
"PENDING",
"COMPLETE"
],
"description": "The state that this invitation is in.",
"type": "string"
},
"studentId": {
"description": "ID of the student (in standard format)",
"type": "string"
},
"invitedEmailAddress": {
"description": "Email address that the invitation was sent to.\nThis field is only visible to domain administrators.",
"type": "string"
}
},
"id": "GuardianInvitation"
},
"Attachment": {
"description": "Attachment added to student assignment work.\n\nWhen creating attachments, setting the `form` field is not supported.",
"type": "object",
"properties": {
"link": {
"description": "Link attachment.",
"$ref": "Link"
},
"youTubeVideo": {
"$ref": "YouTubeVideo",
"description": "Youtube video attachment."
},
"driveFile": {
"description": "Google Drive file attachment.",
"$ref": "DriveFile"
},
"form": {
"$ref": "Form",
"description": "Google Forms attachment."
}
},
"id": "Attachment"
},
"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.",
"type": "object",
"properties": {
"materials": {
"description": "Materials attached to this set.",
"items": {
"$ref": "CourseMaterial"
},
"type": "array"
},
"title": {
"description": "Title for this set.",
"type": "string"
}
},
"id": "CourseMaterialSet"
},
"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`.",
"type": "object",
"properties": {
"hours": {
"format": "int32",
"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.",
"type": "integer"
},
"nanos": {
"format": "int32",
"description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
"type": "integer"
},
"seconds": {
"format": "int32",
"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.",
"type": "integer"
},
"minutes": {
"format": "int32",
"description": "Minutes of hour of day. Must be from 0 to 59.",
"type": "integer"
}
},
"id": "TimeOfDay"
},
"ListCoursesResponse": {
"description": "Response when listing courses.",
"type": "object",
"properties": {
"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": "Course"
},
"type": "array"
}
},
"id": "ListCoursesResponse"
},
"Form": {
"description": "Google Forms item.",
"type": "object",
"properties": {
"title": {
"description": "Title of the Form.\n\nRead-only.",
"type": "string"
},
"thumbnailUrl": {
"description": "URL of a thumbnail image of the Form.\n\nRead-only.",
"type": "string"
},
"responseUrl": {
"type": "string",
"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."
},
"formUrl": {
"description": "URL of the form.",
"type": "string"
}
},
"id": "Form"
},
"ListTeachersResponse": {
"description": "Response when listing teachers.",
"type": "object",
"properties": {
"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": "Teacher"
},
"type": "array"
}
},
"id": "ListTeachersResponse"
},
"Link": {
"description": "URL item.",
"type": "object",
"properties": {
"url": {
"description": "URL to link to.\nThis must be a valid UTF-8 string containing between 1 and 2024 characters.",
"type": "string"
},
"title": {
"type": "string",
"description": "Title of the target of the URL.\n\nRead-only."
},
"thumbnailUrl": {
"type": "string",
"description": "URL of a thumbnail image of the target URL.\n\nRead-only."
}
},
"id": "Link"
},
"ListGuardiansResponse": {
"type": "object",
"properties": {
"nextPageToken": {
"description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
"type": "string"
},
"guardians": {
"description": "Guardians on this page of results that met the criteria specified in\nthe request.",
"items": {
"$ref": "Guardian"
},
"type": "array"
}
},
"id": "ListGuardiansResponse",
"description": "Response when listing guardians."
},
"ListGuardianInvitationsResponse": {
"description": "Response when listing guardian invitations.",
"type": "object",
"properties": {
"nextPageToken": {
"description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
"type": "string"
},
"guardianInvitations": {
"description": "Guardian invitations that matched the list request.",
"items": {
"$ref": "GuardianInvitation"
},
"type": "array"
}
},
"id": "ListGuardianInvitationsResponse"
},
"ListCourseAliasesResponse": {
"id": "ListCourseAliasesResponse",
"description": "Response when listing course aliases.",
"type": "object",
"properties": {
"aliases": {
"description": "The course aliases.",
"items": {
"$ref": "CourseAlias"
},
"type": "array"
},
"nextPageToken": {
"description": "Token identifying the next page of results to return. If empty, no further\nresults are available.",
"type": "string"
}
}
},
"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.",
"type": "object",
"properties": {
"alias": {
"description": "Alias string. The format of the string indicates the desired alias scoping.\n\n* `d:\u003cname\u003e` indicates a domain-scoped alias.\n Example: `d:math_101`\n* `p:\u003cname\u003e` indicates a project-scoped alias.\n Example: `p:abc123`\n\nThis field has a maximum length of 256 characters.",
"type": "string"
}
},
"id": "CourseAlias"
}
},
"protocol": "rest",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"version": "v1",
"baseUrl": "https://classroom.googleapis.com/",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/classroom.rosters": {
"description": "Manage your Google Classroom class rosters"
},
"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.guardianlinks.students.readonly": {
"description": "View guardians for students in your Google Classroom classes"
},
"https://www.googleapis.com/auth/classroom.courses": {
"description": "Manage your Google Classroom classes"
},
"https://www.googleapis.com/auth/classroom.courses.readonly": {
"description": "View your Google Classroom 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.readonly": {
"description": "View your Google Classroom class rosters"
},
"https://www.googleapis.com/auth/classroom.guardianlinks.students": {
"description": "View and manage guardians for students in 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.guardianlinks.me.readonly": {
"description": "View your Google Classroom guardians"
},
"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.coursework.me.readonly": {
"description": "View your course work and grades in Google Classroom"
},
"https://www.googleapis.com/auth/classroom.profile.emails": {
"description": "View the email addresses of people in your classes"
},
"https://www.googleapis.com/auth/classroom.coursework.me": {
"description": "Manage your course work and view your grades in Google Classroom"
}
}
}
},
"servicePath": "",
"description": "Manages classes, rosters, and invitations in Google Classroom.",
"kind": "discovery#restDescription",
"rootUrl": "https://classroom.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "classroom",
"batchPath": "batch"
}
Reference in a new issue View git blame Copy permalink