Method: userProfiles.guardianInvitations.get

傳回特定監護人邀請。

這個方法會傳回下列錯誤代碼：

  • PERMISSION_DENIED，提出要求的使用者無法查看 studentId 指明的學生監護人邀請、相關網域未啟用監護人功能，或其他存取錯誤。
  • 如果已指定 studentId，但系統無法辨識其格式，則為 INVALID_ARGUMENT (不是電子郵件地址，也不是 API 中的 studentId，或常值字串 me)。
  • NOT_FOUND 表示 Classroom 找不到任何該學生或 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

詳情請參閱授權指南。