傳回要求方使用者檢視的監護人邀請清單,並依提供的參數篩選。
這個方法會傳回下列錯誤代碼:
PERMISSION_DENIED
如已指定studentId
,且提出要求的使用者無法查看該學生的監護人邀請,如果"-"
指定為studentId
,但使用者並非網域管理員、當相關網域尚未啟用監護人功能,或是發生其他存取錯誤,則禁止要求的使用者查看其監護人邀請。- 如果指定
studentId
,但系統無法辨識其格式,則為INVALID_ARGUMENT
(不是電子郵件地址、API 提供的studentId
,或是常值字串me
)。此外,如果您提供無效的pageToken
或state
,也可以傳回。 - 如果已指定
studentId
,且系統可辨識其格式,則為NOT_FOUND
,但 Classroom 沒有該學生的記錄。
HTTP 要求
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
studentId |
要發還監護人邀請的學生 ID。ID 可以是下列其中一項:
|
查詢參數
參數 | |
---|---|
invitedEmailAddress |
如果有指定,系統只會傳回含有指定 |
states[] |
如有指定,系統只會傳回含有指定 |
pageToken |
從先前的
|
pageSize |
要傳回的項目數上限。0 或未指定時,表示伺服器可能會指派上限。 伺服器傳回的結果數量可能會少於指定數量。 |
要求主體
要求主體必須為空白。
回應主體
列出監護人邀請時回覆。
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{
"guardianInvitations": [
{
object ( |
欄位 | |
---|---|
guardianInvitations[] |
符合名單要求的監護人邀請。 |
nextPageToken |
用於識別下一頁結果的權杖。如果留空,系統就不會顯示進一步結果。 |
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
https://www.googleapis.com/auth/classroom.guardianlinks.students
詳情請參閱授權指南。