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 teachers of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.
See: Google Classroom API Reference for classroom.courses.teachers.list
.
Synopsis
- type CoursesTeachersListResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("teachers" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListTeachersResponse)))))))))))
- coursesTeachersList :: Text -> CoursesTeachersList
- data CoursesTeachersList
- ctlXgafv :: Lens' CoursesTeachersList (Maybe Xgafv)
- ctlUploadProtocol :: Lens' CoursesTeachersList (Maybe Text)
- ctlCourseId :: Lens' CoursesTeachersList Text
- ctlAccessToken :: Lens' CoursesTeachersList (Maybe Text)
- ctlUploadType :: Lens' CoursesTeachersList (Maybe Text)
- ctlPageToken :: Lens' CoursesTeachersList (Maybe Text)
- ctlPageSize :: Lens' CoursesTeachersList (Maybe Int32)
- ctlCallback :: Lens' CoursesTeachersList (Maybe Text)
REST Resource
type CoursesTeachersListResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("teachers" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListTeachersResponse))))))))))) Source #
A resource alias for classroom.courses.teachers.list
method which the
CoursesTeachersList
request conforms to.
Creating a Request
Creates a value of CoursesTeachersList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CoursesTeachersList Source #
Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: * `NOT_FOUND` if the course does not exist. * `PERMISSION_DENIED` for access errors.
See: coursesTeachersList
smart constructor.
Instances
Request Lenses
ctlUploadProtocol :: Lens' CoursesTeachersList (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
ctlCourseId :: Lens' CoursesTeachersList Text Source #
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
ctlAccessToken :: Lens' CoursesTeachersList (Maybe Text) Source #
OAuth access token.
ctlUploadType :: Lens' CoursesTeachersList (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
ctlPageToken :: Lens' CoursesTeachersList (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.
ctlPageSize :: Lens' CoursesTeachersList (Maybe Int32) Source #
Maximum number of items to return. Zero means no maximum. The server may return fewer than the specified number of results.
ctlCallback :: Lens' CoursesTeachersList (Maybe Text) Source #
JSONP