gogol-classroom-0.1.0: Google Classroom SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Classroom.Courses.Get

Contents

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

REST Resource

type CoursesGetResource = "v1" :> ("courses" :> (Capture "id" 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] 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 # 
Data CoursesGet Source # 

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 # 
Generic CoursesGet Source # 

Associated Types

type Rep CoursesGet :: * -> * #

GoogleRequest CoursesGet Source # 

Associated Types

type Rs CoursesGet :: * #

type Scopes CoursesGet :: [Symbol] #

type Rep CoursesGet Source # 
type Scopes CoursesGet Source # 
type Scopes CoursesGet = (:) Symbol "https://www.googleapis.com/auth/classroom.courses" ((:) Symbol "https://www.googleapis.com/auth/classroom.courses.readonly" ([] Symbol))
type Rs CoursesGet Source # 

Request Lenses

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

V1 error format.

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

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

cgPp :: Lens' CoursesGet Bool Source #

Pretty-print response.

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

OAuth access token.

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

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

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

OAuth bearer token.

cgId :: Lens' CoursesGet Text Source #

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