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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Returns a list of teachers 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.teachers.list.

Synopsis

type CoursesTeachersListResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("teachers" :> (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] ListTeachersResponse)))))))))))
coursesTeachersList :: Text -> CoursesTeachersList
data CoursesTeachersList
ctlXgafv :: Lens' CoursesTeachersList (Maybe Xgafv)
ctlUploadProtocol :: Lens' CoursesTeachersList (Maybe Text)
ctlCourseId :: Lens' CoursesTeachersList Text
ctlAccessToken :: Lens' CoursesTeachersList (Maybe Text)
ctlUploadType :: Lens' CoursesTeachersList (Maybe Text)
ctlPageToken :: Lens' CoursesTeachersList (Maybe Text)
ctlPageSize :: Lens' CoursesTeachersList (Maybe Int32)
ctlCallback :: Lens' CoursesTeachersList (Maybe Text)

REST Resource

type CoursesTeachersListResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("teachers" :> (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] ListTeachersResponse))))))))))) Source #

A resource alias for classroom.courses.teachers.list method which the CoursesTeachersList request conforms to.

Creating a Request

coursesTeachersList Source #

Arguments

:: Text	`ctlCourseId`
-> CoursesTeachersList

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

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

data CoursesTeachersList Source #

Returns a list of teachers 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: coursesTeachersList smart constructor.

Instances

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

Request Lenses

ctlXgafv :: Lens' CoursesTeachersList (Maybe Xgafv) Source #

V1 error format.

ctlUploadProtocol :: Lens' CoursesTeachersList (Maybe Text) Source #

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

ctlCourseId :: Lens' CoursesTeachersList Text Source #

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

ctlAccessToken :: Lens' CoursesTeachersList (Maybe Text) Source #

OAuth access token.

ctlUploadType :: Lens' CoursesTeachersList (Maybe Text) Source #

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

ctlPageToken :: Lens' CoursesTeachersList (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.

ctlPageSize :: Lens' CoursesTeachersList (Maybe Int32) Source #

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

ctlCallback :: Lens' CoursesTeachersList (Maybe Text) Source #

JSONP