Method: userProfiles.guardianInvitations.get

傳回特定監護人邀請。

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

  • PERMISSION_DENIED 如果要求使用者無法查看 studentId 所識別學生的監護人邀請，或是該網域未啟用監護人功能，或是發生其他存取錯誤，則會發生此問題。
  • INVALID_ARGUMENT：如果指定了 studentId，但系統無法辨識格式 (不是電子郵件地址、不是 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

詳情請參閱授權指南。