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 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
.
- 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))))))))))))
- coursesStudentsDelete :: Text -> Text -> CoursesStudentsDelete
- data CoursesStudentsDelete
- csdXgafv :: Lens' CoursesStudentsDelete (Maybe Text)
- csdUploadProtocol :: Lens' CoursesStudentsDelete (Maybe Text)
- csdPp :: Lens' CoursesStudentsDelete Bool
- csdCourseId :: Lens' CoursesStudentsDelete Text
- csdAccessToken :: Lens' CoursesStudentsDelete (Maybe Text)
- csdUploadType :: Lens' CoursesStudentsDelete (Maybe Text)
- csdUserId :: Lens' CoursesStudentsDelete Text
- csdBearerToken :: Lens' CoursesStudentsDelete (Maybe Text)
- csdCallback :: Lens' CoursesStudentsDelete (Maybe Text)
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)))))))))))) Source #
A resource alias for classroom.courses.students.delete
method which the
CoursesStudentsDelete
request conforms to.
Creating a Request
coursesStudentsDelete Source #
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:
data CoursesStudentsDelete Source #
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.
Request Lenses
csdUploadProtocol :: Lens' CoursesStudentsDelete (Maybe Text) Source #
Upload protocol for media (e.g. "raw", "multipart").
csdCourseId :: Lens' CoursesStudentsDelete Text Source #
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.
csdAccessToken :: Lens' CoursesStudentsDelete (Maybe Text) Source #
OAuth access token.
csdUploadType :: Lens' CoursesStudentsDelete (Maybe Text) Source #
Legacy upload protocol for media (e.g. "media", "multipart").
csdUserId :: Lens' CoursesStudentsDelete Text Source #
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) Source #
OAuth bearer token.
csdCallback :: Lens' CoursesStudentsDelete (Maybe Text) Source #
JSONP