Method: userProfiles.guardianInvitations.get

Menampilkan undangan wali tertentu.

Metode ini menampilkan kode error berikut:

  • PERMISSION_DENIED jika pengguna yang meminta tidak diizinkan untuk melihat undangan wali bagi siswa yang diidentifikasi oleh studentId, jika wali tidak diaktifkan untuk domain yang dimaksud, atau untuk error akses lainnya.
  • INVALID_ARGUMENT jika studentId ditentukan, tetapi formatnya tidak dapat dikenali (bukan alamat email, studentId dari API, atau string literal me).
  • NOT_FOUND jika Classroom tidak dapat menemukan data siswa tertentu atau invitationId. Dapat juga ditampilkan jika siswa ada, tetapi pengguna yang meminta tidak memiliki akses untuk melihat siswa tersebut.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
studentId

string

ID siswa yang undangan walinya sedang diminta.
invitationId

string

Kolom id dari GuardianInvitation yang diminta.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat instance GuardianInvitation.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.