Network.Google.Resource.Classroom.Courses.Students.Delete

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.

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))))))))))))

A resource alias for classroom.courses.students.delete method which the CoursesStudentsDelete request conforms to.

Creating a Request

coursesStudentsDelete

Arguments

:: Text

csdCourseId

-> Text

csdUserId

-> CoursesStudentsDelete

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:

• csdXgafv
• csdUploadProtocol
• csdPp
• csdCourseId
• csdAccessToken
• csdUploadType
• csdUserId
• csdBearerToken
• csdCallback

data CoursesStudentsDelete

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.

Instances

Eq CoursesStudentsDelete

Data CoursesStudentsDelete

Show CoursesStudentsDelete

Generic CoursesStudentsDelete

GoogleRequest CoursesStudentsDelete

type Rep CoursesStudentsDelete

type Rs CoursesStudentsDelete = Empty

Request Lenses

csdXgafv :: Lens' CoursesStudentsDelete (Maybe Text)

V1 error format.

csdUploadProtocol :: Lens' CoursesStudentsDelete (Maybe Text)

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

csdPp :: Lens' CoursesStudentsDelete Bool

Pretty-print response.

csdCourseId :: Lens' CoursesStudentsDelete Text

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

csdAccessToken :: Lens' CoursesStudentsDelete (Maybe Text)

OAuth access token.

csdUploadType :: Lens' CoursesStudentsDelete (Maybe Text)

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

csdUserId :: Lens' CoursesStudentsDelete Text

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)

OAuth bearer token.

csdCallback :: Lens' CoursesStudentsDelete (Maybe Text)

JSONP