Method: userProfiles.guardianInvitations.create

Veli davetiyesi oluşturur ve veliye, öğrencinin velisi olduğunu onaylamasını isteyen bir e-posta gönderir.

Veli daveti kabul ettikten sonra state durumu COMPLETED olarak değişir ve veli bildirimleri almaya başlar. Etkin koruyucuyu temsil etmek için bir Guardian kaynağı da oluşturulur.

İstek nesnesinde studentId ve invitedEmailAddress alanları ayarlanmalıdır. Bu alanların ayarlanmaması veya istekteki başka alanların ayarlanması hatayla sonuçlanır.

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

  • Mevcut kullanıcının velileri yönetme izni yoksa, söz konusu veli bu öğrenci için çok fazla istek reddettiyse, veliler söz konusu alan için etkinleştirilmediyse veya başka erişim hataları varsa PERMISSION_DENIED.
  • RESOURCE_EXHAUSTED Öğrenci veya veli, veli bağlantısı sınırını aştıysa.
  • Veli e-posta adresi geçerli değilse (örneğin, çok uzunsa) veya sağlanan öğrenci kimliğinin biçimi tanınamıyorsa (e-posta adresi veya bu API'den alınan bir userId değilse) INVALID_ARGUMENT. Bu hata, salt okunur alanlar ayarlanmışsa veya state alanı PENDING dışında bir değere ayarlanmışsa da döndürülür.
  • NOT_FOUND, sağlanan öğrenci kimliği geçerli bir öğrenci kimliğiyse ancak Classroom'da bu öğrenciyle ilgili kayıt yoksa.
  • Öğrenci için bekleyen bir veli davetiyesi varsa ve invitedEmailAddress sağlandıysa veya sağlanan invitedEmailAddress, bu kullanıcının mevcut bir Guardian hesabının Google Hesabı ile eşleşiyorsa ALREADY_EXISTS.

HTTP isteği

POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations

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

Yol parametreleri

Parametreler
guardianInvitation.studentId

string

Öğrencinin kimliği (standart biçimde)

İstek içeriği

İstek metni, GuardianInvitation öğesinin bir örneğini içerir.

Yanıt gövdesi

Başarılı olursa yanıt metni, yeni oluşturulmuş bir GuardianInvitation örneği içerir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

  • https://www.googleapis.com/auth/classroom.guardianlinks.students

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.