gogol-classroom-0.0.1: Google Classroom SDK.

Copyright(c) 2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Classroom.Courses.Teachers.List

Contents

Description

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

REST Resource

type CoursesTeachersListResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("teachers" :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" 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

coursesTeachersList Source

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.

Request Lenses

ctlUploadProtocol :: Lens' CoursesTeachersList (Maybe Text) Source

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

ctlPp :: Lens' CoursesTeachersList Bool Source

Pretty-print response.

ctlCourseId :: Lens' CoursesTeachersList Text Source

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

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.