REST Resource: userProfiles.guardianInvitations

資源：GuardianInvitation

邀請特定使用者成為指定使用者的監護人，並傳送至指定電子郵件地址。

JSON 表示法 
{
  "studentId": string,
  "invitationId": string,
  "invitedEmailAddress": string,
  "state": enum (GuardianInvitationState),
  "creationTime": string
}
欄位
studentId

string

學生 ID (標準格式)
invitationId

string

邀請的專屬 ID。

唯讀。
invitedEmailAddress

string

邀請函寄送至的電子郵件地址。只有網域管理員才能查看這個欄位。
state

enum (GuardianInvitationState)

這項邀請的狀態。
creationTime

string (Timestamp format)

邀請建立的時間。

唯讀。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如 "2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

GuardianInvitationState

監護人邀請的狀態。

列舉
GUARDIAN_INVITATION_STATE_UNSPECIFIED 一律不應傳回。
PENDING 邀請已發出，正在等待回覆。
COMPLETE 邀請已失效。邀請可能已接受、拒絕、撤回或過期。

方法

create

 建立監護人邀請，並傳送電子郵件給監護人，要求他們確認自己是學生的監護人。

get

 傳回特定監護人邀請。

list

 傳回要求使用者可查看的監護人邀請清單，並根據提供的參數進行篩選。

patch

 修改監護人邀請。