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 courses that the requesting user is permitted to view, restricted to those that match the request. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.
See: Google Classroom API Reference for classroom.courses.list
.
- type CoursesListResource = "v1" :> ("courses" :> (QueryParam "studentId" Text :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "teacherId" Text :> (QueryParam "bearer_token" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListCoursesResponse)))))))))))))
- coursesList :: CoursesList
- data CoursesList
- clStudentId :: Lens' CoursesList (Maybe Text)
- clXgafv :: Lens' CoursesList (Maybe Text)
- clUploadProtocol :: Lens' CoursesList (Maybe Text)
- clPp :: Lens' CoursesList Bool
- clAccessToken :: Lens' CoursesList (Maybe Text)
- clUploadType :: Lens' CoursesList (Maybe Text)
- clTeacherId :: Lens' CoursesList (Maybe Text)
- clBearerToken :: Lens' CoursesList (Maybe Text)
- clPageToken :: Lens' CoursesList (Maybe Text)
- clPageSize :: Lens' CoursesList (Maybe Int32)
- clCallback :: Lens' CoursesList (Maybe Text)
REST Resource
type CoursesListResource = "v1" :> ("courses" :> (QueryParam "studentId" Text :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "teacherId" Text :> (QueryParam "bearer_token" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListCoursesResponse))))))))))))) Source #
A resource alias for classroom.courses.list
method which the
CoursesList
request conforms to.
Creating a Request
coursesList :: CoursesList Source #
Creates a value of CoursesList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CoursesList Source #
Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any users specified in the query arguments do not exist.
See: coursesList
smart constructor.
Request Lenses
clStudentId :: Lens' CoursesList (Maybe Text) Source #
Restricts returned courses to those having a student with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
clUploadProtocol :: Lens' CoursesList (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
clAccessToken :: Lens' CoursesList (Maybe Text) Source #
OAuth access token.
clUploadType :: Lens' CoursesList (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
clTeacherId :: Lens' CoursesList (Maybe Text) Source #
Restricts returned courses to those having a teacher with the specified identifier. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user
clBearerToken :: Lens' CoursesList (Maybe Text) Source #
OAuth bearer token.
clPageToken :: Lens' CoursesList (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.
clPageSize :: Lens' CoursesList (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.
clCallback :: Lens' CoursesList (Maybe Text) Source #
JSONP