Class CoursesResource.StudentsResource

The "students" collection of methods.

Inheritance

object

CoursesResource.StudentsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Classroom.v1

Assembly: Google.Apis.Classroom.v1.dll

Syntax

public class CoursesResource.StudentsResource

Constructors

StudentsResource(IClientService)

Constructs a new resource.

Declaration

public StudentsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Create(Student, string)

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.

Declaration

public virtual CoursesResource.StudentsResource.CreateRequest Create(Student body, string courseId)

Parameters

Type	Name	Description
Student	body	The body of the request.
string	courseId	Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias.

Returns

Type	Description
CoursesResource.StudentsResource.CreateRequest

Delete(string, string)

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.

Declaration

public virtual CoursesResource.StudentsResource.DeleteRequest Delete(string courseId, string userId)

Parameters

Type	Name	Description
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

Returns

Type	Description
CoursesResource.StudentsResource.DeleteRequest

Get(string, string)

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.

Declaration

public virtual CoursesResource.StudentsResource.GetRequest Get(string courseId, string userId)

Parameters

Type	Name	Description
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

Returns

Type	Description
CoursesResource.StudentsResource.GetRequest

List(string)

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.

Declaration

public virtual CoursesResource.StudentsResource.ListRequest List(string courseId)

Parameters

Type	Name	Description
string	courseId	Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias.

Returns

Type	Description
CoursesResource.StudentsResource.ListRequest