Get GClassroomGuardianInvitation

Get-GClassroomGuardianInvitation

SYNOPSIS

Returns a specific guardian invitation, or a list of guardian invitations that the requesting user is permitted to view. 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.

SYNTAX

one (Default)

Get-GClassroomGuardianInvitation [-StudentId] <String> [-InvitationId] <String>
 [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]

list

Get-GClassroomGuardianInvitation [-StudentId] <String> [[-InvitedEmailAddress] <String>]
 [[-States] <StatesEnum>] [[-PageSize] <Int32>] [-All] [-StandardQueryParams <StandardQueryParameters>]
 [-GAuthId <String>] [-WhatIf] [-Confirm]

DESCRIPTION

Returns a specific guardian invitation, or a list of guardian invitations that the requesting user is permitted to view. 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.

EXAMPLES

---------- EXAMPLE 1 ----------

PS C:\> Get-GClassroomGuardianInvitation -StudentId $SomeStudentIdString -InvitationId $SomeInvitationIdString

This automatically generated example serves to show the bare minimum required to call this Cmdlet.

Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.

---------- EXAMPLE 2 ----------

PS C:\> Get-GClassroomGuardianInvitation -StudentId $SomeStudentIdString -All

This automatically generated example serves to show the bare minimum required to call this Cmdlet.

Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.

PARAMETERS

-StudentId

The ID of the student whose guardian invitation is being requested.

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: 0
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-InvitationId

The `id` field of the `GuardianInvitation` being requested.

Type: String
Parameter Sets: one
Aliases: 

Required: True
Position: 1
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-InvitedEmailAddress

If specified, only results with the specified `invited_email_address` will be returned.

Type: String
Parameter Sets: list
Aliases: 

Required: False
Position: 1
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-States

If specified, only results with the specified `state` values will be returned. Otherwise, results with a `state` of `PENDING` will be returned.

Possible values: GUARDIANINVITATIONSTATEUNSPECIFIED, PENDING, COMPLETE

Type: StatesEnum
Parameter Sets: list
Aliases: 
Accepted values: GUARDIANINVITATIONSTATEUNSPECIFIED, PENDING, COMPLETE

Required: False
Position: 2
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-PageSize

Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

Type: Int32
Parameter Sets: list
Aliases: 

Required: False
Position: 3
Default value: 
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-All

A switch to list all results.

Type: SwitchParameter
Parameter Sets: list
Aliases: 

Required: False
Position: 4
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-StandardQueryParams

A Standard Query Parameters Object.

Type: StandardQueryParameters
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

-GAuthId

The GAuthId representing the gShell auth credentials this cmdlet should use to run.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: 
Accept pipeline input: False
Accept wildcard characters: False

INPUTS

System.String

The ID of the student whose guardian invitation is being requested.

System.String

The `id` field of the `GuardianInvitation` being requested.

System.String

If specified, only results with the specified `invited_email_address` will be returned.

Google.Apis.Classroom.v1.UserProfilesResource+GuardianInvitationsResource+ListRequest+StatesEnum

If specified, only results with the specified `state` values will be returned. Otherwise, results with a `state` of `PENDING` will be returned.

System.Int32

Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.

OUTPUTS

NOTES

Part of the gShell Project, relating to the Google Classroom API; see Related Links or use the -Online parameter.

RELATED LINKS

[Wiki page for this Cmdlet]

[Getting started with gShell]