Class CoursesResource.PatchRequest
Updates one or more fields in a course. This method returns the following error codes: * PERMISSION_DENIED
if the requesting user is not permitted to modify the requested course or for access errors. * NOT_FOUND
if no course exists with the requested ID. * INVALID_ARGUMENT if invalid fields are specified in the
update mask or if no update mask is supplied. * FAILED_PRECONDITION for the following request errors: *
CourseNotModifiable * InactiveCourseOwner * IneligibleOwner
Inheritance
Inherited Members
Namespace: Google.Apis.Classroom.v1
Assembly: Google.Apis.Classroom.v1.dll
Syntax
public class CoursesResource.PatchRequest : ClassroomBaseServiceRequest<Course>, IClientServiceRequest<Course>, IClientServiceRequestConstructors
PatchRequest(IClientService, Course, string)
Constructs a new Patch request.
Declaration
public PatchRequest(IClientService service, Course body, string id)Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service | |
| Course | body | |
| string | id |
Properties
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
Id
Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an alias.
Declaration
[RequestParameter("id", RequestParameterType.Path)]
public virtual string Id { get; }Property Value
| Type | Description |
|---|---|
| string |
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }Property Value
| Type | Description |
|---|---|
| string |
Overrides
UpdateMask
Mask that identifies which fields on the course to update. This field is required to do an update. The
update will fail if invalid fields are specified. The following fields are valid: * name * section *
descriptionHeading * description * room * courseState * ownerId Note: patches to ownerId are
treated as being effective immediately, but in practice it may take some time for the ownership transfer
of all affected resources to complete. When set in a query parameter, this field should be specified as
updateMask=,,...
Declaration
[RequestParameter("updateMask", RequestParameterType.Query)]
public virtual object UpdateMask { get; set; }Property Value
| Type | Description |
|---|---|
| object |
Methods
GetBody()
Returns the body of the request.
Declaration
protected override object GetBody()Returns
| Type | Description |
|---|---|
| object |
Overrides
InitParameters()
Initializes Patch parameter list.
Declaration
protected override void InitParameters()