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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.

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

Synopsis

type CoursesGetResource = "v1" :> ("courses" :> (Capture "id" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Course))))))))
coursesGet :: Text -> CoursesGet
data CoursesGet
cgXgafv :: Lens' CoursesGet (Maybe Xgafv)
cgUploadProtocol :: Lens' CoursesGet (Maybe Text)
cgAccessToken :: Lens' CoursesGet (Maybe Text)
cgUploadType :: Lens' CoursesGet (Maybe Text)
cgId :: Lens' CoursesGet Text
cgCallback :: Lens' CoursesGet (Maybe Text)

REST Resource

type CoursesGetResource = "v1" :> ("courses" :> (Capture "id" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Course)))))))) Source #

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

Creating a Request

coursesGet Source #

Arguments

:: Text	`cgId`
-> CoursesGet

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

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

data CoursesGet Source #

Returns a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `NOT_FOUND` if no course exists with the requested ID.

See: coursesGet smart constructor.

Instances

Eq CoursesGet Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Get Methods (==) :: CoursesGet -> CoursesGet -> Bool # (/=) :: CoursesGet -> CoursesGet -> Bool #
Data CoursesGet Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Get Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CoursesGet -> c CoursesGet # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CoursesGet # toConstr :: CoursesGet -> Constr # dataTypeOf :: CoursesGet -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CoursesGet) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CoursesGet) # gmapT :: (forall b. Data b => b -> b) -> CoursesGet -> CoursesGet # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CoursesGet -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CoursesGet -> r # gmapQ :: (forall d. Data d => d -> u) -> CoursesGet -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CoursesGet -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CoursesGet -> m CoursesGet # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesGet -> m CoursesGet # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesGet -> m CoursesGet #
Show CoursesGet Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Get Methods showsPrec :: Int -> CoursesGet -> ShowS # show :: CoursesGet -> String # showList :: [CoursesGet] -> ShowS #
Generic CoursesGet Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Get Associated Types type Rep CoursesGet :: Type -> Type # Methods from :: CoursesGet -> Rep CoursesGet x # to :: Rep CoursesGet x -> CoursesGet #
GoogleRequest CoursesGet Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Get Associated Types type Rs CoursesGet :: Type # type Scopes CoursesGet :: [Symbol] # Methods requestClient :: CoursesGet -> GClient (Rs CoursesGet) #
type Rep CoursesGet Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Get type Rep CoursesGet = D1 (MetaData "CoursesGet" "Network.Google.Resource.Classroom.Courses.Get" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "CoursesGet'" PrefixI True) ((S1 (MetaSel (Just "_cgXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_cgUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_cgAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 (MetaSel (Just "_cgUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_cgId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_cgCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes CoursesGet Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Get type Scopes CoursesGet = "https://www.googleapis.com/auth/classroom.courses" ': ("https://www.googleapis.com/auth/classroom.courses.readonly" ': ([] :: [Symbol]))
type Rs CoursesGet Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Get type Rs CoursesGet = Course

Request Lenses

cgXgafv :: Lens' CoursesGet (Maybe Xgafv) Source #

V1 error format.

cgUploadProtocol :: Lens' CoursesGet (Maybe Text) Source #

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

cgAccessToken :: Lens' CoursesGet (Maybe Text) Source #

OAuth access token.

cgUploadType :: Lens' CoursesGet (Maybe Text) Source #

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

cgId :: Lens' CoursesGet Text Source #

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

cgCallback :: Lens' CoursesGet (Maybe Text) Source #

JSONP