REST Resource: userProfiles.guardianInvitations

Resource: GuardianInvitation

Undangan untuk menjadi wali pengguna tertentu, yang dikirim ke alamat email yang ditentukan.

Representasi JSON 
{
  "studentId": string,
  "invitationId": string,
  "invitedEmailAddress": string,
  "state": enum (GuardianInvitationState),
  "creationTime": string
}
Kolom
studentId

string

ID siswa (dalam format standar)
invitationId

string

ID unik untuk undangan ini.

Hanya baca.
invitedEmailAddress

string

Alamat email tujuan pengiriman undangan. Kolom ini hanya dapat dilihat oleh administrator domain.
state

enum (GuardianInvitationState)

Status undangan ini.
creationTime

string (Timestamp format)

Waktu pembuatan undangan ini.

Hanya baca.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

GuardianInvitationState

Status undangan wali.

Enum
GUARDIAN_INVITATION_STATE_UNSPECIFIED Seharusnya tidak pernah ditampilkan.
PENDING Undangan aktif dan menunggu respons.
COMPLETE Undangan tidak aktif lagi. Undangan tersebut mungkin telah diterima, ditolak, dibatalkan, atau habis masa berlakunya.

Metode

create

 Membuat undangan wali, dan mengirim email kepada wali untuk meminta mereka mengonfirmasi bahwa mereka adalah wali siswa.

get

 Menampilkan undangan wali tertentu.

list

 Menampilkan daftar undangan wali yang diizinkan untuk dilihat oleh pengguna yang meminta, yang difilter berdasarkan parameter yang diberikan.

patch

 Mengubah undangan wali.