Copyright	(c) 2015-2025 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <[email protected]> Toni Cebrián <[email protected]>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	GHC2021

Gogol.Classroom.Courses.List

Contents

Resource
- Constructing a Request

Description

Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. 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.

Synopsis

type ClassroomCoursesListResource = "v1" :> ("courses" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParams "courseStates" CoursesListCourseStates :> (QueryParam "pageSize" Int32 :> (QueryParam "pageToken" Text :> (QueryParam "studentId" Text :> (QueryParam "teacherId" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListCoursesResponse))))))))))))
data ClassroomCoursesList = ClassroomCoursesList {
- xgafv :: Maybe Xgafv
- accessToken :: Maybe Text
- callback :: Maybe Text
- courseStates :: Maybe [CoursesListCourseStates]
- pageSize :: Maybe Int32
- pageToken :: Maybe Text
- studentId :: Maybe Text
- teacherId :: Maybe Text
- uploadType :: Maybe Text
- uploadProtocol :: Maybe Text
}
newClassroomCoursesList :: ClassroomCoursesList

Resource

type ClassroomCoursesListResource = "v1" :> ("courses" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParams "courseStates" CoursesListCourseStates :> (QueryParam "pageSize" Int32 :> (QueryParam "pageToken" Text :> (QueryParam "studentId" Text :> (QueryParam "teacherId" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListCoursesResponse)))))))))))) Source #

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

Constructing a Request

data ClassroomCoursesList Source #

Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. 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: newClassroomCoursesList smart constructor.

Constructors

ClassroomCoursesList

Fields

xgafv :: Maybe Xgafv
V1 error format.
accessToken :: Maybe Text
OAuth access token.
callback :: Maybe Text
JSONP
courseStates :: Maybe [CoursesListCourseStates]
Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
pageSize :: 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.
pageToken :: 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.
studentId :: 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
teacherId :: 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
uploadType :: Maybe Text
Legacy upload protocol for media (e.g. "media", "multipart").
uploadProtocol :: Maybe Text
Upload protocol for media (e.g. "raw", "multipart").

Instances

Instances details

Generic ClassroomCoursesList Source #

Instance details

Defined in Gogol.Classroom.Courses.List

Associated Types

type Rep ClassroomCoursesList

Instance details

Defined in Gogol.Classroom.Courses.List

Methods

from :: ClassroomCoursesList -> Rep ClassroomCoursesList x #

to :: Rep ClassroomCoursesList x -> ClassroomCoursesList #

Show ClassroomCoursesList Source #

Instance details

Defined in Gogol.Classroom.Courses.List

Methods

showsPrec :: Int -> ClassroomCoursesList -> ShowS #

show :: ClassroomCoursesList -> String #

showList :: [ClassroomCoursesList] -> ShowS #

Eq ClassroomCoursesList Source #

Instance details

Defined in Gogol.Classroom.Courses.List

Methods

(==) :: ClassroomCoursesList -> ClassroomCoursesList -> Bool #

(/=) :: ClassroomCoursesList -> ClassroomCoursesList -> Bool #

GoogleRequest ClassroomCoursesList Source #

Instance details

Defined in Gogol.Classroom.Courses.List

Associated Types

type Rs ClassroomCoursesList
Instance details Defined in Gogol.Classroom.Courses.List type Rs ClassroomCoursesList = ListCoursesResponse
type Scopes ClassroomCoursesList
Instance details Defined in Gogol.Classroom.Courses.List type Scopes ClassroomCoursesList = '[Classroom'Courses, Classroom'Courses'Readonly]

Methods

requestClient :: ClassroomCoursesList -> GClient (Rs ClassroomCoursesList) #

type Rep ClassroomCoursesList Source #

Instance details

Defined in Gogol.Classroom.Courses.List

type Rs ClassroomCoursesList Source #

Instance details

Defined in Gogol.Classroom.Courses.List

type Rs ClassroomCoursesList = ListCoursesResponse

type Scopes ClassroomCoursesList Source #

Instance details

Defined in Gogol.Classroom.Courses.List

type Scopes ClassroomCoursesList = '[Classroom'Courses, Classroom'Courses'Readonly]

newClassroomCoursesList :: ClassroomCoursesList Source #

Creates a value of ClassroomCoursesList with the minimum fields required to make a request.