Method: userProfiles.guardianInvitations.create

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

Setelah wali menerima undangan, state-nya akan berubah menjadi COMPLETED dan ia akan mulai menerima notifikasi wali. Resource Guardian juga akan dibuat untuk mewakili wali aktif.

Objek permintaan harus memiliki kolom studentId dan invitedEmailAddress yang ditetapkan. Kegagalan dalam menetapkan kolom ini, atau menetapkan kolom lain dalam permintaan, akan mengakibatkan error.

Metode ini menampilkan kode error berikut:

  • PERMISSION_DENIED jika pengguna saat ini tidak memiliki izin untuk mengelola wali, jika wali yang dimaksud telah menolak terlalu banyak permintaan untuk siswa tersebut, jika wali tidak diaktifkan untuk domain yang dimaksud, atau untuk error akses lainnya.
  • RESOURCE_EXHAUSTED jika siswa atau wali telah melampaui batas penautan wali.
  • INVALID_ARGUMENT jika alamat email wali tidak valid (misalnya, jika terlalu panjang), atau jika format tanda pengenal siswa yang diberikan tidak dapat dikenali (bukan alamat email, atau userId dari API ini). Error ini juga akan ditampilkan jika kolom hanya baca ditetapkan, atau jika kolom state ditetapkan ke nilai selain PENDING.
  • NOT_FOUND jika ID siswa yang diberikan adalah ID siswa yang valid, tetapi Classroom tidak memiliki data siswa tersebut.
  • ALREADY_EXISTS jika sudah ada undangan wali yang tertunda untuk siswa dan invitedEmailAddress yang diberikan, atau jika invitedEmailAddress yang diberikan cocok dengan Akun Google dari Guardian yang ada untuk pengguna ini.

Permintaan HTTP

POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
guardianInvitation.studentId

string

ID siswa (dalam format standar)

Isi permintaan

Isi permintaan memuat instance GuardianInvitation.

Isi respons

Jika berhasil, isi respons memuat instance GuardianInvitation yang baru dibuat.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/classroom.guardianlinks.students

Untuk informasi selengkapnya, lihat Panduan otorisasi.