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

Network.Google.Resource.Classroom.Courses.Students.Delete

Contents

REST Resource
Creating a Request
Request Lenses

Description

Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.

See: Google Classroom API Reference for classroom.courses.students.delete.

Synopsis

type CoursesStudentsDeleteResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("students" :> (Capture "userId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Delete '[JSON] Empty))))))))))
coursesStudentsDelete :: Text -> Text -> CoursesStudentsDelete
data CoursesStudentsDelete
csdXgafv :: Lens' CoursesStudentsDelete (Maybe Xgafv)
csdUploadProtocol :: Lens' CoursesStudentsDelete (Maybe Text)
csdCourseId :: Lens' CoursesStudentsDelete Text
csdAccessToken :: Lens' CoursesStudentsDelete (Maybe Text)
csdUploadType :: Lens' CoursesStudentsDelete (Maybe Text)
csdUserId :: Lens' CoursesStudentsDelete Text
csdCallback :: Lens' CoursesStudentsDelete (Maybe Text)

REST Resource

type CoursesStudentsDeleteResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("students" :> (Capture "userId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Delete '[JSON] Empty)))))))))) Source #

A resource alias for classroom.courses.students.delete method which the CoursesStudentsDelete request conforms to.

Creating a Request

coursesStudentsDelete Source #

Arguments

:: Text	`csdCourseId`
-> Text	`csdUserId`
-> CoursesStudentsDelete

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

Use one of the following lenses to modify other fields as desired:

data CoursesStudentsDelete Source #

Deletes a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course or for access errors. * `NOT_FOUND` if no student of this course has the requested ID or if the course does not exist.

See: coursesStudentsDelete smart constructor.

Instances

Eq CoursesStudentsDelete Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Students.Delete Methods (==) :: CoursesStudentsDelete -> CoursesStudentsDelete -> Bool # (/=) :: CoursesStudentsDelete -> CoursesStudentsDelete -> Bool #
Data CoursesStudentsDelete Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Students.Delete Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CoursesStudentsDelete -> c CoursesStudentsDelete # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CoursesStudentsDelete # toConstr :: CoursesStudentsDelete -> Constr # dataTypeOf :: CoursesStudentsDelete -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CoursesStudentsDelete) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CoursesStudentsDelete) # gmapT :: (forall b. Data b => b -> b) -> CoursesStudentsDelete -> CoursesStudentsDelete # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CoursesStudentsDelete -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CoursesStudentsDelete -> r # gmapQ :: (forall d. Data d => d -> u) -> CoursesStudentsDelete -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CoursesStudentsDelete -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CoursesStudentsDelete -> m CoursesStudentsDelete # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesStudentsDelete -> m CoursesStudentsDelete # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CoursesStudentsDelete -> m CoursesStudentsDelete #
Show CoursesStudentsDelete Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Students.Delete Methods showsPrec :: Int -> CoursesStudentsDelete -> ShowS # show :: CoursesStudentsDelete -> String # showList :: [CoursesStudentsDelete] -> ShowS #
Generic CoursesStudentsDelete Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Students.Delete Associated Types type Rep CoursesStudentsDelete :: Type -> Type # Methods from :: CoursesStudentsDelete -> Rep CoursesStudentsDelete x # to :: Rep CoursesStudentsDelete x -> CoursesStudentsDelete #
GoogleRequest CoursesStudentsDelete Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Students.Delete Associated Types type Rs CoursesStudentsDelete :: Type # type Scopes CoursesStudentsDelete :: [Symbol] # Methods requestClient :: CoursesStudentsDelete -> GClient (Rs CoursesStudentsDelete) #
type Rep CoursesStudentsDelete Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Students.Delete type Rep CoursesStudentsDelete = D1 (MetaData "CoursesStudentsDelete" "Network.Google.Resource.Classroom.Courses.Students.Delete" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "CoursesStudentsDelete'" PrefixI True) ((S1 (MetaSel (Just "_csdXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_csdUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_csdCourseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :: ((S1 (MetaSel (Just "_csdAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_csdUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_csdUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_csdCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes CoursesStudentsDelete Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Students.Delete type Scopes CoursesStudentsDelete = "https://www.googleapis.com/auth/classroom.rosters" ': ([] :: [Symbol])
type Rs CoursesStudentsDelete Source #
Instance details Defined in Network.Google.Resource.Classroom.Courses.Students.Delete type Rs CoursesStudentsDelete = Empty

Request Lenses

csdXgafv :: Lens' CoursesStudentsDelete (Maybe Xgafv) Source #

V1 error format.

csdUploadProtocol :: Lens' CoursesStudentsDelete (Maybe Text) Source #

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

csdCourseId :: Lens' CoursesStudentsDelete Text Source #

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

csdAccessToken :: Lens' CoursesStudentsDelete (Maybe Text) Source #

OAuth access token.

csdUploadType :: Lens' CoursesStudentsDelete (Maybe Text) Source #

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

csdUserId :: Lens' CoursesStudentsDelete Text Source #

Identifier of the student to delete. 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

csdCallback :: Lens' CoursesStudentsDelete (Maybe Text) Source #

JSONP