Returns a list of guardians that the requesting user is permitted to view,
restricted to those that match the request.
To list guardians for any student that the requesting user may view guardians
for, use the literal character -
for the student ID.
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 information 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,
if the invited_email_address
filter is set by a user who is not a
domain administrator, 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
is provided. *
NOT_FOUND
if a student_id
is specified, and its format
can be recognized, but Classroom has no record of that student.
(guardians.listUserProfilesGuardians)
Parameters
- $studentId
- Filter results by the student who the guardian is linked to. The identifier can
be one of the following: * the numeric identifier for the user * the email
address of the user * the string literal <code>"me"</code>, indicating the
requesting user * the string literal <code>"-"</code>, indicating that results
should be returned for all students that the requesting user has access to view.
- $optParams
- Optional parameters.
Returns
Opt_param
string pageToken nextPageToken value returned from a previous list call,
indicating that the subsequent page of results should be returned. The list
request must be otherwise identical to the one that resulted in this token.
string invitedEmailAddress Filter results by the email address that the original
invitation was sent to, resulting in this guardian link. This filter can only be
used by domain administrators.
int 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.