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.List

Contents

Description

Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. `-` may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

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

Synopsis

REST Resource

type CoursesCourseWorkStudentSubmissionsListResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("courseWork" :> (Capture "courseWorkId" Text :> ("studentSubmissions" :> (QueryParams "states" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "late" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "userId" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListStudentSubmissionsResponse)))))))))))))))) Source #

A resource alias for classroom.courses.courseWork.studentSubmissions.list method which the CoursesCourseWorkStudentSubmissionsList request conforms to.

Creating a Request

data CoursesCourseWorkStudentSubmissionsList Source #

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.

See: coursesCourseWorkStudentSubmissionsList smart constructor.

Instances
Eq CoursesCourseWorkStudentSubmissionsList Source # 
Instance details

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

Data CoursesCourseWorkStudentSubmissionsList Source # 
Instance details

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

Methods

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

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

toConstr :: CoursesCourseWorkStudentSubmissionsList -> Constr #

dataTypeOf :: CoursesCourseWorkStudentSubmissionsList -> DataType #

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

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

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

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

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

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

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

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

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

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

Show CoursesCourseWorkStudentSubmissionsList Source # 
Instance details

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

Generic CoursesCourseWorkStudentSubmissionsList Source # 
Instance details

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

GoogleRequest CoursesCourseWorkStudentSubmissionsList Source # 
Instance details

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

type Rep CoursesCourseWorkStudentSubmissionsList Source # 
Instance details

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

type Rep CoursesCourseWorkStudentSubmissionsList = D1 (MetaData "CoursesCourseWorkStudentSubmissionsList" "Network.Google.Resource.Classroom.Courses.CourseWork.StudentSubmissions.List" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "CoursesCourseWorkStudentSubmissionsList'" PrefixI True) (((S1 (MetaSel (Just "_ccwsslStates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 (MetaSel (Just "_ccwsslXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: S1 (MetaSel (Just "_ccwsslLate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_ccwsslUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_ccwsslCourseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_ccwsslAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_ccwsslUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_ccwsslUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ccwsslPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_ccwsslPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: (S1 (MetaSel (Just "_ccwsslCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ccwsslCourseWorkId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))
type Scopes CoursesCourseWorkStudentSubmissionsList Source # 
Instance details

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

type Scopes CoursesCourseWorkStudentSubmissionsList = "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" ': ([] :: [Symbol]))))))
type Rs CoursesCourseWorkStudentSubmissionsList Source # 
Instance details

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

Request Lenses

ccwsslStates :: Lens' CoursesCourseWorkStudentSubmissionsList [Text] Source #

Requested submission states. If specified, returned student submissions match one of the specified submission states.

ccwsslLate :: Lens' CoursesCourseWorkStudentSubmissionsList (Maybe Text) Source #

Requested lateness value. If specified, returned student submissions are restricted by the requested value. If unspecified, submissions are returned regardless of `late` value.

ccwsslUploadProtocol :: Lens' CoursesCourseWorkStudentSubmissionsList (Maybe Text) Source #

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

ccwsslCourseId :: Lens' CoursesCourseWorkStudentSubmissionsList Text Source #

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

ccwsslUploadType :: Lens' CoursesCourseWorkStudentSubmissionsList (Maybe Text) Source #

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

ccwsslUserId :: Lens' CoursesCourseWorkStudentSubmissionsList (Maybe Text) Source #

Optional argument to restrict returned student work to those owned by the student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user

ccwsslPageToken :: Lens' CoursesCourseWorkStudentSubmissionsList (Maybe Text) Source #

nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.

ccwsslPageSize :: Lens' CoursesCourseWorkStudentSubmissionsList (Maybe Int32) Source #

Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

ccwsslCourseWorkId :: Lens' CoursesCourseWorkStudentSubmissionsList Text Source #

Identifier of the student work to request. This may be set to the string literal `"-"` to request student work for all course work in the specified course.