gogol-classroom-0.4.0: Google Classroom SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.Classroom.Courses.Teachers.Delete

Contents

Description

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

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

Synopsis

REST Resource

type CoursesTeachersDeleteResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("teachers" :> (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.teachers.delete method which the CoursesTeachersDelete request conforms to.

Creating a Request

coursesTeachersDelete Source #

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

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

data CoursesTeachersDelete Source #

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

See: coursesTeachersDelete smart constructor.

Instances
Eq CoursesTeachersDelete Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Teachers.Delete

Data CoursesTeachersDelete Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Teachers.Delete

Methods

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

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

toConstr :: CoursesTeachersDelete -> Constr #

dataTypeOf :: CoursesTeachersDelete -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> CoursesTeachersDelete -> CoursesTeachersDelete #

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

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

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

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

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

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

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

Show CoursesTeachersDelete Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Teachers.Delete

Generic CoursesTeachersDelete Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Teachers.Delete

Associated Types

type Rep CoursesTeachersDelete :: Type -> Type #

GoogleRequest CoursesTeachersDelete Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Teachers.Delete

type Rep CoursesTeachersDelete Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Teachers.Delete

type Rep CoursesTeachersDelete = D1 (MetaData "CoursesTeachersDelete" "Network.Google.Resource.Classroom.Courses.Teachers.Delete" "gogol-classroom-0.4.0-8aa8kYGMMJyCKn01TYMpOR" False) (C1 (MetaCons "CoursesTeachersDelete'" PrefixI True) ((S1 (MetaSel (Just "_ctdXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_ctdUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ctdCourseId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :*: ((S1 (MetaSel (Just "_ctdAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ctdUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_ctdUserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_ctdCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes CoursesTeachersDelete Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Teachers.Delete

type Scopes CoursesTeachersDelete = "https://www.googleapis.com/auth/classroom.rosters" ': ([] :: [Symbol])
type Rs CoursesTeachersDelete Source # 
Instance details

Defined in Network.Google.Resource.Classroom.Courses.Teachers.Delete

Request Lenses

ctdUploadProtocol :: Lens' CoursesTeachersDelete (Maybe Text) Source #

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

ctdCourseId :: Lens' CoursesTeachersDelete Text Source #

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

ctdUploadType :: Lens' CoursesTeachersDelete (Maybe Text) Source #

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

ctdUserId :: Lens' CoursesTeachersDelete Text Source #

Identifier of the teacher 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