Network.Google.Resource.Classroom.Courses.Students.Get

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.

REST Resource

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

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

Creating a Request

coursesStudentsGet

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:

• csgXgafv
• csgUploadProtocol
• csgPp
• csgCourseId
• csgAccessToken
• csgUploadType
• csgUserId
• csgBearerToken
• csgCallback

data CoursesStudentsGet

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

Methods

(==) :: CoursesStudentsGet -> CoursesStudentsGet -> Bool

(/=) :: CoursesStudentsGet -> CoursesStudentsGet -> Bool

Data CoursesStudentsGet

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

Methods

showsPrec :: Int -> CoursesStudentsGet -> ShowS

show :: CoursesStudentsGet -> String

showList :: [CoursesStudentsGet] -> ShowS

Generic CoursesStudentsGet

Associated Types

type Rep CoursesStudentsGet :: * -> *

Methods

from :: CoursesStudentsGet -> Rep CoursesStudentsGet x

to :: Rep CoursesStudentsGet x -> CoursesStudentsGet

GoogleRequest CoursesStudentsGet

Associated Types

type Rs CoursesStudentsGet :: *

type Scopes CoursesStudentsGet :: [Symbol]

Methods

requestClient :: CoursesStudentsGet -> Client (Rs CoursesStudentsGet)

type Rep CoursesStudentsGet

type Rep CoursesStudentsGet = D1 (MetaData "CoursesStudentsGet" "Network.Google.Resource.Classroom.Courses.Students.Get" "gogol-classroom-0.3.0-Euho0DOVp7IFBMFcN4kr1b" False) (C1 (MetaCons "CoursesStudentsGet'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_csgXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_csgUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_csgPp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "_csgCourseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_csgAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_csgUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_csgUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_csgBearerToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_csgCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))

type Scopes CoursesStudentsGet

type Scopes CoursesStudentsGet = (:) Symbol "https://www.googleapis.com/auth/classroom.profile.emails" ((:) Symbol "https://www.googleapis.com/auth/classroom.profile.photos" ((:) Symbol "https://www.googleapis.com/auth/classroom.rosters" ((:) Symbol "https://www.googleapis.com/auth/classroom.rosters.readonly" ([] Symbol))))

type Rs CoursesStudentsGet

type Rs CoursesStudentsGet = Student

Request Lenses

csgXgafv :: Lens' CoursesStudentsGet (Maybe Text)

V1 error format.

csgUploadProtocol :: Lens' CoursesStudentsGet (Maybe Text)

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

csgPp :: Lens' CoursesStudentsGet Bool

Pretty-print response.

csgCourseId :: Lens' CoursesStudentsGet Text

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

csgAccessToken :: Lens' CoursesStudentsGet (Maybe Text)

OAuth access token.

csgUploadType :: Lens' CoursesStudentsGet (Maybe Text)

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

csgUserId :: Lens' CoursesStudentsGet Text

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

csgBearerToken :: Lens' CoursesStudentsGet (Maybe Text)

OAuth bearer token.

csgCallback :: Lens' CoursesStudentsGet (Maybe Text)

JSONP