Class CoursesResource.StudentsResource.CreateRequest
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.
Inheritance
Inherited Members
Namespace: Google.Apis.Classroom.v1
Assembly: Google.Apis.Classroom.v1.dll
Syntax
public class CreateRequest : ClassroomBaseServiceRequest<Student>, IClientServiceRequest<Student>, IClientServiceRequest
Constructors
CreateRequest(IClientService, Student, String)
Constructs a new Create request.
Declaration
public CreateRequest(IClientService service, Student body, string courseId)
Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service | |
| Student | body | |
| System.String | courseId |
Properties
CourseId
Identifier of the course to create the student in. This identifier can be either the Classroom-assigned identifier or an alias.
Declaration
[RequestParameter("courseId", RequestParameterType.Path)]
public virtual string CourseId { get; }
Property Value
| Type | Description |
|---|---|
| System.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.
Declaration
[RequestParameter("enrollmentCode", RequestParameterType.Query)]
public virtual string EnrollmentCode { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
Methods
GetBody()
Returns the body of the request.
Declaration
protected override object GetBody()
Returns
| Type | Description |
|---|---|
| System.Object |
Overrides
InitParameters()
Initializes Create parameter list.
Declaration
protected override void InitParameters()