REST Resource: userProfiles.guardianInvitations

リソース: GuardianInvitation

指定したメールアドレスに送信された、指定したユーザーの保護者になるための招待状。

JSON 表現 
{
  "studentId": string,
  "invitationId": string,
  "invitedEmailAddress": string,
  "state": enum (GuardianInvitationState),
  "creationTime": string
}
フィールド
studentId

string

生徒の ID（標準形式）
invitationId

string

この招待状の一意の識別子。

読み取り専用です。
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

 保護者の招待状を変更します。