Class UserProfilesResource.GuardianInvitationsResource.GetRequest
Returns a specific guardian invitation.
This method returns the following error codes:
PERMISSION_DENIEDif the requesting user is not permitted to view guardian invitations for the student identified by thestudent_id, if guardians are not enabled for the domain in question, or for other access errors. *INVALID_ARGUMENTif astudent_idis specified, but its format cannot be recognized (it is not an email address, nor astudent_idfrom the API, nor the literal stringme). *NOT_FOUNDif Classroom cannot find any record of the given student orinvitation_id. May also be returned if the student exists, but the requesting user does not have access to see that student.
Inheritance
System.Object
UserProfilesResource.GuardianInvitationsResource.GetRequest
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 GetRequest : ClassroomBaseServiceRequest<GuardianInvitation>, IClientServiceRequest<GuardianInvitation>, IClientServiceRequest
Constructors
GetRequest(IClientService, String, String)
Constructs a new Get request.
Declaration
public GetRequest(IClientService service, string studentId, string invitationId)
Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service | |
| 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 being requested.
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 being requested.
Declaration
[RequestParameter("studentId", RequestParameterType.Path)]
public virtual string StudentId { get; }
Property Value
| Type | Description |
|---|---|
| System.String |
Methods
InitParameters()
Initializes Get parameter list.
Declaration
protected override void InitParameters()
Overrides
Google.Apis.Classroom.v1.ClassroomBaseServiceRequest<Google.Apis.Classroom.v1.Data.GuardianInvitation>.InitParameters()