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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Returns course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.

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

Synopsis

type CoursesCourseWorkGetResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("courseWork" :> (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] CourseWork))))))))))
coursesCourseWorkGet :: Text -> Text -> CoursesCourseWorkGet
data CoursesCourseWorkGet
ccwgXgafv :: Lens' CoursesCourseWorkGet (Maybe Xgafv)
ccwgUploadProtocol :: Lens' CoursesCourseWorkGet (Maybe Text)
ccwgCourseId :: Lens' CoursesCourseWorkGet Text
ccwgAccessToken :: Lens' CoursesCourseWorkGet (Maybe Text)
ccwgUploadType :: Lens' CoursesCourseWorkGet (Maybe Text)
ccwgId :: Lens' CoursesCourseWorkGet Text
ccwgCallback :: Lens' CoursesCourseWorkGet (Maybe Text)

REST Resource

type CoursesCourseWorkGetResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("courseWork" :> (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] CourseWork)))))))))) Source #

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

Creating a Request

coursesCourseWorkGet Source #

Arguments

:: Text	`ccwgCourseId`
-> Text	`ccwgId`
-> CoursesCourseWorkGet

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

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

data CoursesCourseWorkGet Source #

Returns course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.

See: coursesCourseWorkGet smart constructor.

Instances

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

Request Lenses

ccwgXgafv :: Lens' CoursesCourseWorkGet (Maybe Xgafv) Source #

V1 error format.

ccwgUploadProtocol :: Lens' CoursesCourseWorkGet (Maybe Text) Source #

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

ccwgCourseId :: Lens' CoursesCourseWorkGet Text Source #

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

ccwgAccessToken :: Lens' CoursesCourseWorkGet (Maybe Text) Source #

OAuth access token.

ccwgUploadType :: Lens' CoursesCourseWorkGet (Maybe Text) Source #

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

ccwgId :: Lens' CoursesCourseWorkGet Text Source #

Identifier of the course work.

ccwgCallback :: Lens' CoursesCourseWorkGet (Maybe Text) Source #

JSONP