Method: userProfiles.guardianInvitations.list

Menampilkan daftar undangan wali yang boleh dilihat oleh pengguna yang meminta, yang difilter menurut parameter yang diberikan.

Metode ini akan menampilkan kode error berikut:

  • PERMISSION_DENIED jika studentId ditentukan, dan pengguna yang meminta tidak diizinkan melihat undangan wali untuk siswa tersebut, jika "-" ditetapkan sebagai studentId dan pengguna bukan administrator domain, 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, atau studentId dari API, atau string literal me). Dapat juga ditampilkan jika pageToken atau state yang tidak valid diberikan.
  • NOT_FOUND jika studentId ditentukan dan formatnya dapat dikenali, tetapi Classroom tidak memiliki catatan siswa tersebut.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
studentId

string

ID siswa yang undangan walinya akan dikembalikan. ID dapat berupa salah satu dari hal berikut:

  • ID numerik untuk pengguna
  • alamat email pengguna
  • literal string "me", yang menunjukkan pengguna yang meminta
  • literal string "-", yang menunjukkan bahwa hasil harus ditampilkan untuk semua siswa bahwa pengguna yang meminta diizinkan untuk melihat undangan wali.

Parameter kueri

Parameter
invitedEmailAddress

string

Jika ditentukan, hanya hasil dengan invitedEmailAddress yang ditentukan yang akan ditampilkan.
states[]

enum (GuardianInvitationState)

Jika ditentukan, hanya hasil dengan nilai state yang ditentukan yang akan ditampilkan. Jika tidak, hasil dengan state dari PENDING akan ditampilkan.
pageToken

string

Nilai nextPageToken ditampilkan dari panggilan list sebelumnya, yang menunjukkan bahwa halaman hasil berikutnya harus ditampilkan.

Permintaan list harus sama persis dengan permintaan yang menghasilkan token ini.
pageSize

integer

Jumlah item maksimum yang akan ditampilkan. Nol atau tidak ditentukan menunjukkan bahwa server dapat menetapkan nilai maksimum.

Server mungkin menampilkan lebih sedikit dari jumlah hasil yang ditentukan.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons saat mencantumkan undangan wali.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "guardianInvitations": [
    {
      object (GuardianInvitation)
    }
  ],
  "nextPageToken": string
}
Kolom
guardianInvitations[]

object (GuardianInvitation)

Undangan wali yang cocok dengan permintaan daftar.
nextPageToken

string

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.students.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students

Untuk informasi selengkapnya, lihat Panduan otorisasi.