REST Resource: userProfiles.guardianInvitations

Referensi: Undangan Wali

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

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

string

Tanda pengenal siswa (dalam format standar)
invitationId

string

ID unik untuk undangan ini.

Hanya baca.
invitedEmailAddress

string

Alamat email yang dikirimi undangan. Kolom ini hanya dapat dilihat oleh administrator domain.
state

enum (GuardianInvitationState)

Status tempat undangan ini berada.
creationTime

string (Timestamp format)

Waktu undangan ini dibuat.

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 Tidak boleh dikembalikan.
PENDING Undangan aktif dan menunggu respons.
COMPLETE Undangan sudah tidak aktif. Pesanan mungkin telah diterima, ditolak, dibatalkan, atau mungkin sudah tidak berlaku.

Metode

create

 Membuat undangan wali, dan mengirim email ke wali untuk meminta konfirmasi bahwa mereka adalah wali siswa.

get

 Menampilkan undangan wali tertentu.

list

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

patch

 Memodifikasi undangan wali.