Method: userProfiles.guardianInvitations.list

İ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 bir studentId veya me değişmez dizesi değilse) INVALID_ARGUMENT. Geçersiz pageToken veya state sağlandığında da döndürülebilir.
  • NOT_FOUND bir studentId 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

string

Veli daveti geri verilecek öğrencinin kimliği. 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ı gösteren "me" dize değeri
  • İstekte bulunan kullanıcının veli davetiyelerini görüntülemesine izin verilen tüm öğrenciler için sonuçların döndürülmesi gerektiğini belirten "-" dize değeri.

Sorgu parametreleri

Parametreler
invitedEmailAddress

string

Belirtilirse yalnızca belirtilen invitedEmailAddress içeren sonuçlar döndürülür.
states[]

enum (GuardianInvitationState)

Belirtilirse yalnızca belirtilen state değerlerine sahip sonuçlar döndürülür. Aksi takdirde, state/PENDING olan sonuçlar döndürülür.
pageToken

string

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

list isteği, aksi takdirde bu jetonla sonuçlanan istekle aynı olmalıdır.
pageSize

integer

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 (GuardianInvitation)
    }
  ],
  "nextPageToken": string
}
Alanlar
guardianInvitations[]

object (GuardianInvitation)

Liste isteğiyle eşleşen veli davetiyeleri.
nextPageToken

string

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.