gogol-classroom
Copyright(c) 2015-2025 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <[email protected]> Toni Cebrián <[email protected]>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageGHC2021

Gogol.Classroom.Courses.CourseWork.StudentSubmissions.Reclaim

Description

Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and 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.

See: Google Classroom API Reference for classroom.courses.courseWork.studentSubmissions.reclaim.

Synopsis

Resource

type ClassroomCoursesCourseWorkStudentSubmissionsReclaimResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("courseWork" :> (Capture "courseWorkId" Text :> ("studentSubmissions" :> (CaptureMode "id" "reclaim" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] ReclaimStudentSubmissionRequest :> Post '[JSON] Empty))))))))))))) Source #

A resource alias for classroom.courses.courseWork.studentSubmissions.reclaim method which the ClassroomCoursesCourseWorkStudentSubmissionsReclaim request conforms to.

Constructing a Request

data ClassroomCoursesCourseWorkStudentSubmissionsReclaim Source #

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.

See: newClassroomCoursesCourseWorkStudentSubmissionsReclaim smart constructor.

Constructors

ClassroomCoursesCourseWorkStudentSubmissionsReclaim 

Fields

Instances

Instances details
Generic ClassroomCoursesCourseWorkStudentSubmissionsReclaim Source # 
Instance details

Defined in Gogol.Classroom.Courses.CourseWork.StudentSubmissions.Reclaim

Associated Types

type Rep ClassroomCoursesCourseWorkStudentSubmissionsReclaim 
Instance details

Defined in Gogol.Classroom.Courses.CourseWork.StudentSubmissions.Reclaim

type Rep ClassroomCoursesCourseWorkStudentSubmissionsReclaim = D1 ('MetaData "ClassroomCoursesCourseWorkStudentSubmissionsReclaim" "Gogol.Classroom.Courses.CourseWork.StudentSubmissions.Reclaim" "gogol-classroom-1.0.0-E0l1a33tlucKcuM1xSJBzt" 'False) (C1 ('MetaCons "ClassroomCoursesCourseWorkStudentSubmissionsReclaim" 'PrefixI 'True) (((S1 ('MetaSel ('Just "xgafv") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Xgafv)) :*: S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "callback") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "courseId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "courseWorkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "payload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ReclaimStudentSubmissionRequest) :*: (S1 ('MetaSel ('Just "uploadType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "uploadProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))
Show ClassroomCoursesCourseWorkStudentSubmissionsReclaim Source # 
Instance details

Defined in Gogol.Classroom.Courses.CourseWork.StudentSubmissions.Reclaim

Eq ClassroomCoursesCourseWorkStudentSubmissionsReclaim Source # 
Instance details

Defined in Gogol.Classroom.Courses.CourseWork.StudentSubmissions.Reclaim

GoogleRequest ClassroomCoursesCourseWorkStudentSubmissionsReclaim Source # 
Instance details

Defined in Gogol.Classroom.Courses.CourseWork.StudentSubmissions.Reclaim

type Rep ClassroomCoursesCourseWorkStudentSubmissionsReclaim Source # 
Instance details

Defined in Gogol.Classroom.Courses.CourseWork.StudentSubmissions.Reclaim

type Rep ClassroomCoursesCourseWorkStudentSubmissionsReclaim = D1 ('MetaData "ClassroomCoursesCourseWorkStudentSubmissionsReclaim" "Gogol.Classroom.Courses.CourseWork.StudentSubmissions.Reclaim" "gogol-classroom-1.0.0-E0l1a33tlucKcuM1xSJBzt" 'False) (C1 ('MetaCons "ClassroomCoursesCourseWorkStudentSubmissionsReclaim" 'PrefixI 'True) (((S1 ('MetaSel ('Just "xgafv") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Xgafv)) :*: S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "callback") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "courseId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "courseWorkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "payload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ReclaimStudentSubmissionRequest) :*: (S1 ('MetaSel ('Just "uploadType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "uploadProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))
type Rs ClassroomCoursesCourseWorkStudentSubmissionsReclaim Source # 
Instance details

Defined in Gogol.Classroom.Courses.CourseWork.StudentSubmissions.Reclaim

type Scopes ClassroomCoursesCourseWorkStudentSubmissionsReclaim Source # 
Instance details

Defined in Gogol.Classroom.Courses.CourseWork.StudentSubmissions.Reclaim

newClassroomCoursesCourseWorkStudentSubmissionsReclaim Source #

Arguments

:: Text

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. See courseId.

-> Text

Identifier of the course work. See courseWorkId.

-> Text

Identifier of the student submission. See id.

-> ReclaimStudentSubmissionRequest

Multipart request metadata. See payload.

-> ClassroomCoursesCourseWorkStudentSubmissionsReclaim 

Creates a value of ClassroomCoursesCourseWorkStudentSubmissionsReclaim with the minimum fields required to make a request.