Network.Google.Resource.Classroom.Courses.List

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.

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)))))))))))))

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

Creating a Request

coursesList :: CoursesList

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:

• clStudentId
• clXgafv
• clUploadProtocol
• clPp
• clAccessToken
• clUploadType
• clTeacherId
• clBearerToken
• clPageToken
• clPageSize
• clCallback

data CoursesList

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.

Instances

Eq CoursesList

Data CoursesList

Show CoursesList

Generic CoursesList

GoogleRequest CoursesList

type Rep CoursesList

type Rs CoursesList = ListCoursesResponse

Request Lenses

clStudentId :: Lens' CoursesList (Maybe Text)

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

clXgafv :: Lens' CoursesList (Maybe Text)

V1 error format.

clUploadProtocol :: Lens' CoursesList (Maybe Text)

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

clPp :: Lens' CoursesList Bool

Pretty-print response.

clAccessToken :: Lens' CoursesList (Maybe Text)

OAuth access token.

clUploadType :: Lens' CoursesList (Maybe Text)

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

clTeacherId :: Lens' CoursesList (Maybe Text)

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)

OAuth bearer token.

clPageToken :: Lens' CoursesList (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.

clPageSize :: Lens' CoursesList (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.

clCallback :: Lens' CoursesList (Maybe Text)

JSONP