REST Resource: userProfiles.guardianInvitations

Resource: GuardianInvitation

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

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 yang dituju untuk mengirimkan undangan. Kolom ini hanya dapat dilihat oleh administrator domain.
state

enum (GuardianInvitationState)

Status undangan ini.
creationTime

string (Timestamp format)

Waktu saat undangan ini dibuat.

Hanya baca.

Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

GuardianInvitationState

Status undangan wali.

Enum
GUARDIAN_INVITATION_STATE_UNSPECIFIED Tidak boleh dikembalikan.
PENDING Undangan aktif dan menunggu respons.
COMPLETE Undangan tidak aktif lagi. Undangan mungkin telah diterima, ditolak, dibatalkan, atau habis masa berlakunya.

Metode

create

 Membuat undangan wali, dan mengirim email kepada wali yang 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 menurut parameter yang diberikan.

patch

 Mengubah undangan wali.