Method: userProfiles.guardianInvitations.patch

修改監護人邀請。

目前唯一的有效的修改是將 state 從 PENDING 變更為 COMPLETE。撤銷邀請將會生效。

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

  • PERMISSION_DENIED (如果目前的使用者沒有管理監護人的權限、相關網域尚未啟用監護人或其他存取錯誤)。
  • FAILED_PRECONDITION如果監護人連結並非處於PENDING狀態。
  • INVALID_ARGUMENT如果提供的學生 ID 格式無法辨識 (不是電子郵件地址，也不是這個 API 的 userId)，或是傳送的 GuardianInvitation 含有 state 不是 state 或是 COMPLETE 其他欄位，或
  • NOT_FOUND如果提供的學生 ID 是有效的學生 ID，但 Classroom 沒有該學生的記錄，或是 id 欄位未提及已知的 Classroom 監護人邀請，

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
studentId

string

要修改監護人邀請的學生 ID。
invitationId

string

要修改的 GuardianInvitation 的 id 欄位。

查詢參數

參數
updateMask

string (FieldMask format)

識別課程中要更新欄位的遮罩。此為必填欄位，才能進行更新。如果指定無效欄位，更新就會失敗。下列欄位有效：

  • state

在查詢參數中設定時，這個欄位應指定為

updateMask=<field1>,<field2>,...

此為以半形逗號分隔的完整欄位名稱清單。範例："user.displayName,photo"。

要求主體

要求主體包含 GuardianInvitation 的例項。

回應主體

如果成功，回應主體會包含 GuardianInvitation 的執行例項。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱授權指南。