Method: userProfiles.guardianInvitations.get

返回特定的监护人邀请。

此方法会返回以下错误代码：

  • 如果请求用户不被允许查看 studentId 标识的学生的监护人邀请，如果未为相关网域启用监护人，或者存在其他访问权限错误，则返回 PERMISSION_DENIED。
  • 如果指定了 studentId，但无法识别其格式（它既不是电子邮件地址，也不是 API 中的 studentId，也不是字面量字符串 me），则为 INVALID_ARGUMENT。
  • 如果 Google 课堂找不到给定学生的任何记录，则返回 NOT_FOUND；如果找不到任何记录，则返回 invitationId。如果学生存在，但请求的用户无权查看该学生，也可能会返回此错误。

HTTP 请求

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}

网址采用 gRPC 转码语法。

路径参数

参数
studentId

string

正在请求邀请监护人的学生的 ID。
invitationId

string

所请求 GuardianInvitation 的 id 字段。

请求正文

请求正文必须为空。

响应正文

如果成功，则响应正文包含一个 GuardianInvitation 实例。

授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅授权指南。