Class CoursesResource.StudentsResource.DeleteRequest
Deletes a student of a course.
This method returns the following error codes:
PERMISSION_DENIEDif the requesting user is not permitted to delete students of this course or for access errors. *NOT_FOUNDif no student of this course has the requested ID or if the course does not exist.
Inheritance
System.Object
CoursesResource.StudentsResource.DeleteRequest
Inherited Members
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 DeleteRequest : ClassroomBaseServiceRequest<Empty>, IClientServiceRequest<Empty>, IClientServiceRequest
Constructors
DeleteRequest(IClientService, String, String)
Constructs a new Delete request.
Declaration
public DeleteRequest(IClientService service, string courseId, string userId)
Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service | |
| System.String | courseId | |
| System.String | userId |
Properties
CourseId
Identifier of the course. 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 |
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.Empty>.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.Empty>.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.Empty>.RestPath
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
Declaration
[RequestParameter("userId", RequestParameterType.Path)]
public virtual string UserId { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
Methods
InitParameters()
Initializes Delete parameter list.
Declaration
protected override void InitParameters()
Overrides
Google.Apis.Classroom.v1.ClassroomBaseServiceRequest<Google.Apis.Classroom.v1.Data.Empty>.InitParameters()