Network.Google.Resource.Classroom.Courses.Students.Create

Adds a user as a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students 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 * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course.

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

REST Resource

type CoursesStudentsCreateResource = "v1" :> ("courses" :> (Capture "courseId" Text :> ("students" :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "enrollmentCode" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody `[JSON]` Student :> Post `[JSON]` Student)))))))))))))

A resource alias for classroom.courses.students.create method which the CoursesStudentsCreate request conforms to.

Creating a Request

coursesStudentsCreate

Arguments

:: Text

cscCourseId

-> Student

cscPayload

-> CoursesStudentsCreate

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

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

• cscXgafv
• cscUploadProtocol
• cscPp
• cscCourseId
• cscAccessToken
• cscUploadType
• cscPayload
• cscEnrollmentCode
• cscBearerToken
• cscCallback

data CoursesStudentsCreate

Adds a user as a student of a course. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create students 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 * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a student or teacher in the course.

See: coursesStudentsCreate smart constructor.

Instances

Eq CoursesStudentsCreate

Data CoursesStudentsCreate

Show CoursesStudentsCreate

Generic CoursesStudentsCreate

GoogleRequest CoursesStudentsCreate

type Rep CoursesStudentsCreate

type Rs CoursesStudentsCreate = Student

Request Lenses

cscXgafv :: Lens' CoursesStudentsCreate (Maybe Text)

V1 error format.

cscUploadProtocol :: Lens' CoursesStudentsCreate (Maybe Text)

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

cscPp :: Lens' CoursesStudentsCreate Bool

Pretty-print response.

cscCourseId :: Lens' CoursesStudentsCreate Text

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

cscAccessToken :: Lens' CoursesStudentsCreate (Maybe Text)

OAuth access token.

cscUploadType :: Lens' CoursesStudentsCreate (Maybe Text)

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

cscPayload :: Lens' CoursesStudentsCreate Student

Multipart request metadata.

cscEnrollmentCode :: Lens' CoursesStudentsCreate (Maybe Text)

Enrollment code of the course to create the student in. This code is required if userId corresponds to the requesting user; it may be omitted if the requesting user has administrative permissions to create students for any user.

cscBearerToken :: Lens' CoursesStudentsCreate (Maybe Text)

OAuth bearer token.

cscCallback :: Lens' CoursesStudentsCreate (Maybe Text)

JSONP