Network.Google.Resource.Classroom.Courses.CourseWork.List

Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. 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. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

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

REST Resource

type CoursesCourseWorkListResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("courseWork" :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "orderBy" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParams "courseWorkStates" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListCourseWorkResponse)))))))))))))))

A resource alias for classroom.courses.courseWork.list method which the CoursesCourseWorkList request conforms to.

Creating a Request

coursesCourseWorkList

Arguments

:: Text

ccwlCourseId

-> CoursesCourseWorkList

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

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

• ccwlXgafv
• ccwlUploadProtocol
• ccwlOrderBy
• ccwlPp
• ccwlCourseId
• ccwlAccessToken
• ccwlCourseWorkStates
• ccwlUploadType
• ccwlBearerToken
• ccwlPageToken
• ccwlPageSize
• ccwlCallback

data CoursesCourseWorkList

Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. 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. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

See: coursesCourseWorkList smart constructor.

Instances

Eq CoursesCourseWorkList

Methods

(==) :: CoursesCourseWorkList -> CoursesCourseWorkList -> Bool

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

Data CoursesCourseWorkList

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CoursesCourseWorkList -> c CoursesCourseWorkList

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CoursesCourseWorkList

toConstr :: CoursesCourseWorkList -> Constr

dataTypeOf :: CoursesCourseWorkList -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CoursesCourseWorkList)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CoursesCourseWorkList)

gmapT :: (forall b. Data b => b -> b) -> CoursesCourseWorkList -> CoursesCourseWorkList

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CoursesCourseWorkList -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CoursesCourseWorkList -> r

gmapQ :: (forall d. Data d => d -> u) -> CoursesCourseWorkList -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CoursesCourseWorkList -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CoursesCourseWorkList -> m CoursesCourseWorkList

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesCourseWorkList -> m CoursesCourseWorkList

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesCourseWorkList -> m CoursesCourseWorkList

Show CoursesCourseWorkList

Methods

showsPrec :: Int -> CoursesCourseWorkList -> ShowS

show :: CoursesCourseWorkList -> String

showList :: [CoursesCourseWorkList] -> ShowS

Generic CoursesCourseWorkList

Associated Types

type Rep CoursesCourseWorkList :: * -> *

Methods

from :: CoursesCourseWorkList -> Rep CoursesCourseWorkList x

to :: Rep CoursesCourseWorkList x -> CoursesCourseWorkList

GoogleRequest CoursesCourseWorkList

Associated Types

type Rs CoursesCourseWorkList :: *

type Scopes CoursesCourseWorkList :: [Symbol]

Methods

requestClient :: CoursesCourseWorkList -> Client (Rs CoursesCourseWorkList)

type Rep CoursesCourseWorkList

type Rep CoursesCourseWorkList = D1 (MetaData "CoursesCourseWorkList" "Network.Google.Resource.Classroom.Courses.CourseWork.List" "gogol-classroom-0.1.0-21rh7SRXdL3B6ZyyiLDhlq" False) (C1 (MetaCons "CoursesCourseWorkList'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ccwlXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ccwlUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ccwlOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_ccwlPp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) ((:*:) (S1 (MetaSel (Just Symbol "_ccwlCourseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_ccwlAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ccwlCourseWorkStates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_ccwlUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ccwlBearerToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_ccwlPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ccwlPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))) (S1 (MetaSel (Just Symbol "_ccwlCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))

type Scopes CoursesCourseWorkList

type Scopes CoursesCourseWorkList = (:) Symbol "https://www.googleapis.com/auth/classroom.course-work.readonly" ((:) Symbol "https://www.googleapis.com/auth/classroom.coursework.me" ((:) Symbol "https://www.googleapis.com/auth/classroom.coursework.me.readonly" ((:) Symbol "https://www.googleapis.com/auth/classroom.coursework.students" ((:) Symbol "https://www.googleapis.com/auth/classroom.coursework.students.readonly" ([] Symbol)))))

type Rs CoursesCourseWorkList

type Rs CoursesCourseWorkList = ListCourseWorkResponse

Request Lenses

ccwlXgafv :: Lens' CoursesCourseWorkList (Maybe Text)

V1 error format.

ccwlUploadProtocol :: Lens' CoursesCourseWorkList (Maybe Text)

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

ccwlOrderBy :: Lens' CoursesCourseWorkList (Maybe Text)

Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported fields are `updateTime` and `dueDate`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`

ccwlPp :: Lens' CoursesCourseWorkList Bool

Pretty-print response.

ccwlCourseId :: Lens' CoursesCourseWorkList Text

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

ccwlAccessToken :: Lens' CoursesCourseWorkList (Maybe Text)

OAuth access token.

ccwlCourseWorkStates :: Lens' CoursesCourseWorkList [Text]

Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned.

ccwlUploadType :: Lens' CoursesCourseWorkList (Maybe Text)

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

ccwlBearerToken :: Lens' CoursesCourseWorkList (Maybe Text)

OAuth bearer token.

ccwlPageToken :: Lens' CoursesCourseWorkList (Maybe Text)

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.

ccwlPageSize :: Lens' CoursesCourseWorkList (Maybe Int32)

Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

ccwlCallback :: Lens' CoursesCourseWorkList (Maybe Text)

JSONP