Guardian Invitations List

Source: R/classroom_functions.R

Returns a list of guardian invitations that the requesting user ispermitted to view, filtered by the parameters provided.

gc_user_profiles_guardian_invitations_list(
  studentId,
  pageToken = NULL,
  invitedEmailAddress = NULL,
  states = NULL,
  pageSize = NULL
)

Arguments

studentId

The ID of the student whose guardian invitations are to be returned
pageToken

nextPageToken
invitedEmailAddress

If specified, only results with the specified invited_email_address
states

If specified, only results with the specified state values are
pageSize

Maximum number of items to return

Details

This method returns the following error codes:

  • PERMISSION_DENIED if a student_id is specified, and the requesting user is not permitted to view guardian invitations for that student, if '-' is specified as the student_id and the user is not a domain administrator, 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). May also be returned if an invalid page_token or state is provided.

  • NOT_FOUND if a student_id is specified, and its format can be recognized, but Classroom has no record of 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