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

REST Resource

type CoursesListResource = "v1" :> ("courses" :> (QueryParam "studentId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "teacherId" Text :> (QueryParam "pageToken" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParams "courseStates" Text :> (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
• clAccessToken
• clUploadType
• clTeacherId
• clPageToken
• clPageSize
• clCourseStates
• clCallback

data CoursesList

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: coursesList smart constructor.

Instances

Eq CoursesList

Defined in Network.Google.Resource.Classroom.Courses.List

Methods

(==) :: CoursesList -> CoursesList -> Bool

(/=) :: CoursesList -> CoursesList -> Bool

Data CoursesList

Defined in Network.Google.Resource.Classroom.Courses.List

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CoursesList -> c CoursesList

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CoursesList

toConstr :: CoursesList -> Constr

dataTypeOf :: CoursesList -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CoursesList)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CoursesList)

gmapT :: (forall b. Data b => b -> b) -> CoursesList -> CoursesList

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CoursesList -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CoursesList -> r

gmapQ :: (forall d. Data d => d -> u) -> CoursesList -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CoursesList -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CoursesList -> m CoursesList

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesList -> m CoursesList

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesList -> m CoursesList

Show CoursesList

Defined in Network.Google.Resource.Classroom.Courses.List

Methods

showsPrec :: Int -> CoursesList -> ShowS

show :: CoursesList -> String

showList :: [CoursesList] -> ShowS

Generic CoursesList

Defined in Network.Google.Resource.Classroom.Courses.List

Associated Types

type Rep CoursesList :: Type -> Type

Methods

from :: CoursesList -> Rep CoursesList x

to :: Rep CoursesList x -> CoursesList

GoogleRequest CoursesList

Defined in Network.Google.Resource.Classroom.Courses.List

Associated Types

type Rs CoursesList :: Type

type Scopes CoursesList :: [Symbol]

Methods

requestClient :: CoursesList -> GClient (Rs CoursesList)

type Rep CoursesList

Defined in Network.Google.Resource.Classroom.Courses.List

type Rep CoursesList = D1 (MetaData "CoursesList" "Network.Google.Resource.Classroom.Courses.List" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "CoursesList'" PrefixI True) (((S1 (MetaSel (Just "_clStudentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_clXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv))) :*: (S1 (MetaSel (Just "_clUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_clAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_clUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_clTeacherId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_clPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_clPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: (S1 (MetaSel (Just "_clCourseStates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_clCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

type Scopes CoursesList

Defined in Network.Google.Resource.Classroom.Courses.List

type Scopes CoursesList = "https://www.googleapis.com/auth/classroom.courses" ': ("https://www.googleapis.com/auth/classroom.courses.readonly" ': ([] :: [Symbol]))

type Rs CoursesList

Defined in Network.Google.Resource.Classroom.Courses.List

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

V1 error format.

clUploadProtocol :: Lens' CoursesList (Maybe Text)

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

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

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.

clCourseStates :: Lens' CoursesList [Text]

Restricts returned courses to those in one of the specified states The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.

clCallback :: Lens' CoursesList (Maybe Text)

JSONP