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 |
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
.
Synopsis
- type CoursesCourseWorkListResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("courseWork" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "orderBy" Text :> (QueryParam "access_token" Text :> (QueryParams "courseWorkStates" Text :> (QueryParam "uploadType" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListCourseWorkResponse)))))))))))))
- coursesCourseWorkList :: Text -> CoursesCourseWorkList
- data CoursesCourseWorkList
- ccwlXgafv :: Lens' CoursesCourseWorkList (Maybe Xgafv)
- ccwlUploadProtocol :: Lens' CoursesCourseWorkList (Maybe Text)
- ccwlOrderBy :: Lens' CoursesCourseWorkList (Maybe Text)
- ccwlCourseId :: Lens' CoursesCourseWorkList Text
- ccwlAccessToken :: Lens' CoursesCourseWorkList (Maybe Text)
- ccwlCourseWorkStates :: Lens' CoursesCourseWorkList [Text]
- ccwlUploadType :: Lens' CoursesCourseWorkList (Maybe Text)
- ccwlPageToken :: Lens' CoursesCourseWorkList (Maybe Text)
- ccwlPageSize :: Lens' CoursesCourseWorkList (Maybe Int32)
- ccwlCallback :: Lens' CoursesCourseWorkList (Maybe Text)
REST Resource
type CoursesCourseWorkListResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("courseWork" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "orderBy" Text :> (QueryParam "access_token" Text :> (QueryParams "courseWorkStates" Text :> (QueryParam "uploadType" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListCourseWorkResponse))))))))))))) Source #
A resource alias for classroom.courses.courseWork.list
method which the
CoursesCourseWorkList
request conforms to.
Creating a Request
coursesCourseWorkList Source #
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:
data CoursesCourseWorkList Source #
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
Request Lenses
ccwlUploadProtocol :: Lens' CoursesCourseWorkList (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
ccwlOrderBy :: Lens' CoursesCourseWorkList (Maybe Text) Source #
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`
ccwlCourseId :: Lens' CoursesCourseWorkList Text Source #
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
ccwlAccessToken :: Lens' CoursesCourseWorkList (Maybe Text) Source #
OAuth access token.
ccwlCourseWorkStates :: Lens' CoursesCourseWorkList [Text] Source #
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) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
ccwlPageToken :: Lens' CoursesCourseWorkList (Maybe Text) Source #
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) Source #
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) Source #
JSONP