Method: userProfiles.guardianInvitations.get

返回特定的监护人邀请。

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

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

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

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