Method: userProfiles.guardians.list

İstekte bulunan kullanıcının görüntülemesine izin verilen velilerle sınırlı olan velilerin listesini döndürür.

İstekte bulunan kullanıcının velilerini görüntüleyebileceği tüm öğrencilerin velilerini listelemek için öğrenci kimliği olarak - değişmez karakterini kullanın.

Bu yöntem aşağıdaki hata kodlarını döndürür:

  • studentId belirtilmişse ve istekte bulunan kullanıcının söz konusu öğrencinin veli bilgilerini görüntülemesine izin verilmiyorsa PERMISSION_DENIED; studentId olarak "-" belirtilmişse ve kullanıcı alan yöneticisi değilse, söz konusu alanda veliler etkin değilse, invitedEmailAddress filtresi alan yöneticisi olmayan bir kullanıcı tarafından ayarlanırsa veya diğer erişim hataları nedeniyle.
  • studentId belirtilmişse ancak biçimi tanınamazsa INVALID_ARGUMENT (bu bir e-posta adresi, API'den alınan bir studentId veya dize olan me değil). Geçersiz bir pageToken sağlanmışsa da döndürülebilir.
  • studentId belirtilmişse ve biçimi tanınabiliyorsa ancak Classroom'da bu öğrencinin kaydı yoksa NOT_FOUND.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
studentId

string

Sonuçları velinin bağlı olduğu öğrenciye göre filtreleyin. Tanımlayıcı aşağıdakilerden biri olabilir:

  • kullanıcının sayısal tanımlayıcısı
  • kullanıcının e-posta adresi
  • istekte bulunan kullanıcıyı belirten dize değişmez değeri ("me")
  • istekte bulunan kullanıcının görüntüleme erişiminin olduğu tüm öğrenciler için sonuçların döndürülmesi gerektiğini belirten "-" dizesi değişmez değeri.

Sorgu parametreleri

Parametreler
invitedEmailAddress

string

Sonuçları, ilk davetiyenin gönderildiği e-posta adresine göre filtreleyin. Bu durumda veli bağlantısı görüntülenir. Bu filtre yalnızca alan yöneticileri tarafından kullanılabilir.
pageToken

string

Önceki bir list çağrısından döndürülen nextPageToken değeri, sonraki sonuç sayfasının döndürülmesi gerektiğini belirtir.

Aksi takdirde, list isteği, bu jetonu sağlayan istekle aynı olmalıdır.
pageSize

integer

İade edilecek maksimum öğe sayısı. Sıfır veya belirtilmedi olarak, sunucunun maksimum değer atayabileceğini gösterir.

Sunucu, belirtilen sayıdan daha az sonuç döndürebilir.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Veliler listelenirken yanıt ver.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "guardians": [
    {
      object (Guardian)
    }
  ],
  "nextPageToken": string
}
Alanlar
guardians[]

object (Guardian)

Bu sonuç sayfasındaki ve istekte belirtilen ölçütleri karşılayan veliler.
nextPageToken

string

Döndürülecek sonuçların sonraki sayfasını tanımlayan jeton. Boşsa başka sonuç sunulmaz.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • 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

Daha fazla bilgi için Yetkilendirme kılavuzunu inceleyin.