Class UserProfilesResource.GuardianInvitationsResource.CreateRequest

Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian.

Once the guardian accepts the invitation, their state will change to COMPLETED and they will start receiving guardian notifications. A Guardian resource will also be created to represent the active guardian.

The request object must have the student_id and invited_email_address fields set. Failing to set these fields, or setting any other fields in the request, will result in an error.

This method returns the following error codes:

  • PERMISSION_DENIED if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors. * RESOURCE_EXHAUSTED if the student or guardian has exceeded the guardian link limit. * INVALID_ARGUMENT if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a user_id from this API). This error will also be returned if read-only fields are set, or if the state field is set to to a value other than PENDING. * NOT_FOUND if the student ID provided is a valid student ID, but Classroom has no record of that student. * ALREADY_EXISTS if there is already a pending guardian invitation for the student and invited_email_address provided, or if the provided invited_email_address matches the Google account of an existing Guardian for this user.
Inheritance
System.Object
ClientServiceRequest
ClientServiceRequest<GuardianInvitation>
ClassroomBaseServiceRequest<GuardianInvitation>
UserProfilesResource.GuardianInvitationsResource.CreateRequest
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 CreateRequest : ClassroomBaseServiceRequest<GuardianInvitation>, IClientServiceRequest<GuardianInvitation>, IClientServiceRequest

Constructors

CreateRequest(IClientService, GuardianInvitation, String)

Constructs a new Create request.

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

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

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

ID of the student (in standard format)

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

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 Create parameter list.

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

Implements