Method: userProfiles.guardianInvitations.list

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

Bu yöntem aşağıdaki hata kodlarını döndürür:

  • studentId belirtilmişse ve istek gönderen kullanıcının ilgili öğrenciye ait veli davetlerini görüntülemesine izin verilmiyorsa, studentId olarak "-" belirtilmişse ve kullanıcı alan yöneticisi değilse, veliler söz konusu alan için etkinleştirilmemişse veya diğer erişim hataları için.PERMISSION_DENIED
  • studentId belirtilmişse ancak biçimi tanınamıyorsa (e-posta adresi, API'den bir studentId veya me değişmez dizesi değilse) INVALID_ARGUMENT. Geçersiz bir pageToken veya state sağlanırsa da döndürülebilir.
  • NOT_FOUND, bir studentId belirtilmişse ve biçimi tanınabiliyorsa ancak Classroom'da bu öğrenciyle ilgili kayıt yoksa.

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 davetiyelerinin döndürüleceği öğ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
  • İstekte bulunan kullanıcıyı belirten "me" değişmez dizesi
  • İstekte bulunan kullanıcının veli davetlerini görüntülemesine izin verilen tüm öğrenciler için sonuçların döndürülmesi gerektiğini belirten "-" dize değişmezi.

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 sonuç içeren sonuçlar döndürülür.
pageToken

string

Önceki bir list çağrısından döndürülen nextPageToken değeri. Sonuçların sonraki sayfasının döndürülmesi gerektiğini belirtir.

list isteği, bu jetonla sonuçlanan istekte belirtilenlerle aynı olmalıdır.
pageSize

integer

Döndürülecek maksimum öğe sayısı. Sıfır veya belirtilmemiş, sunucunun maksimum bir 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 davetlerini listelemede verilen 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 davetleri.
nextPageToken

string

Döndürülecek bir sonraki sonuç sayfasını tanımlayan jeton. Boşsa başka sonuç yoktur.

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 bakın.