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 |
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
- 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))))))))))
- coursesTeachersDelete :: Text -> Text -> CoursesTeachersDelete
- data CoursesTeachersDelete
- ctdXgafv :: Lens' CoursesTeachersDelete (Maybe Xgafv)
- ctdUploadProtocol :: Lens' CoursesTeachersDelete (Maybe Text)
- ctdCourseId :: Lens' CoursesTeachersDelete Text
- ctdAccessToken :: Lens' CoursesTeachersDelete (Maybe Text)
- ctdUploadType :: Lens' CoursesTeachersDelete (Maybe Text)
- ctdUserId :: Lens' CoursesTeachersDelete Text
- ctdCallback :: Lens' CoursesTeachersDelete (Maybe Text)
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
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.
ctdAccessToken :: Lens' CoursesTeachersDelete (Maybe Text) Source #
OAuth access token.
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
ctdCallback :: Lens' CoursesTeachersDelete (Maybe Text) Source #
JSONP