Method: userProfiles.guardianInvitations.list

İstekte bulunan kullanıcının görüntülemesine izin verilen veli davetiyelerinin, sağlanan parametrelere göre filtrelenmiş listesini döndürür.

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 davetiyelerini görüntülemesine izin verilmiyorsa "-" studentId olarak belirtilmişse ve kullanıcı alan yöneticisi değilse, söz konusu alanda veliler için etkin değilse veya diğer erişim hataları nedeniyle PERMISSION_DENIED.
  • 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 veya state sağlandığında 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}/guardianInvitations

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

Yol parametreleri

Parametreler
studentId

string

Veli davetiyesi 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ı belirten dize değişmez değeri ("me")
  • tüm öğrenciler için sonuçların döndürülmesi gerektiğini belirten ve istekte bulunan kullanıcının veli davetiyelerini görüntülemesine izin verildiğini belirten "-" dizesi değişmez.

Sorgu parametreleri

Parametreler
invitedEmailAddress

string

Belirtilirse yalnızca belirtilen invitedEmailAddress değerine sahip 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 değerine sahip sonuçlar döndürülür.
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

Veli davetiyeleri listelenirken yanıt al.

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 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.students.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students

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