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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teacher or student in the course.

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

Synopsis

type CoursesTeachersCreateResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("teachers" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Teacher :> Post '[JSON] Teacher))))))))))
coursesTeachersCreate :: Text -> Teacher -> CoursesTeachersCreate
data CoursesTeachersCreate
ctcXgafv :: Lens' CoursesTeachersCreate (Maybe Xgafv)
ctcUploadProtocol :: Lens' CoursesTeachersCreate (Maybe Text)
ctcCourseId :: Lens' CoursesTeachersCreate Text
ctcAccessToken :: Lens' CoursesTeachersCreate (Maybe Text)
ctcUploadType :: Lens' CoursesTeachersCreate (Maybe Text)
ctcPayload :: Lens' CoursesTeachersCreate Teacher
ctcCallback :: Lens' CoursesTeachersCreate (Maybe Text)

REST Resource

type CoursesTeachersCreateResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("teachers" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Teacher :> Post '[JSON] Teacher)))))))))) Source #

A resource alias for classroom.courses.teachers.create method which the CoursesTeachersCreate request conforms to.

Creating a Request

coursesTeachersCreate Source #

Arguments

:: Text	`ctcCourseId`
-> Teacher	`ctcPayload`
-> CoursesTeachersCreate

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

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

data CoursesTeachersCreate Source #

Creates a teacher of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. * `NOT_FOUND` if the requested course ID does not exist. * `FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a teacher or student in the course.

See: coursesTeachersCreate smart constructor.

Instances

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

Request Lenses

ctcXgafv :: Lens' CoursesTeachersCreate (Maybe Xgafv) Source #

V1 error format.

ctcUploadProtocol :: Lens' CoursesTeachersCreate (Maybe Text) Source #

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

ctcCourseId :: Lens' CoursesTeachersCreate Text Source #

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

ctcAccessToken :: Lens' CoursesTeachersCreate (Maybe Text) Source #

OAuth access token.

ctcUploadType :: Lens' CoursesTeachersCreate (Maybe Text) Source #

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

ctcPayload :: Lens' CoursesTeachersCreate Teacher Source #

Multipart request metadata.

ctcCallback :: Lens' CoursesTeachersCreate (Maybe Text) Source #

JSONP