- HTTP isteği
- Yol parametreleri
- Sorgu parametreleri
- İstek metni
- Yanıt metni
- Yetkilendirme kapsamları
- Deneyin.
İstekte bulunan kullanıcının, sağlanan parametrelere göre filtrelenmiş olarak görüntülemesine izin verilen veli davetiyelerinin listesini döndürür.
Bu yöntem aşağıdaki hata kodlarını döndürür:
PERMISSION_DENIED
:studentId
belirtilmişse ve istekte bulunan kullanıcının söz konusu öğrenci için veli davetiyelerini 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 veya diğer erişim hataları.- 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
veyastate
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}/guardianInvitations
URL, gRPC Kod Dönüştürme söz dizimini kullanır.
Yol parametreleri
Parametreler | |
---|---|
studentId |
Veli daveti geri verilecek öğrencinin kimliği. Tanımlayıcı aşağıdakilerden biri olabilir:
|
Sorgu parametreleri
Parametreler | |
---|---|
invitedEmailAddress |
Belirtilirse yalnızca belirtilen |
states[] |
Belirtilirse yalnızca belirtilen |
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
Veli davetiyeleri listelenirken verilecek yanıt.
Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:
JSON gösterimi |
---|
{
"guardianInvitations": [
{
object ( |
Alanlar | |
---|---|
guardianInvitations[] |
Liste isteğiyle eşleşen veli davetiyeleri. |
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.students.readonly
https://www.googleapis.com/auth/classroom.guardianlinks.students
Daha fazla bilgi için Yetkilendirme kılavuzuna göz atın.