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

Contents

REST Resource
Creating a Request
Request Lenses

Description

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.

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

Synopsis

type CoursesStudentsGetResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("students" :> (Capture "userId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Student))))))))))
coursesStudentsGet :: Text -> Text -> CoursesStudentsGet
data CoursesStudentsGet
csgXgafv :: Lens' CoursesStudentsGet (Maybe Xgafv)
csgUploadProtocol :: Lens' CoursesStudentsGet (Maybe Text)
csgCourseId :: Lens' CoursesStudentsGet Text
csgAccessToken :: Lens' CoursesStudentsGet (Maybe Text)
csgUploadType :: Lens' CoursesStudentsGet (Maybe Text)
csgUserId :: Lens' CoursesStudentsGet Text
csgCallback :: Lens' CoursesStudentsGet (Maybe Text)

REST Resource

type CoursesStudentsGetResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("students" :> (Capture "userId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Student)))))))))) Source #

A resource alias for classroom.courses.students.get method which the CoursesStudentsGet request conforms to.

Creating a Request

coursesStudentsGet Source #

Arguments

:: Text	`csgCourseId`
-> Text	`csgUserId`
-> CoursesStudentsGet

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

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

data CoursesStudentsGet Source #

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.

See: coursesStudentsGet smart constructor.

Instances

Eq CoursesStudentsGet Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Students.Get Methods (==) :: CoursesStudentsGet -> CoursesStudentsGet -> Bool # (/=) :: CoursesStudentsGet -> CoursesStudentsGet -> Bool #
Data CoursesStudentsGet Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Students.Get Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CoursesStudentsGet -> c CoursesStudentsGet # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CoursesStudentsGet # toConstr :: CoursesStudentsGet -> Constr # dataTypeOf :: CoursesStudentsGet -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CoursesStudentsGet) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CoursesStudentsGet) # gmapT :: (forall b. Data b => b -> b) -> CoursesStudentsGet -> CoursesStudentsGet # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CoursesStudentsGet -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CoursesStudentsGet -> r # gmapQ :: (forall d. Data d => d -> u) -> CoursesStudentsGet -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CoursesStudentsGet -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CoursesStudentsGet -> m CoursesStudentsGet # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesStudentsGet -> m CoursesStudentsGet # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesStudentsGet -> m CoursesStudentsGet #
Show CoursesStudentsGet Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Students.Get Methods showsPrec :: Int -> CoursesStudentsGet -> ShowS # show :: CoursesStudentsGet -> String # showList :: [CoursesStudentsGet] -> ShowS #
Generic CoursesStudentsGet Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Students.Get Associated Types type Rep CoursesStudentsGet :: Type -> Type # Methods from :: CoursesStudentsGet -> Rep CoursesStudentsGet x # to :: Rep CoursesStudentsGet x -> CoursesStudentsGet #
GoogleRequest CoursesStudentsGet Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Students.Get Associated Types type Rs CoursesStudentsGet :: Type # type Scopes CoursesStudentsGet :: [Symbol] # Methods requestClient :: CoursesStudentsGet -> GClient (Rs CoursesStudentsGet) #
type Rep CoursesStudentsGet Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Students.Get type Rep CoursesStudentsGet = D1 (MetaData "CoursesStudentsGet" "Network.Google.Resource.Classroom.Courses.Students.Get" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "CoursesStudentsGet'" PrefixI True) ((S1 (MetaSel (Just "_csgXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_csgUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_csgCourseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :: ((S1 (MetaSel (Just "_csgAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_csgUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_csgUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_csgCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes CoursesStudentsGet Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Students.Get type Scopes CoursesStudentsGet = "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 CoursesStudentsGet Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Students.Get type Rs CoursesStudentsGet = Student

Request Lenses

csgXgafv :: Lens' CoursesStudentsGet (Maybe Xgafv) Source #

V1 error format.

csgUploadProtocol :: Lens' CoursesStudentsGet (Maybe Text) Source #

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

csgCourseId :: Lens' CoursesStudentsGet Text Source #

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

csgAccessToken :: Lens' CoursesStudentsGet (Maybe Text) Source #

OAuth access token.

csgUploadType :: Lens' CoursesStudentsGet (Maybe Text) Source #

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

csgUserId :: Lens' CoursesStudentsGet Text Source #

Identifier of the student to return. 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

csgCallback :: Lens' CoursesStudentsGet (Maybe Text) Source #

JSONP