REST Resource: userProfiles.guardianInvitations

資源：Guardian 邀請

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

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」格式的時間戳記，採用奈秒解析度，且最多 9 個小數位數。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

GuardianInvitationState

監護人邀請狀態。

列舉
GUARDIAN_INVITATION_STATE_UNSPECIFIED 一律不應傳回。
PENDING 邀請有效，正在等待回覆。
COMPLETE 這項邀請已失效。該票證可能已接受、拒絕、撤銷，或是已過期。

方法

create

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

get

 傳回特定監護人邀請。

list

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

patch

 修改監護人邀請。