Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.Classroom.Courses.Students.List

Contents

REST Resource
Creating a Request
Request Lenses

Description

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.

See: Google Classroom API Reference for classroom.courses.students.list.

Synopsis

type CoursesStudentsListResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("students" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListStudentsResponse)))))))))))
coursesStudentsList :: Text -> CoursesStudentsList
data CoursesStudentsList
cslXgafv :: Lens' CoursesStudentsList (Maybe Xgafv)
cslUploadProtocol :: Lens' CoursesStudentsList (Maybe Text)
cslCourseId :: Lens' CoursesStudentsList Text
cslAccessToken :: Lens' CoursesStudentsList (Maybe Text)
cslUploadType :: Lens' CoursesStudentsList (Maybe Text)
cslPageToken :: Lens' CoursesStudentsList (Maybe Text)
cslPageSize :: Lens' CoursesStudentsList (Maybe Int32)
cslCallback :: Lens' CoursesStudentsList (Maybe Text)

REST Resource

type CoursesStudentsListResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("students" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListStudentsResponse))))))))))) Source #

A resource alias for classroom.courses.students.list method which the CoursesStudentsList request conforms to.

Creating a Request

coursesStudentsList Source #

Arguments

:: Text	`cslCourseId`
-> CoursesStudentsList

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

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

data CoursesStudentsList Source #

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.

See: coursesStudentsList smart constructor.

Instances

Eq CoursesStudentsList Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Students.List Methods (==) :: CoursesStudentsList -> CoursesStudentsList -> Bool # (/=) :: CoursesStudentsList -> CoursesStudentsList -> Bool #
Data CoursesStudentsList Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Students.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CoursesStudentsList -> c CoursesStudentsList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CoursesStudentsList # toConstr :: CoursesStudentsList -> Constr # dataTypeOf :: CoursesStudentsList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CoursesStudentsList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CoursesStudentsList) # gmapT :: (forall b. Data b => b -> b) -> CoursesStudentsList -> CoursesStudentsList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CoursesStudentsList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CoursesStudentsList -> r # gmapQ :: (forall d. Data d => d -> u) -> CoursesStudentsList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CoursesStudentsList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CoursesStudentsList -> m CoursesStudentsList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesStudentsList -> m CoursesStudentsList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesStudentsList -> m CoursesStudentsList #
Show CoursesStudentsList Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Students.List Methods showsPrec :: Int -> CoursesStudentsList -> ShowS # show :: CoursesStudentsList -> String # showList :: [CoursesStudentsList] -> ShowS #
Generic CoursesStudentsList Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Students.List Associated Types type Rep CoursesStudentsList :: Type -> Type # Methods from :: CoursesStudentsList -> Rep CoursesStudentsList x # to :: Rep CoursesStudentsList x -> CoursesStudentsList #
GoogleRequest CoursesStudentsList Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Students.List Associated Types type Rs CoursesStudentsList :: Type # type Scopes CoursesStudentsList :: [Symbol] # Methods requestClient :: CoursesStudentsList -> GClient (Rs CoursesStudentsList) #
type Rep CoursesStudentsList Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Students.List type Rep CoursesStudentsList = D1 (MetaData "CoursesStudentsList" "Network.Google.Resource.Classroom.Courses.Students.List" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "CoursesStudentsList'" PrefixI True) (((S1 (MetaSel (Just "_cslXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: S1 (MetaSel (Just "_cslUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_cslCourseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_cslAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_cslUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_cslPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_cslPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_cslCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes CoursesStudentsList Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Students.List type Scopes CoursesStudentsList = "https://www.googleapis.com/auth/classroom.profile.emails" ': ("https://www.googleapis.com/auth/classroom.profile.photos" ': ("https://www.googleapis.com/auth/classroom.rosters" ': ("https://www.googleapis.com/auth/classroom.rosters.readonly" ': ([] :: [Symbol]))))
type Rs CoursesStudentsList Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Students.List type Rs CoursesStudentsList = ListStudentsResponse

Request Lenses

cslXgafv :: Lens' CoursesStudentsList (Maybe Xgafv) Source #

V1 error format.

cslUploadProtocol :: Lens' CoursesStudentsList (Maybe Text) Source #

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

cslCourseId :: Lens' CoursesStudentsList Text Source #

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

cslAccessToken :: Lens' CoursesStudentsList (Maybe Text) Source #

OAuth access token.

cslUploadType :: Lens' CoursesStudentsList (Maybe Text) Source #

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

cslPageToken :: Lens' CoursesStudentsList (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.

cslPageSize :: Lens' CoursesStudentsList (Maybe Int32) Source #

Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.

cslCallback :: Lens' CoursesStudentsList (Maybe Text) Source #

JSONP