1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Classroom
  7. \
  8. Resource
  9. \
  10. CoursesStudents

CoursesStudents

class CoursesStudents extends Resource (View source)

The "students" collection of methods.

Typical usage is:

 $classroomService = new Google\Service\Classroom(...);
 $students = $classroomService->courses_students;

Methods

Student
create(string $courseId, Student $postBody, array $optParams = [])

Adds a user as a student of a course. Domain administrators are permitted to directly add users within their domain as students to courses within their domain.

ClassroomEmpty
delete(string $courseId, string $userId, array $optParams = [])

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.

Student
get(string $courseId, string $userId, array $optParams = [])

Returns a student of a course. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to view 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.

ListStudentsResponse
listCoursesStudents(string $courseId, array $optParams = [])

Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: NOT_FOUND if the course does not exist. PERMISSION_DENIED for access errors.

Details

at line 59
Student create(string $courseId, Student $postBody, array $optParams = [])

Adds a user as a student of a course. Domain administrators are permitted to directly add users within their domain as students to courses within their domain.

Students are permitted to add themselves to a course using an enrollment code. 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 InactiveCourseOwner ALREADY_EXISTS if the user is already a student or teacher in the course. (students.create)

Parameters

string $courseId

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

Optional parameters.

Return Value

Student

Exceptions

Exception

at line 82
ClassroomEmpty delete(string $courseId, string $userId, array $optParams = [])

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.

(students.delete)

Parameters

string $courseId

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

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
array $optParams

Optional parameters.

Return Value

ClassroomEmpty

Exceptions

Exception

at line 105
Student get(string $courseId, string $userId, array $optParams = [])

Returns a student of a course. This method returns the following error codes:

  • PERMISSION_DENIED if the requesting user is not permitted to view 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.

(students.get)

Parameters

string $courseId

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

Identifier of the student to return. 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
array $optParams

Optional parameters.

Return Value

Student

Exceptions

Exception

at line 131
ListStudentsResponse listCoursesStudents(string $courseId, array $optParams = [])

Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: NOT_FOUND if the course does not exist. PERMISSION_DENIED for access errors.

(students.listCoursesStudents)

Parameters

string $courseId

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

Optional parameters.

Return Value

ListStudentsResponse

Exceptions

Exception