Class CoursesResource.StudentsResource.CreateRequest

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.

Inheritance
System.Object
Google.Apis.Requests.ClientServiceRequest
Google.Apis.Requests.ClientServiceRequest<Student>
ClassroomBaseServiceRequest<Student>
CoursesResource.StudentsResource.CreateRequest
Implements
Google.Apis.Requests.IClientServiceRequest<Student>
Google.Apis.Requests.IClientServiceRequest
Inherited Members
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.Student>.Execute()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.Student>.ExecuteAsStream()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.Student>.ExecuteAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.Student>.ExecuteAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.Student>.ExecuteAsStreamAsync()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.Student>.ExecuteAsStreamAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.Student>.CreateRequest(System.Nullable<System.Boolean>)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.Student>.GenerateRequestUri()
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.Student>.GetDefaultETagAction(System.String)
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.Student>.ETagAction
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.Student>.ModifyRequest
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.Student>.ValidateParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.Student>.RequestParameters
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.Student>.Service
Google.Apis.Requests.ClientServiceRequest._unsuccessfulResponseHandlers
Google.Apis.Requests.ClientServiceRequest._exceptionHandlers
Google.Apis.Requests.ClientServiceRequest._executeInterceptors
Google.Apis.Requests.ClientServiceRequest.AddUnsuccessfulResponseHandler(Google.Apis.Http.IHttpUnsuccessfulResponseHandler)
Google.Apis.Requests.ClientServiceRequest.AddExceptionHandler(Google.Apis.Http.IHttpExceptionHandler)
Google.Apis.Requests.ClientServiceRequest.AddExecuteInterceptor(Google.Apis.Http.IHttpExecuteInterceptor)
Google.Apis.Requests.ClientServiceRequest.Credential
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
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
Google.Apis.Services.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
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.Student>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.Student>.MethodName

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.Student>.RestPath

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
System.Object
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.Classroom.v1.Data.Student>.GetBody()

InitParameters()

Initializes Create parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.Classroom.v1.ClassroomBaseServiceRequest<Google.Apis.Classroom.v1.Data.Student>.InitParameters()

Implements

Google.Apis.Requests.IClientServiceRequest<TResponse>
Google.Apis.Requests.IClientServiceRequest