- HTTP isteği
- Yol parametreleri
- Sorgu parametreleri
- İstek metni
- Yanıt metni
- Yetkilendirme kapsamları
- Deneyin.
İ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 verilmiyorsaPERMISSION_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ınamazsaINVALID_ARGUMENT
(bu bir e-posta adresi, API'den alınan birstudentId
veya dize olanme
değil). Geçersiz birpageToken
sağlanmışsa da döndürülebilir.studentId
belirtilmişse ve biçimi tanınabiliyorsa ancak Classroom'da bu öğrencinin kaydı yoksaNOT_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 |
Sonuçları velinin bağlı olduğu öğrenciye göre filtreleyin. Tanımlayıcı aşağıdakilerden biri olabilir:
|
Sorgu parametreleri
Parametreler | |
---|---|
invitedEmailAddress |
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 |
Önceki bir Aksi takdirde, |
pageSize |
İ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 ( |
Alanlar | |
---|---|
guardians[] |
Bu sonuç sayfasındaki ve istekte belirtilen ölçütleri karşılayan veliler. |
nextPageToken |
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.