Method: userProfiles.guardians.get

Belirli bir veli döndürür.

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

  • PERMISSION_DENIED, istemde bulunan kullanıcı tarafından sağlanan studentId ile eşleşen bir kullanıcı görünmüyorsa, istemde bulunan kullanıcının studentId ile tanımlanan öğrenciye ait veli bilgilerini görüntülemesine izin verilmiyorsa, veliler söz konusu alan için etkinleştirilmemişse veya diğer erişim hataları nedeniyle gösterilir.
  • 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.
  • NOT_FOUND ise istek gönderen kullanıcının, istenen studentId için velileri görüntülemesine izin verilir ancak söz konusu öğrenci için sağlanan guardianId ile eşleşen bir Guardian kaydı yoktur.

HTTP isteği

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians/{guardianId}

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

Yol parametreleri

Parametreler
studentId

string

Velisi istenilen öğrenci. Aşağıdakilerden biri:

  • kullanıcının sayısal tanımlayıcısıdır.
  • kullanıcının e-posta adresi
  • İstekte bulunan kullanıcıyı belirten "me" değişmez dizesi
guardianId

string

Bir Guardian kaynağındaki id alanı.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt metni

Başarılıysa yanıt metni, Guardian öğesinin bir örneğini içerir.

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