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 thestudentId
, if guardians are not enabled for the domain in question, or for other access errors.INVALID_ARGUMENT
if astudentId
is specified, but its format cannot be recognized (it is not an email address, nor astudentId
from the API, nor the literal stringme
).NOT_FOUND
if Classroom cannot find any record of the given student orinvitationId
. May also be returned if the student exists, but the requesting user does not have access to see that student.
HTTP request
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
studentId |
The ID of the student whose guardian invitation is being requested. |
invitationId |
The |
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of GuardianInvitation
.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
https://www.googleapis.com/auth/classroom.guardianlinks.students
For more information, see the Authorization guide.