| Copyright | (c) 2015 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
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.
- type CoursesTeachersCreateResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("teachers" :> (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 :> (ReqBody `[JSON]` Teacher :> Post `[JSON]` Teacher))))))))))))
- coursesTeachersCreate :: Text -> Teacher -> CoursesTeachersCreate
- data CoursesTeachersCreate
- ctcXgafv :: Lens' CoursesTeachersCreate (Maybe Text)
- ctcUploadProtocol :: Lens' CoursesTeachersCreate (Maybe Text)
- ctcPp :: Lens' CoursesTeachersCreate Bool
- ctcCourseId :: Lens' CoursesTeachersCreate Text
- ctcAccessToken :: Lens' CoursesTeachersCreate (Maybe Text)
- ctcUploadType :: Lens' CoursesTeachersCreate (Maybe Text)
- ctcPayload :: Lens' CoursesTeachersCreate Teacher
- ctcBearerToken :: Lens' CoursesTeachersCreate (Maybe Text)
- ctcCallback :: Lens' CoursesTeachersCreate (Maybe Text)
REST Resource
type CoursesTeachersCreateResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("teachers" :> (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 :> (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
Arguments
| :: Text | |
| -> Teacher | |
| -> 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.
Request Lenses
ctcUploadProtocol :: Lens' CoursesTeachersCreate (Maybe Text) Source
Upload protocol for media (e.g. "raw", "multipart").
ctcPp :: Lens' CoursesTeachersCreate Bool Source
Pretty-print response.
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.
ctcBearerToken :: Lens' CoursesTeachersCreate (Maybe Text) Source
OAuth bearer token.
ctcCallback :: Lens' CoursesTeachersCreate (Maybe Text) Source
JSONP