- Permintaan HTTP
- Parameter lokasi
- Parameter kueri
- Isi permintaan
- Isi respons
- Cakupan otorisasi
- Cobalah!
Menampilkan daftar wali yang boleh dilihat oleh pengguna yang meminta, terbatas pada wali yang cocok dengan permintaan tersebut.
Untuk menampilkan daftar wali siswa yang mungkin dilihat walinya oleh pengguna yang meminta, gunakan karakter literal -
untuk ID siswa.
Metode ini menampilkan kode error berikut:
PERMISSION_DENIED
jikastudentId
ditentukan, dan pengguna yang meminta tidak diizinkan untuk melihat informasi wali siswa tersebut, jika"-"
ditetapkan sebagaistudentId
dan pengguna bukan administrator domain, jika wali tidak diaktifkan untuk domain yang dimaksud, jika filterinvitedEmailAddress
disetel oleh pengguna yang bukan administrator domain, atau untuk error akses lainnya.INVALID_ARGUMENT
jikastudentId
ditentukan, tetapi formatnya tidak dapat dikenali (ini bukan alamat email, ataustudentId
dari API, atau string literalme
). Juga dapat ditampilkan jikapageToken
yang tidak valid diberikan.NOT_FOUND
jikastudentId
ditentukan, dan formatnya dapat dikenali, tetapi Classroom tidak memiliki data siswa tersebut.
Permintaan HTTP
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
Parameter | |
---|---|
studentId |
Filter hasil berdasarkan siswa yang ditautkan oleh wali. ID dapat berupa salah satu dari berikut:
|
Parameter kueri
Parameter | |
---|---|
invitedEmailAddress |
Filter hasil menurut alamat email yang dikirimi undangan asli, sehingga menghasilkan link wali ini. Filter ini hanya dapat digunakan oleh administrator domain. |
pageToken |
Nilai Permintaan |
pageSize |
Jumlah item maksimum untuk ditampilkan. Nol atau tidak ditentukan menunjukkan bahwa server dapat menetapkan nilai maksimum. Server mungkin menampilkan lebih sedikit dari jumlah hasil yang ditetapkan. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Respons saat mencantumkan wali.
Jika berhasil, isi respons memuat data dengan struktur berikut:
Representasi JSON |
---|
{
"guardians": [
{
object ( |
Kolom | |
---|---|
guardians[] |
Wali di halaman ini hasil yang memenuhi kriteria yang ditentukan dalam permintaan. |
nextPageToken |
Token yang mengidentifikasi halaman hasil berikutnya yang akan ditampilkan. Jika kosong, tidak ada hasil lebih lanjut yang tersedia. |
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly
https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
https://www.googleapis.com/auth/classroom.guardianlinks.students
Untuk informasi selengkapnya, lihat Panduan otorisasi.