Google Classroom API: courses. Manages classes, rosters, and invitations in Google Classroom. See: https://developers.google.com/classroom/api/reference/rest/v1/courses
Google Classroom API: courses. Manages classes, rosters, and invitations in Google Classroom. See: https://developers.google.com/classroom/api/reference/rest/v1/courses
(aliases-create$ auth parameters body)
https://developers.google.com/classroom/api/reference/rest/v1/courses/aliases/create
Required parameters: courseId
Optional parameters: none
Body:
{:alias string}
Creates an alias for a course. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to create the alias or for access errors. * NOT_FOUND
if the course does not exist. * ALREADY_EXISTS
if the alias already exists. * FAILED_PRECONDITION
if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias).
https://developers.google.com/classroom/api/reference/rest/v1/courses/aliases/create Required parameters: courseId Optional parameters: none Body: {:alias string} Creates an alias for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. * `NOT_FOUND` if the course does not exist. * `ALREADY_EXISTS` if the alias already exists. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias).
(aliases-delete$ auth parameters)
https://developers.google.com/classroom/api/reference/rest/v1/courses/aliases/delete
Required parameters: courseId, alias
Optional parameters: none
Deletes an alias of a course. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to remove the alias or for access errors. * NOT_FOUND
if the alias does not exist. * FAILED_PRECONDITION
if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to delete a domain-scoped alias).
https://developers.google.com/classroom/api/reference/rest/v1/courses/aliases/delete Required parameters: courseId, alias Optional parameters: none Deletes an alias of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. * `NOT_FOUND` if the alias does not exist. * `FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to delete a domain-scoped alias).
(aliases-list$ auth parameters)
https://developers.google.com/classroom/api/reference/rest/v1/courses/aliases/list
Required parameters: courseId
Optional parameters: pageToken, pageSize
Returns a list of aliases for a course. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to access the course or for access errors. * NOT_FOUND
if the course does not exist.
https://developers.google.com/classroom/api/reference/rest/v1/courses/aliases/list Required parameters: courseId Optional parameters: pageToken, pageSize Returns a list of aliases for a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. * `NOT_FOUND` if the course does not exist.
(announcements-create$ auth parameters body)
https://developers.google.com/classroom/api/reference/rest/v1/courses/announcements/create
Required parameters: courseId
Optional parameters: none
Body:
{:creationTime string, :individualStudentsOptions {:studentIds [string]}, :creatorUserId string, :assigneeMode string, :scheduledTime string, :state string, :updateTime string, :id string, :alternateLink string, :materials [{:youtubeVideo YouTubeVideo, :link Link, :driveFile SharedDriveFile, :form Form}], :courseId string, :text string}
Creates an announcement. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to access the requested course, create announcements in the requested course, share a Drive attachment, or for access errors. * INVALID_ARGUMENT
if the request is malformed. * NOT_FOUND
if the requested course does not exist. * FAILED_PRECONDITION
for the following request error: * AttachmentNotVisible
https://developers.google.com/classroom/api/reference/rest/v1/courses/announcements/create Required parameters: courseId Optional parameters: none Body: {:creationTime string, :individualStudentsOptions {:studentIds [string]}, :creatorUserId string, :assigneeMode string, :scheduledTime string, :state string, :updateTime string, :id string, :alternateLink string, :materials [{:youtubeVideo YouTubeVideo, :link Link, :driveFile SharedDriveFile, :form Form}], :courseId string, :text string} Creates an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create announcements in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible
(announcements-delete$ auth parameters)
https://developers.google.com/classroom/api/reference/rest/v1/courses/announcements/delete
Required parameters: courseId, id
Optional parameters: none
Deletes an announcement. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding announcement item. This method returns the following error codes: * PERMISSION_DENIED
if the requesting developer project did not create the corresponding announcement, if the requesting user is not permitted to delete the requested course or for access errors. * FAILED_PRECONDITION
if the requested announcement has already been deleted. * NOT_FOUND
if no course exists with the requested ID.
https://developers.google.com/classroom/api/reference/rest/v1/courses/announcements/delete Required parameters: courseId, id Optional parameters: none Deletes an announcement. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding announcement item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.
(announcements-get$ auth parameters)
https://developers.google.com/classroom/api/reference/rest/v1/courses/announcements/get
Required parameters: id, courseId
Optional parameters: none
Returns an announcement. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to access the requested course or announcement, or for access errors. * INVALID_ARGUMENT
if the request is malformed. * NOT_FOUND
if the requested course or announcement does not exist.
https://developers.google.com/classroom/api/reference/rest/v1/courses/announcements/get Required parameters: id, courseId Optional parameters: none Returns an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or announcement, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or announcement does not exist.
(announcements-list$ auth parameters)
https://developers.google.com/classroom/api/reference/rest/v1/courses/announcements/list
Required parameters: courseId
Optional parameters: announcementStates, orderBy, pageSize, pageToken
Returns a list of announcements that the requester is permitted to view. Course students may only view PUBLISHED
announcements. Course teachers and domain administrators may view all announcements. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to access the requested course or for access errors. * INVALID_ARGUMENT
if the request is malformed. * NOT_FOUND
if the requested course does not exist.
https://developers.google.com/classroom/api/reference/rest/v1/courses/announcements/list Required parameters: courseId Optional parameters: announcementStates, orderBy, pageSize, pageToken Returns a list of announcements that the requester is permitted to view. Course students may only view `PUBLISHED` announcements. Course teachers and domain administrators may view all announcements. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
(announcements-modifyAssignees$ auth parameters body)
https://developers.google.com/classroom/api/reference/rest/v1/courses/announcements/modifyAssignees
Required parameters: id, courseId
Optional parameters: none
Body:
{:modifyIndividualStudentsOptions {:addStudentIds [string], :removeStudentIds [string]}, :assigneeMode string}
Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to access the requested course or course work or for access errors. * INVALID_ARGUMENT
if the request is malformed. * NOT_FOUND
if the requested course or course work does not exist.
https://developers.google.com/classroom/api/reference/rest/v1/courses/announcements/modifyAssignees Required parameters: id, courseId Optional parameters: none Body: {:modifyIndividualStudentsOptions {:addStudentIds [string], :removeStudentIds [string]}, :assigneeMode string} Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.
(announcements-patch$ auth parameters body)
https://developers.google.com/classroom/api/reference/rest/v1/courses/announcements/patch
Required parameters: id, courseId
Optional parameters: updateMask
Body:
{:creationTime string, :individualStudentsOptions {:studentIds [string]}, :creatorUserId string, :assigneeMode string, :scheduledTime string, :state string, :updateTime string, :id string, :alternateLink string, :materials [{:youtubeVideo YouTubeVideo, :link Link, :driveFile SharedDriveFile, :form Form}], :courseId string, :text string}
Updates one or more fields of an announcement. This method returns the following error codes: * PERMISSION_DENIED
if the requesting developer project did not create the corresponding announcement or for access errors. * INVALID_ARGUMENT
if the request is malformed. * FAILED_PRECONDITION
if the requested announcement has already been deleted. * NOT_FOUND
if the requested course or announcement does not exist
https://developers.google.com/classroom/api/reference/rest/v1/courses/announcements/patch Required parameters: id, courseId Optional parameters: updateMask Body: {:creationTime string, :individualStudentsOptions {:studentIds [string]}, :creatorUserId string, :assigneeMode string, :scheduledTime string, :state string, :updateTime string, :id string, :alternateLink string, :materials [{:youtubeVideo YouTubeVideo, :link Link, :driveFile SharedDriveFile, :form Form}], :courseId string, :text string} Updates one or more fields of an announcement. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested announcement has already been deleted. * `NOT_FOUND` if the requested course or announcement does not exist
(courseWork-create$ auth parameters body)
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWork/create
Required parameters: courseId
Optional parameters: none
Body:
{:creationTime string, :description string, :individualStudentsOptions {:studentIds [string]}, :multipleChoiceQuestion {:choices [string]}, :submissionModificationMode string, :creatorUserId string, :assigneeMode string, :dueTime {:nanos integer, :minutes integer, :hours integer, :seconds integer}, :topicId string, :scheduledTime string, :state string, :title string, :updateTime string, :id string, :dueDate {:day integer, :year integer, :month integer}, :alternateLink string, :materials [{:youtubeVideo YouTubeVideo, :link Link, :driveFile SharedDriveFile, :form Form}], :assignment {:studentWorkFolder DriveFolder}, :maxPoints number, :associatedWithDeveloper boolean, :courseId string, :workType string}
Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the OAuth client ID used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to access the requested course, create course work in the requested course, share a Drive attachment, or for access errors. * INVALID_ARGUMENT
if the request is malformed. * NOT_FOUND
if the requested course does not exist. * FAILED_PRECONDITION
for the following request error: * AttachmentNotVisible
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWork/create Required parameters: courseId Optional parameters: none Body: {:creationTime string, :description string, :individualStudentsOptions {:studentIds [string]}, :multipleChoiceQuestion {:choices [string]}, :submissionModificationMode string, :creatorUserId string, :assigneeMode string, :dueTime {:nanos integer, :minutes integer, :hours integer, :seconds integer}, :topicId string, :scheduledTime string, :state string, :title string, :updateTime string, :id string, :dueDate {:day integer, :year integer, :month integer}, :alternateLink string, :materials [{:youtubeVideo YouTubeVideo, :link Link, :driveFile SharedDriveFile, :form Form}], :assignment {:studentWorkFolder DriveFolder}, :maxPoints number, :associatedWithDeveloper boolean, :courseId string, :workType string} Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible
(courseWork-delete$ auth parameters)
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWork/delete
Required parameters: courseId, id
Optional parameters: none
Deletes a course work. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item. This method returns the following error codes: * PERMISSION_DENIED
if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * FAILED_PRECONDITION
if the requested course work has already been deleted. * NOT_FOUND
if no course exists with the requested ID.
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWork/delete Required parameters: courseId, id Optional parameters: none Deletes a course work. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.
(courseWork-get$ auth parameters)
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWork/get
Required parameters: courseId, id
Optional parameters: none
Returns course work. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to access the requested course or course work, or for access errors. * INVALID_ARGUMENT
if the request is malformed. * NOT_FOUND
if the requested course or course work does not exist.
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWork/get Required parameters: courseId, id Optional parameters: none Returns course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.
(courseWork-list$ auth parameters)
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWork/list
Required parameters: courseId
Optional parameters: pageSize, orderBy, courseWorkStates, pageToken
Returns a list of course work that the requester is permitted to view. Course students may only view PUBLISHED
course work. Course teachers and domain administrators may view all course work. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to access the requested course or for access errors. * INVALID_ARGUMENT
if the request is malformed. * NOT_FOUND
if the requested course does not exist.
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWork/list Required parameters: courseId Optional parameters: pageSize, orderBy, courseWorkStates, pageToken Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
(courseWork-modifyAssignees$ auth parameters body)
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWork/modifyAssignees
Required parameters: id, courseId
Optional parameters: none
Body:
{:assigneeMode string, :modifyIndividualStudentsOptions {:addStudentIds [string], :removeStudentIds [string]}}
Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to access the requested course or course work or for access errors. * INVALID_ARGUMENT
if the request is malformed. * NOT_FOUND
if the requested course or course work does not exist.
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWork/modifyAssignees Required parameters: id, courseId Optional parameters: none Body: {:assigneeMode string, :modifyIndividualStudentsOptions {:addStudentIds [string], :removeStudentIds [string]}} Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.
(courseWork-patch$ auth parameters body)
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWork/patch
Required parameters: courseId, id
Optional parameters: updateMask
Body:
{:creationTime string, :description string, :individualStudentsOptions {:studentIds [string]}, :multipleChoiceQuestion {:choices [string]}, :submissionModificationMode string, :creatorUserId string, :assigneeMode string, :dueTime {:nanos integer, :minutes integer, :hours integer, :seconds integer}, :topicId string, :scheduledTime string, :state string, :title string, :updateTime string, :id string, :dueDate {:day integer, :year integer, :month integer}, :alternateLink string, :materials [{:youtubeVideo YouTubeVideo, :link Link, :driveFile SharedDriveFile, :form Form}], :assignment {:studentWorkFolder DriveFolder}, :maxPoints number, :associatedWithDeveloper boolean, :courseId string, :workType string}
Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item. This method returns the following error codes: * PERMISSION_DENIED
if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * INVALID_ARGUMENT
if the request is malformed. * FAILED_PRECONDITION
if the requested course work has already been deleted. * NOT_FOUND
if the requested course, course work, or student submission does not exist.
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWork/patch Required parameters: courseId, id Optional parameters: updateMask Body: {:creationTime string, :description string, :individualStudentsOptions {:studentIds [string]}, :multipleChoiceQuestion {:choices [string]}, :submissionModificationMode string, :creatorUserId string, :assigneeMode string, :dueTime {:nanos integer, :minutes integer, :hours integer, :seconds integer}, :topicId string, :scheduledTime string, :state string, :title string, :updateTime string, :id string, :dueDate {:day integer, :year integer, :month integer}, :alternateLink string, :materials [{:youtubeVideo YouTubeVideo, :link Link, :driveFile SharedDriveFile, :form Form}], :assignment {:studentWorkFolder DriveFolder}, :maxPoints number, :associatedWithDeveloper boolean, :courseId string, :workType string} Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
(courseWork-studentSubmissions-get$ auth parameters)
Required parameters: courseId, courseWorkId, id
Optional parameters: none
Returns a student submission. * PERMISSION_DENIED
if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors. * INVALID_ARGUMENT
if the request is malformed. * NOT_FOUND
if the requested course, course work, or student submission does not exist.
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWork/studentSubmissions/get Required parameters: courseId, courseWorkId, id Optional parameters: none Returns a student submission. * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
(courseWork-studentSubmissions-list$ auth parameters)
Required parameters: courseWorkId, courseId
Optional parameters: userId, late, pageToken, states, pageSize
Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. -
may be specified as the course_work_id
to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to access the requested course or course work, or for access errors. * INVALID_ARGUMENT
if the request is malformed. * NOT_FOUND
if the requested course does not exist.
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWork/studentSubmissions/list Required parameters: courseWorkId, courseId Optional parameters: userId, late, pageToken, states, pageSize Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. `-` may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
(courseWork-studentSubmissions-modifyAttachments$ auth parameters body)
Required parameters: id, courseWorkId, courseId
Optional parameters: none
Body:
{:addAttachments [{:youTubeVideo YouTubeVideo, :form Form, :link Link, :driveFile DriveFile}]}
Modifies attachments of student submission. Attachments may only be added to student submissions belonging to course work objects with a workType
of ASSIGNMENT
. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * INVALID_ARGUMENT
if the request is malformed. * NOT_FOUND
if the requested course, course work, or student submission does not exist.
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWork/studentSubmissions/modifyAttachments Required parameters: id, courseWorkId, courseId Optional parameters: none Body: {:addAttachments [{:youTubeVideo YouTubeVideo, :form Form, :link Link, :driveFile DriveFile}]} Modifies attachments of student submission. Attachments may only be added to student submissions belonging to course work objects with a `workType` of `ASSIGNMENT`. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
(courseWork-studentSubmissions-patch$ auth parameters body)
Required parameters: courseId, id, courseWorkId
Optional parameters: updateMask
Body:
{:creationTime string, :shortAnswerSubmission {:answer string}, :late boolean, :multipleChoiceSubmission {:answer string}, :state string, :updateTime string, :assignmentSubmission {:attachments [Attachment]}, :id string, :assignedGrade number, :submissionHistory [{:stateHistory StateHistory, :gradeHistory GradeHistory}], :alternateLink string, :userId string, :courseWorkType string, :courseWorkId string, :associatedWithDeveloper boolean, :courseId string, :draftGrade number}
Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item. This method returns the following error codes: * PERMISSION_DENIED
if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * INVALID_ARGUMENT
if the request is malformed. * NOT_FOUND
if the requested course, course work, or student submission does not exist.
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWork/studentSubmissions/patch Required parameters: courseId, id, courseWorkId Optional parameters: updateMask Body: {:creationTime string, :shortAnswerSubmission {:answer string}, :late boolean, :multipleChoiceSubmission {:answer string}, :state string, :updateTime string, :assignmentSubmission {:attachments [Attachment]}, :id string, :assignedGrade number, :submissionHistory [{:stateHistory StateHistory, :gradeHistory GradeHistory}], :alternateLink string, :userId string, :courseWorkType string, :courseWorkId string, :associatedWithDeveloper boolean, :courseId string, :draftGrade number} Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
(courseWork-studentSubmissions-reclaim$ auth parameters body)
Required parameters: courseWorkId, courseId, id
Optional parameters: none
Body:
{}
Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and updates the submission state. Only the student that owns the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * FAILED_PRECONDITION
if the student submission has not been turned in. * INVALID_ARGUMENT
if the request is malformed. * NOT_FOUND
if the requested course, course work, or student submission does not exist.
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWork/studentSubmissions/reclaim Required parameters: courseWorkId, courseId, id Optional parameters: none Body: {} Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and updates the submission state. Only the student that owns the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
(courseWork-studentSubmissions-return$ auth parameters body)
Required parameters: courseId, courseWorkId, id
Optional parameters: none
Body:
{}
Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. * INVALID_ARGUMENT
if the request is malformed. * NOT_FOUND
if the requested course, course work, or student submission does not exist.
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWork/studentSubmissions/return Required parameters: courseId, courseWorkId, id Optional parameters: none Body: {} Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
(courseWork-studentSubmissions-turnIn$ auth parameters body)
Required parameters: courseId, courseWorkId, id
Optional parameters: none
Body:
{}
Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work item. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. * INVALID_ARGUMENT
if the request is malformed. * NOT_FOUND
if the requested course, course work, or student submission does not exist.
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWork/studentSubmissions/turnIn Required parameters: courseId, courseWorkId, id Optional parameters: none Body: {} Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.
(courseWorkMaterials-create$ auth parameters body)
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWorkMaterials/create
Required parameters: courseId
Optional parameters: none
Body:
{:creationTime string, :description string, :individualStudentsOptions {:studentIds [string]}, :creatorUserId string, :assigneeMode string, :topicId string, :scheduledTime string, :state string, :title string, :updateTime string, :id string, :alternateLink string, :materials [{:youtubeVideo YouTubeVideo, :link Link, :driveFile SharedDriveFile, :form Form}], :courseId string}
Creates a course work material. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to access the requested course, create course work material in the requested course, share a Drive attachment, or for access errors. * INVALID_ARGUMENT
if the request is malformed or if more than 20 * materials are provided. * NOT_FOUND
if the requested course does not exist. * FAILED_PRECONDITION
for the following request error: * AttachmentNotVisible
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWorkMaterials/create Required parameters: courseId Optional parameters: none Body: {:creationTime string, :description string, :individualStudentsOptions {:studentIds [string]}, :creatorUserId string, :assigneeMode string, :topicId string, :scheduledTime string, :state string, :title string, :updateTime string, :id string, :alternateLink string, :materials [{:youtubeVideo YouTubeVideo, :link Link, :driveFile SharedDriveFile, :form Form}], :courseId string} Creates a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work material in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed or if more than 20 * materials are provided. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible
(courseWorkMaterials-delete$ auth parameters)
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWorkMaterials/delete
Required parameters: id, courseId
Optional parameters: none
Deletes a course work material. This request must be made by the Developer Console project of the OAuth client ID used to create the corresponding course work material item. This method returns the following error codes: * PERMISSION_DENIED
if the requesting developer project did not create the corresponding course work material, if the requesting user is not permitted to delete the requested course or for access errors. * FAILED_PRECONDITION
if the requested course work material has already been deleted. * NOT_FOUND
if no course exists with the requested ID.
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWorkMaterials/delete Required parameters: id, courseId Optional parameters: none Deletes a course work material. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work material item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work material, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work material has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.
(courseWorkMaterials-get$ auth parameters)
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWorkMaterials/get
Required parameters: courseId, id
Optional parameters: none
Returns a course work material. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to access the requested course or course work material, or for access errors. * INVALID_ARGUMENT
if the request is malformed. * NOT_FOUND
if the requested course or course work material does not exist.
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWorkMaterials/get Required parameters: courseId, id Optional parameters: none Returns a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work material, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work material does not exist.
(courseWorkMaterials-list$ auth parameters)
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWorkMaterials/list
Required parameters: courseId
Optional parameters: orderBy, materialLink, materialDriveId, courseWorkMaterialStates, pageToken, pageSize
Returns a list of course work material that the requester is permitted to view. Course students may only view PUBLISHED
course work material. Course teachers and domain administrators may view all course work material. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to access the requested course or for access errors. * INVALID_ARGUMENT
if the request is malformed. * NOT_FOUND
if the requested course does not exist.
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWorkMaterials/list Required parameters: courseId Optional parameters: orderBy, materialLink, materialDriveId, courseWorkMaterialStates, pageToken, pageSize Returns a list of course work material that the requester is permitted to view. Course students may only view `PUBLISHED` course work material. Course teachers and domain administrators may view all course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
(courseWorkMaterials-patch$ auth parameters body)
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWorkMaterials/patch
Required parameters: id, courseId
Optional parameters: updateMask
Body:
{:creationTime string, :description string, :individualStudentsOptions {:studentIds [string]}, :creatorUserId string, :assigneeMode string, :topicId string, :scheduledTime string, :state string, :title string, :updateTime string, :id string, :alternateLink string, :materials [{:youtubeVideo YouTubeVideo, :link Link, :driveFile SharedDriveFile, :form Form}], :courseId string}
Updates one or more fields of a course work material. This method returns the following error codes: * PERMISSION_DENIED
if the requesting developer project for access errors. * INVALID_ARGUMENT
if the request is malformed. * FAILED_PRECONDITION
if the requested course work material has already been deleted. * NOT_FOUND
if the requested course or course work material does not exist
https://developers.google.com/classroom/api/reference/rest/v1/courses/courseWorkMaterials/patch Required parameters: id, courseId Optional parameters: updateMask Body: {:creationTime string, :description string, :individualStudentsOptions {:studentIds [string]}, :creatorUserId string, :assigneeMode string, :topicId string, :scheduledTime string, :state string, :title string, :updateTime string, :id string, :alternateLink string, :materials [{:youtubeVideo YouTubeVideo, :link Link, :driveFile SharedDriveFile, :form Form}], :courseId string} Updates one or more fields of a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work material has already been deleted. * `NOT_FOUND` if the requested course or course work material does not exist
(create$ auth parameters body)
https://developers.google.com/classroom/api/reference/rest/v1/courses/create
Required parameters: none
Optional parameters: none
Body:
{:creationTime string, :description string, :calendarId string, :ownerId string, :teacherFolder {:id string, :alternateLink string, :title string}, :name string, :section string, :guardiansEnabled boolean, :updateTime string, :courseMaterialSets [{:title string, :materials [CourseMaterial]}], :courseState string, :enrollmentCode string, :id string, :alternateLink string, :teacherGroupEmail string, :room string, :courseGroupEmail string, :descriptionHeading string}
Creates a course. The user specified in ownerId
is the owner of the created course and added as a teacher. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to create courses or for access errors. * NOT_FOUND
if the primary teacher is not a valid user. * FAILED_PRECONDITION
if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * ALREADY_EXISTS
if an alias was specified in the id
and already exists.
https://developers.google.com/classroom/api/reference/rest/v1/courses/create Required parameters: none Optional parameters: none Body: {:creationTime string, :description string, :calendarId string, :ownerId string, :teacherFolder {:id string, :alternateLink string, :title string}, :name string, :section string, :guardiansEnabled boolean, :updateTime string, :courseMaterialSets [{:title string, :materials [CourseMaterial]}], :courseState string, :enrollmentCode string, :id string, :alternateLink string, :teacherGroupEmail string, :room string, :courseGroupEmail string, :descriptionHeading string} Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. * `FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if an alias was specified in the `id` and already exists.
(delete$ auth parameters)
https://developers.google.com/classroom/api/reference/rest/v1/courses/delete
Required parameters: id
Optional parameters: none
Deletes a course. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to delete the requested course or for access errors. * NOT_FOUND
if no course exists with the requested ID.
https://developers.google.com/classroom/api/reference/rest/v1/courses/delete Required parameters: id Optional parameters: none Deletes a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.
(get$ auth parameters)
https://developers.google.com/classroom/api/reference/rest/v1/courses/get
Required parameters: id
Optional parameters: none
Returns a course. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to access the requested course or for access errors. * NOT_FOUND
if no course exists with the requested ID.
https://developers.google.com/classroom/api/reference/rest/v1/courses/get Required parameters: id Optional parameters: none Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.
(list$ auth parameters)
https://developers.google.com/classroom/api/reference/rest/v1/courses/list
Required parameters: none
Optional parameters: teacherId, pageSize, courseStates, studentId, pageToken
Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: * PERMISSION_DENIED
for access errors. * INVALID_ARGUMENT
if the query argument is malformed. * NOT_FOUND
if any users specified in the query arguments do not exist.
https://developers.google.com/classroom/api/reference/rest/v1/courses/list Required parameters: none Optional parameters: teacherId, pageSize, courseStates, studentId, pageToken Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.
(patch$ auth parameters body)
https://developers.google.com/classroom/api/reference/rest/v1/courses/patch
Required parameters: id
Optional parameters: updateMask
Body:
{:creationTime string, :description string, :calendarId string, :ownerId string, :teacherFolder {:id string, :alternateLink string, :title string}, :name string, :section string, :guardiansEnabled boolean, :updateTime string, :courseMaterialSets [{:title string, :materials [CourseMaterial]}], :courseState string, :enrollmentCode string, :id string, :alternateLink string, :teacherGroupEmail string, :room string, :courseGroupEmail string, :descriptionHeading string}
Updates one or more fields in a course. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to modify the requested course or for access errors. * NOT_FOUND
if no course exists with the requested ID. * INVALID_ARGUMENT
if invalid fields are specified in the update mask or if no update mask is supplied. * FAILED_PRECONDITION
for the following request errors: * CourseNotModifiable
https://developers.google.com/classroom/api/reference/rest/v1/courses/patch Required parameters: id Optional parameters: updateMask Body: {:creationTime string, :description string, :calendarId string, :ownerId string, :teacherFolder {:id string, :alternateLink string, :title string}, :name string, :section string, :guardiansEnabled boolean, :updateTime string, :courseMaterialSets [{:title string, :materials [CourseMaterial]}], :courseState string, :enrollmentCode string, :id string, :alternateLink string, :teacherGroupEmail string, :room string, :courseGroupEmail string, :descriptionHeading string} Updates one or more fields in a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable
(students-create$ auth parameters body)
https://developers.google.com/classroom/api/reference/rest/v1/courses/students/create
Required parameters: courseId
Optional parameters: enrollmentCode
Body:
{:profile {:name Name, :photoUrl string, :emailAddress string, :id string, :verifiedTeacher boolean, :permissions [GlobalPermission]}, :studentWorkFolder {:id string, :alternateLink string, :title string}, :userId string, :courseId string}
Adds a user as a student of a course. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to create students in this course or for access errors. * NOT_FOUND
if the requested course ID does not exist. * FAILED_PRECONDITION
if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * ALREADY_EXISTS
if the user is already a student or teacher in the course.
https://developers.google.com/classroom/api/reference/rest/v1/courses/students/create Required parameters: courseId Optional parameters: enrollmentCode Body: {:profile {:name Name, :photoUrl string, :emailAddress string, :id string, :verifiedTeacher boolean, :permissions [GlobalPermission]}, :studentWorkFolder {:id string, :alternateLink string, :title string}, :userId string, :courseId string} Adds a user as a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course.
(students-delete$ auth parameters)
https://developers.google.com/classroom/api/reference/rest/v1/courses/students/delete
Required parameters: userId, courseId
Optional parameters: none
Deletes a student of a course. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to delete students of this course or for access errors. * NOT_FOUND
if no student of this course has the requested ID or if the course does not exist.
https://developers.google.com/classroom/api/reference/rest/v1/courses/students/delete Required parameters: userId, courseId Optional parameters: none Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.
(students-get$ auth parameters)
https://developers.google.com/classroom/api/reference/rest/v1/courses/students/get
Required parameters: courseId, userId
Optional parameters: none
Returns a student of a course. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to view students of this course or for access errors. * NOT_FOUND
if no student of this course has the requested ID or if the course does not exist.
https://developers.google.com/classroom/api/reference/rest/v1/courses/students/get Required parameters: courseId, userId Optional parameters: none Returns a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.
(students-list$ auth parameters)
https://developers.google.com/classroom/api/reference/rest/v1/courses/students/list
Required parameters: courseId
Optional parameters: pageSize, pageToken
Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: * NOT_FOUND
if the course does not exist. * PERMISSION_DENIED
for access errors.
https://developers.google.com/classroom/api/reference/rest/v1/courses/students/list Required parameters: courseId Optional parameters: pageSize, pageToken Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.
(teachers-create$ auth parameters body)
https://developers.google.com/classroom/api/reference/rest/v1/courses/teachers/create
Required parameters: courseId
Optional parameters: none
Body:
{:courseId string, :userId string, :profile {:name Name, :photoUrl string, :emailAddress string, :id string, :verifiedTeacher boolean, :permissions [GlobalPermission]}}
Creates a teacher of a course. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to create teachers in this course or for access errors. * NOT_FOUND
if the requested course ID does not exist. * FAILED_PRECONDITION
if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * ALREADY_EXISTS
if the user is already a teacher or student in the course.
https://developers.google.com/classroom/api/reference/rest/v1/courses/teachers/create Required parameters: courseId Optional parameters: none Body: {:courseId string, :userId string, :profile {:name Name, :photoUrl string, :emailAddress string, :id string, :verifiedTeacher boolean, :permissions [GlobalPermission]}} Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teacher or student in the course.
(teachers-delete$ auth parameters)
https://developers.google.com/classroom/api/reference/rest/v1/courses/teachers/delete
Required parameters: courseId, userId
Optional parameters: none
Deletes a teacher of a course. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to delete teachers of this course or for access errors. * NOT_FOUND
if no teacher of this course has the requested ID or if the course does not exist. * FAILED_PRECONDITION
if the requested ID belongs to the primary teacher of this course. * FAILED_PRECONDITION
if the requested ID belongs to the owner of the course Drive folder. * FAILED_PRECONDITION
if the course no longer has an active owner.
https://developers.google.com/classroom/api/reference/rest/v1/courses/teachers/delete Required parameters: courseId, userId Optional parameters: none Deletes a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course. * `FAILED_PRECONDITION` if the requested ID belongs to the owner of the course Drive folder. * `FAILED_PRECONDITION` if the course no longer has an active owner.
(teachers-get$ auth parameters)
https://developers.google.com/classroom/api/reference/rest/v1/courses/teachers/get
Required parameters: userId, courseId
Optional parameters: none
Returns a teacher of a course. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to view teachers of this course or for access errors. * NOT_FOUND
if no teacher of this course has the requested ID or if the course does not exist.
https://developers.google.com/classroom/api/reference/rest/v1/courses/teachers/get Required parameters: userId, courseId Optional parameters: none Returns a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course or for access errors. * `NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist.
(teachers-list$ auth parameters)
https://developers.google.com/classroom/api/reference/rest/v1/courses/teachers/list
Required parameters: courseId
Optional parameters: pageSize, pageToken
Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: * NOT_FOUND
if the course does not exist. * PERMISSION_DENIED
for access errors.
https://developers.google.com/classroom/api/reference/rest/v1/courses/teachers/list Required parameters: courseId Optional parameters: pageSize, pageToken Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.
(topics-create$ auth parameters body)
https://developers.google.com/classroom/api/reference/rest/v1/courses/topics/create
Required parameters: courseId
Optional parameters: none
Body:
{:courseId string, :updateTime string, :name string, :topicId string}
Creates a topic. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * INVALID_ARGUMENT
if the request is malformed. * NOT_FOUND
if the requested course does not exist.
https://developers.google.com/classroom/api/reference/rest/v1/courses/topics/create Required parameters: courseId Optional parameters: none Body: {:courseId string, :updateTime string, :name string, :topicId string} Creates a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
(topics-delete$ auth parameters)
https://developers.google.com/classroom/api/reference/rest/v1/courses/topics/delete
Required parameters: courseId, id
Optional parameters: none
Deletes a topic. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not allowed to delete the requested topic or for access errors. * FAILED_PRECONDITION
if the requested topic has already been deleted. * NOT_FOUND
if no course or topic exists with the requested ID.
https://developers.google.com/classroom/api/reference/rest/v1/courses/topics/delete Required parameters: courseId, id Optional parameters: none Deletes a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not allowed to delete the requested topic or for access errors. * `FAILED_PRECONDITION` if the requested topic has already been deleted. * `NOT_FOUND` if no course or topic exists with the requested ID.
(topics-get$ auth parameters)
https://developers.google.com/classroom/api/reference/rest/v1/courses/topics/get
Required parameters: courseId, id
Optional parameters: none
Returns a topic. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to access the requested course or topic, or for access errors. * INVALID_ARGUMENT
if the request is malformed. * NOT_FOUND
if the requested course or topic does not exist.
https://developers.google.com/classroom/api/reference/rest/v1/courses/topics/get Required parameters: courseId, id Optional parameters: none Returns a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or topic, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist.
(topics-list$ auth parameters)
https://developers.google.com/classroom/api/reference/rest/v1/courses/topics/list
Required parameters: courseId
Optional parameters: pageToken, pageSize
Returns the list of topics that the requester is permitted to view. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to access the requested course or for access errors. * INVALID_ARGUMENT
if the request is malformed. * NOT_FOUND
if the requested course does not exist.
https://developers.google.com/classroom/api/reference/rest/v1/courses/topics/list Required parameters: courseId Optional parameters: pageToken, pageSize Returns the list of topics that the requester is permitted to view. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
(topics-patch$ auth parameters body)
https://developers.google.com/classroom/api/reference/rest/v1/courses/topics/patch
Required parameters: courseId, id
Optional parameters: updateMask
Body:
{:courseId string, :updateTime string, :name string, :topicId string}
Updates one or more fields of a topic. This method returns the following error codes: * PERMISSION_DENIED
if the requesting developer project did not create the corresponding topic or for access errors. * INVALID_ARGUMENT
if the request is malformed. * NOT_FOUND
if the requested course or topic does not exist
https://developers.google.com/classroom/api/reference/rest/v1/courses/topics/patch Required parameters: courseId, id Optional parameters: updateMask Body: {:courseId string, :updateTime string, :name string, :topicId string} Updates one or more fields of a topic. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or topic does not exist
(update$ auth parameters body)
https://developers.google.com/classroom/api/reference/rest/v1/courses/update
Required parameters: id
Optional parameters: none
Body:
{:creationTime string, :description string, :calendarId string, :ownerId string, :teacherFolder {:id string, :alternateLink string, :title string}, :name string, :section string, :guardiansEnabled boolean, :updateTime string, :courseMaterialSets [{:title string, :materials [CourseMaterial]}], :courseState string, :enrollmentCode string, :id string, :alternateLink string, :teacherGroupEmail string, :room string, :courseGroupEmail string, :descriptionHeading string}
Updates a course. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to modify the requested course or for access errors. * NOT_FOUND
if no course exists with the requested ID. * FAILED_PRECONDITION
for the following request errors: * CourseNotModifiable
https://developers.google.com/classroom/api/reference/rest/v1/courses/update Required parameters: id Optional parameters: none Body: {:creationTime string, :description string, :calendarId string, :ownerId string, :teacherFolder {:id string, :alternateLink string, :title string}, :name string, :section string, :guardiansEnabled boolean, :updateTime string, :courseMaterialSets [{:title string, :materials [CourseMaterial]}], :courseState string, :enrollmentCode string, :id string, :alternateLink string, :teacherGroupEmail string, :room string, :courseGroupEmail string, :descriptionHeading string} Updates a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID. * `FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close