Class UserProfilesResource.GuardianInvitationsResource.GetRequest
Returns a specific guardian invitation. This method returns the following error codes: *
PERMISSION_DENIED
if the requesting user is not permitted to view guardian invitations for the student
identified by the student_id
, if guardians are not enabled for the domain in question, or for other
access errors. * INVALID_ARGUMENT
if a student_id
is specified, but its format cannot be recognized
(it is not an email address, nor a student_id
from the API, nor the literal string me
). *
NOT_FOUND
if Classroom cannot find any record of the given student or invitation_id
. May also be
returned if the student exists, but the requesting user does not have access to see that student.
Inheritance
Inherited Members
Namespace: Google.Apis.Classroom.v1
Assembly: Google.Apis.Classroom.v1.dll
Syntax
public class UserProfilesResource.GuardianInvitationsResource.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 | |
string | studentId | |
string | invitationId |
Properties
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
InvitationId
The id
field of the GuardianInvitation
being requested.
Declaration
[RequestParameter("invitationId", RequestParameterType.Path)]
public virtual string InvitationId { 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
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 |
---|---|
string |
Methods
InitParameters()
Initializes Get parameter list.
Declaration
protected override void InitParameters()