- 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, istekle eşleşenlerle sınırlı olmak üzere velilerin listesini döndürür.
İstekte bulunan kullanıcının velilerini görebileceği tüm öğrencilerin velilerini listelemek için öğrenci kimliğinde -
değişmez karakterini kullanın.
Bu yöntem aşağıdaki hata kodlarını döndürür:
- Bir
studentId
belirtilmişse ve istekte bulunan kullanıcının söz konusu öğrencinin veli bilgilerini görüntülemesine izin verilmiyorsa ("-"
,studentId
olarak belirtilmişse ve kullanıcı alan yöneticisi değilse), söz konusu alan için veliler etkinleştirilmemişse,invitedEmailAddress
filtresi alan yöneticisi olmayan bir kullanıcı tarafından ayarlanmışsa veya başka erişim hataları söz konusu olduğundaPERMISSION_DENIED
. - Bir
studentId
belirtilmişse ancak biçimi tanınmıyorsa (bu bir e-posta adresi, API'den gelen birstudentId
veyame
değişmez dizesi değilse)INVALID_ARGUMENT
. GeçersizpageToken
sağlandığında da döndürülebilir. NOT_FOUND
birstudentId
belirtilmişse ve biçimi tanınabiliyorsa ancak Classroom'da bu öğrenciyle ilgili kayıt bulunmamaktadır.
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ı, veli bağlantısı için orijinal davetiyenin gönderildiği e-posta adresine göre filtreleyin. Bu filtre yalnızca alan adı yöneticileri tarafından kullanılabilir. |
pageToken |
|
pageSize |
Döndürülecek maksimum öğe sayısı. Sıfır veya belirtilmedi, sunucunun bir 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 verilecek yanıt.
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, istekte belirtilen ölçütleri karşılayan veliler. |
nextPageToken |
Döndürülecek bir sonraki sonuç sayfasını tanımlayan jeton. Boş bırakılırsa başka sonuç yok. |
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ılavuzuna göz atın.