Get Guardian Invitations

Source: R/classroom_functions.R

Returns a specific guardian invitation.

gc_user_profiles_guardian_invitations_get(studentId, invitationId)

Arguments

studentId

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

The id field of the GuardianInvitation being requested

Details

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.

Authentication scopes used by this function are:

  • https://www.googleapis.com/auth/classroom.guardianlinks.students

  • https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly

Set options(googleAuthR.scopes.selected = c("https://www.googleapis.com/auth/classroom.guardianlinks.students", "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly") Then run googleAuthR::gar_auth() to authenticate. See gar_auth for details.

See also

Google Documentation