Method: userProfiles.guardianInvitations.patch

Memodifikasi undangan wali.

Saat ini, satu-satunya perubahan yang valid adalah mengubah state dari PENDING menjadi COMPLETE. Hal ini akan membatalkan undangan.

Metode ini menampilkan kode error berikut:

  • PERMISSION_DENIED jika pengguna saat ini tidak memiliki izin untuk mengelola wali, jika wali tidak diaktifkan untuk domain yang dimaksud atau karena error akses lainnya.
  • FAILED_PRECONDITION jika link wali tidak dalam status PENDING.
  • INVALID_ARGUMENT jika format kartu pelajar yang diberikan tidak dapat dikenali (bukan alamat email atau userId dari API ini), atau jika GuardianInvitation yang lulus memiliki state selain COMPLETE, atau jika format ini mengubah kolom selain state.
  • NOT_FOUND jika ID siswa yang diberikan adalah ID siswa yang valid, tetapi Classroom tidak memiliki data siswa tersebut, atau jika kolom id tidak merujuk pada undangan wali yang diketahui di Classroom.

Permintaan HTTP

PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
studentId

string

ID siswa yang undangan walinya akan diubah.
invitationId

string

Kolom id dari GuardianInvitation yang akan diubah.

Parameter kueri

Parameter
updateMask

string (FieldMask format)

Mask yang mengidentifikasi kolom mana pada kursus yang akan diperbarui. Kolom ini wajib diisi untuk melakukan pembaruan. Update akan gagal jika kolom yang tidak valid ditentukan. Kolom berikut valid:

  • state

Jika ditetapkan dalam parameter kueri, kolom ini harus ditentukan sebagai

updateMask=<field1>,<field2>,...

Ini adalah daftar yang dipisahkan koma yang berisi nama-nama kolom yang sepenuhnya memenuhi syarat. Contoh: "user.displayName,photo".

Isi permintaan

Isi permintaan memuat instance GuardianInvitation.

Isi respons

Jika berhasil, isi respons akan berisi instance GuardianInvitation.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.