gogol-classroom-0.4.0: Google Classroom SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Classroom.Courses.CourseWork.StudentSubmissions.Reclaim

Contents

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

REST Resource

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

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

Creating a Request

coursesCourseWorkStudentSubmissionsReclaim Source #

Arguments

:: Text

ccwssrcCourseId

-> ReclaimStudentSubmissionRequest

ccwssrcPayload

-> Text

ccwssrcId

-> Text

ccwssrcCourseWorkId

-> CoursesCourseWorkStudentSubmissionsReclaim 

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

Use one of the following lenses to modify other fields as desired:

data CoursesCourseWorkStudentSubmissionsReclaim 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: coursesCourseWorkStudentSubmissionsReclaim smart constructor.

Instances
Eq CoursesCourseWorkStudentSubmissionsReclaim Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.CourseWork.StudentSubmissions.Reclaim

Methods

(==) :: CoursesCourseWorkStudentSubmissionsReclaim -> CoursesCourseWorkStudentSubmissionsReclaim -> Bool #

(/=) :: CoursesCourseWorkStudentSubmissionsReclaim -> CoursesCourseWorkStudentSubmissionsReclaim -> Bool #

Data CoursesCourseWorkStudentSubmissionsReclaim Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.CourseWork.StudentSubmissions.Reclaim

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CoursesCourseWorkStudentSubmissionsReclaim -> c CoursesCourseWorkStudentSubmissionsReclaim #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CoursesCourseWorkStudentSubmissionsReclaim #

toConstr :: CoursesCourseWorkStudentSubmissionsReclaim -> Constr #

dataTypeOf :: CoursesCourseWorkStudentSubmissionsReclaim -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CoursesCourseWorkStudentSubmissionsReclaim) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CoursesCourseWorkStudentSubmissionsReclaim) #

gmapT :: (forall b. Data b => b -> b) -> CoursesCourseWorkStudentSubmissionsReclaim -> CoursesCourseWorkStudentSubmissionsReclaim #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CoursesCourseWorkStudentSubmissionsReclaim -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CoursesCourseWorkStudentSubmissionsReclaim -> r #

gmapQ :: (forall d. Data d => d -> u) -> CoursesCourseWorkStudentSubmissionsReclaim -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CoursesCourseWorkStudentSubmissionsReclaim -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CoursesCourseWorkStudentSubmissionsReclaim -> m CoursesCourseWorkStudentSubmissionsReclaim #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesCourseWorkStudentSubmissionsReclaim -> m CoursesCourseWorkStudentSubmissionsReclaim #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesCourseWorkStudentSubmissionsReclaim -> m CoursesCourseWorkStudentSubmissionsReclaim #

Show CoursesCourseWorkStudentSubmissionsReclaim Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.CourseWork.StudentSubmissions.Reclaim

Methods

showsPrec :: Int -> CoursesCourseWorkStudentSubmissionsReclaim -> ShowS #

show :: CoursesCourseWorkStudentSubmissionsReclaim -> String #

showList :: [CoursesCourseWorkStudentSubmissionsReclaim] -> ShowS #

Generic CoursesCourseWorkStudentSubmissionsReclaim Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.CourseWork.StudentSubmissions.Reclaim

Associated Types

type Rep CoursesCourseWorkStudentSubmissionsReclaim :: Type -> Type #

Methods

from :: CoursesCourseWorkStudentSubmissionsReclaim -> Rep CoursesCourseWorkStudentSubmissionsReclaim x #

to :: Rep CoursesCourseWorkStudentSubmissionsReclaim x -> CoursesCourseWorkStudentSubmissionsReclaim #

GoogleRequest CoursesCourseWorkStudentSubmissionsReclaim Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.CourseWork.StudentSubmissions.Reclaim

Associated Types

type Rs CoursesCourseWorkStudentSubmissionsReclaim :: Type #

type Scopes CoursesCourseWorkStudentSubmissionsReclaim :: [Symbol] #

Methods

requestClient :: CoursesCourseWorkStudentSubmissionsReclaim -> GClient (Rs CoursesCourseWorkStudentSubmissionsReclaim) #

type Rep CoursesCourseWorkStudentSubmissionsReclaim Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.CourseWork.StudentSubmissions.Reclaim

type Rep CoursesCourseWorkStudentSubmissionsReclaim = D1 (MetaData "CoursesCourseWorkStudentSubmissionsReclaim" "Network.Google.Resource.Classroom.Courses.CourseWork.StudentSubmissions.Reclaim" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "CoursesCourseWorkStudentSubmissionsReclaim'" PrefixI True) (((S1 (MetaSel (Just "_ccwssrcXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: S1 (MetaSel (Just "_ccwssrcUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_ccwssrcCourseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_ccwssrcAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_ccwssrcUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ccwssrcPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ReclaimStudentSubmissionRequest)) :*: (S1 (MetaSel (Just "_ccwssrcId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_ccwssrcCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ccwssrcCourseWorkId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))
type Scopes CoursesCourseWorkStudentSubmissionsReclaim Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.CourseWork.StudentSubmissions.Reclaim

type Scopes CoursesCourseWorkStudentSubmissionsReclaim = "https://www.googleapis.com/auth/classroom.coursework.me" ': ([] :: [Symbol])
type Rs CoursesCourseWorkStudentSubmissionsReclaim Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.CourseWork.StudentSubmissions.Reclaim

type Rs CoursesCourseWorkStudentSubmissionsReclaim = Empty

Request Lenses

ccwssrcXgafv :: Lens' CoursesCourseWorkStudentSubmissionsReclaim (Maybe Xgafv) Source #

V1 error format.

ccwssrcUploadProtocol :: Lens' CoursesCourseWorkStudentSubmissionsReclaim (Maybe Text) Source #

Upload protocol for media (e.g. "raw", "multipart").

ccwssrcCourseId :: Lens' CoursesCourseWorkStudentSubmissionsReclaim Text Source #

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

ccwssrcAccessToken :: Lens' CoursesCourseWorkStudentSubmissionsReclaim (Maybe Text) Source #

OAuth access token.

ccwssrcUploadType :: Lens' CoursesCourseWorkStudentSubmissionsReclaim (Maybe Text) Source #

Legacy upload protocol for media (e.g. "media", "multipart").

ccwssrcPayload :: Lens' CoursesCourseWorkStudentSubmissionsReclaim ReclaimStudentSubmissionRequest Source #

Multipart request metadata.

ccwssrcId :: Lens' CoursesCourseWorkStudentSubmissionsReclaim Text Source #

Identifier of the student submission.

ccwssrcCallback :: Lens' CoursesCourseWorkStudentSubmissionsReclaim (Maybe Text) Source #

JSONP

ccwssrcCourseWorkId :: Lens' CoursesCourseWorkStudentSubmissionsReclaim Text Source #

Identifier of the course work.