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

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.

REST Resource

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

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

Creating a Request

coursesStudentsDelete

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:

• csdXgafv
• csdUploadProtocol
• csdPp
• csdCourseId
• csdAccessToken
• csdUploadType
• csdUserId
• csdBearerToken
• csdCallback

data CoursesStudentsDelete

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

Methods

(==) :: CoursesStudentsDelete -> CoursesStudentsDelete -> Bool

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

Data CoursesStudentsDelete

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

Methods

showsPrec :: Int -> CoursesStudentsDelete -> ShowS

show :: CoursesStudentsDelete -> String

showList :: [CoursesStudentsDelete] -> ShowS

Generic CoursesStudentsDelete

Associated Types

type Rep CoursesStudentsDelete :: * -> *

Methods

from :: CoursesStudentsDelete -> Rep CoursesStudentsDelete x

to :: Rep CoursesStudentsDelete x -> CoursesStudentsDelete

GoogleRequest CoursesStudentsDelete

Associated Types

type Rs CoursesStudentsDelete :: *

type Scopes CoursesStudentsDelete :: [Symbol]

Methods

requestClient :: CoursesStudentsDelete -> Client (Rs CoursesStudentsDelete)

type Rep CoursesStudentsDelete

type Rep CoursesStudentsDelete = D1 (MetaData "CoursesStudentsDelete" "Network.Google.Resource.Classroom.Courses.Students.Delete" "gogol-classroom-0.1.0-21rh7SRXdL3B6ZyyiLDhlq" False) (C1 (MetaCons "CoursesStudentsDelete'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_csdXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_csdUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_csdPp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "_csdCourseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_csdAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_csdUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_csdUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_csdBearerToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_csdCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))

type Scopes CoursesStudentsDelete

type Scopes CoursesStudentsDelete = (:) Symbol "https://www.googleapis.com/auth/classroom.rosters" ([] Symbol)

type Rs CoursesStudentsDelete

type Rs CoursesStudentsDelete = Empty

Request Lenses

csdXgafv :: Lens' CoursesStudentsDelete (Maybe Text)

V1 error format.

csdUploadProtocol :: Lens' CoursesStudentsDelete (Maybe Text)

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

csdPp :: Lens' CoursesStudentsDelete Bool

Pretty-print response.

csdCourseId :: Lens' CoursesStudentsDelete Text

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

csdAccessToken :: Lens' CoursesStudentsDelete (Maybe Text)

OAuth access token.

csdUploadType :: Lens' CoursesStudentsDelete (Maybe Text)

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

csdUserId :: Lens' CoursesStudentsDelete Text

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

csdBearerToken :: Lens' CoursesStudentsDelete (Maybe Text)

OAuth bearer token.

csdCallback :: Lens' CoursesStudentsDelete (Maybe Text)

JSONP