Class Google_Service_Classroom_CoursesStudents_Resource
The "students" collection of methods. Typical usage is:
$classroomService = new Google_Service_Classroom(...);
$students = $classroomService->students;
-
Google_Service_Resource
-
Google_Service_Classroom_CoursesStudents_Resource
Located at Classroom.php
Methods summary
public
Google_Service_Classroom_Student
|
#
create( string $courseId, Google_Service_Classroom_Student $postBody, array $optParams = array() )
Adds a user as a student of a course.
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. (students.create)
Parameters
- $courseId
- Identifier of the course to create the student in. This identifier can be either
the Classroom-assigned identifier or an alias.
- $postBody
- $optParams
- Optional parameters.
Returns
Opt_param
string enrollmentCode 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.
|
public
Google_Service_Classroom_ClassroomEmpty
|
#
delete( string $courseId, string $userId, array $optParams = array() )
Deletes a student of a course.
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
- $courseId
- Identifier of the course. This identifier can be either the Classroom-assigned
identifier or an alias.
- $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 <code>"me"</code>, indicating the requesting user
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Classroom_Student
|
#
get( string $courseId, string $userId, array $optParams = array() )
Returns a student of a course.
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
- $courseId
- Identifier of the course. This identifier can be either the Classroom-assigned
identifier or an alias.
- $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 <code>"me"</code>, indicating the requesting user
- $optParams
- Optional parameters.
Returns
|
public
Google_Service_Classroom_ListStudentsResponse
|
#
listCoursesStudents( string $courseId, array $optParams = array() )
Returns a list of students of this course that the requester is permitted to
view.
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
- $courseId
- Identifier of the course. This identifier can be either the Classroom-assigned
identifier or an alias.
- $optParams
- Optional parameters.
Returns
Opt_param
string pageToken nextPageToken value returned from a previous list call,
indicating that the subsequent page of results should be returned. The list
request must be otherwise identical to the one that resulted in this token.
int pageSize Maximum number of items to return. Zero means no maximum. The
server may return fewer than the specified number of results.
|