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)

この招待状が作成された時刻。

読み取り専用です。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

GuardianInvitationState

保護者の招待のステータス。

列挙型
GUARDIAN_INVITATION_STATE_UNSPECIFIED 返されることはありません。
PENDING 招待は有効で、応答を待っています。
COMPLETE 招待は無効になりました。承認、不承認、取り消し、または期限切れの可能性があります。

Methods

create

 保護者宛ての招待状を作成し、保護者宛てに、ご自身が生徒の保護者であることを確認するメールを送信します。

get

 特定の保護者宛ての招待状を返します。

list

 リクエスト元のユーザーが閲覧を許可されている保護者の招待のリストを返します。指定されたパラメータでフィルタされます。

patch

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