Network.Google.Resource.Classroom.Courses.Get

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.

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))))))))))

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

Creating a Request

coursesGet

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:

• cgXgafv
• cgUploadProtocol
• cgPp
• cgAccessToken
• cgUploadType
• cgBearerToken
• cgId
• cgCallback

data CoursesGet

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

Methods

(==) :: CoursesGet -> CoursesGet -> Bool

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

Data CoursesGet

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

Methods

showsPrec :: Int -> CoursesGet -> ShowS

show :: CoursesGet -> String

showList :: [CoursesGet] -> ShowS

Generic CoursesGet

Associated Types

type Rep CoursesGet :: * -> *

Methods

from :: CoursesGet -> Rep CoursesGet x

to :: Rep CoursesGet x -> CoursesGet

GoogleRequest CoursesGet

Associated Types

type Rs CoursesGet :: *

type Scopes CoursesGet :: [Symbol]

Methods

requestClient :: CoursesGet -> Client (Rs CoursesGet)

type Rep CoursesGet

type Rep CoursesGet = D1 (MetaData "CoursesGet" "Network.Google.Resource.Classroom.Courses.Get" "gogol-classroom-0.1.0-21rh7SRXdL3B6ZyyiLDhlq" False) (C1 (MetaCons "CoursesGet'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cgXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cgUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_cgPp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "_cgAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cgUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cgBearerToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_cgId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cgCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

type Scopes CoursesGet

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

type Rs CoursesGet

type Rs CoursesGet = Course

Request Lenses

cgXgafv :: Lens' CoursesGet (Maybe Text)

V1 error format.

cgUploadProtocol :: Lens' CoursesGet (Maybe Text)

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

cgPp :: Lens' CoursesGet Bool

Pretty-print response.

cgAccessToken :: Lens' CoursesGet (Maybe Text)

OAuth access token.

cgUploadType :: Lens' CoursesGet (Maybe Text)

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

cgBearerToken :: Lens' CoursesGet (Maybe Text)

OAuth bearer token.

cgId :: Lens' CoursesGet Text

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

cgCallback :: Lens' CoursesGet (Maybe Text)

JSONP