Class UserProfilesResource.GuardianInvitationsResource.PatchRequest

Modifies a guardian invitation.

Currently, the only valid modification is to change the state from PENDING to COMPLETE. This has the effect of withdrawing the invitation.

This method returns the following error codes:

  • PERMISSION_DENIED if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. * FAILED_PRECONDITION if the guardian link is not in the PENDING state. * INVALID_ARGUMENT if the format of the student ID provided cannot be recognized (it is not an email address, nor a user_id from this API), or if the passed GuardianInvitation has a state other than COMPLETE, or if it modifies fields other than state. * NOT_FOUND if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the id field does not refer to a guardian invitation known to Classroom.
Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<GuardianInvitation>
ClassroomBaseServiceRequest<GuardianInvitation>
UserProfilesResource.GuardianInvitationsResource.PatchRequest
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 PatchRequest : ClassroomBaseServiceRequest<GuardianInvitation>, IClientServiceRequest<GuardianInvitation>, IClientServiceRequest

Constructors

PatchRequest(IClientService, GuardianInvitation, String, String)

Constructs a new Patch request.

Declaration
public PatchRequest(IClientService service, GuardianInvitation body, string studentId, string invitationId)
Parameters
Type Name Description
IClientService service
GuardianInvitation body
System.String studentId
System.String invitationId

Properties

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.GuardianInvitation>.HttpMethod

InvitationId

The id field of the GuardianInvitation to be modified.

Declaration
[RequestParameter("invitationId", RequestParameterType.Path)]
public virtual string InvitationId { get; }
Property Value
Type Description
System.String

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.GuardianInvitation>.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.GuardianInvitation>.RestPath

StudentId

The ID of the student whose guardian invitation is to be modified.

Declaration
[RequestParameter("studentId", RequestParameterType.Path)]
public virtual string StudentId { get; }
Property Value
Type Description
System.String

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:

  • state

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
System.Object

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.GuardianInvitation>.GetBody()

InitParameters()

Initializes Patch parameter list.

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

Implements