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)

這項邀請的建立時間。

唯讀。

使用 RFC 3339，產生的輸出內容一律會經過 Z 標準化，並使用 0、3、6 或 9 個小數位數。系統也接受「Z」以外的偏移量。例如："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

GuardianInvitationState

監護人邀請的狀態。

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

方法

create

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

get

 傳回特定監護人邀請。

list

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

patch

 修改監護人邀請。