Method: userProfiles.guardianInvitations.create

Bir veli davetiyesi oluşturulur ve veliye, öğrencinin velisi olduğunu onaylamasını isteyen bir e-posta gönderilir.

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

İstek nesnesinin studentId ve invitedEmailAddress alanları ayarlanmış olmalıdır. Bu alanların veya istekte başka alanların ayarlanmaması hataya neden olur.

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

  • PERMISSION_DENIED Mevcut kullanıcının velileri yönetme izni yoksa, velinin ilgili öğrenci için çok sayıda isteği zaten reddetmiş olması, söz konusu alan için velilerin etkinleştirilmemesi veya diğer erişim hataları.
  • Öğrenci veya veli, veli bağlantı sınırını aştıysa RESOURCE_EXHAUSTED.
  • INVALID_ARGUMENT Veli e-posta adresi geçerli değilse (örneğin, çok uzunsa) veya sağlanan öğrenci kimliğinin biçimi tanınmıyorsa (e-posta adresi ya da bu API'ya ait bir userId olmayan kimlik). Salt okunur alanlar ayarlanırsa veya state alanı PENDING dışında bir değere ayarlanırsa bu hata da döndürülür.
  • Sağlanan öğrenci kimliği geçerli bir öğrenci kimliğiyse ancak Classroom'da bu öğrenciyle ilgili kayıt yoksa NOT_FOUND.
  • Öğrenci ve invitedEmailAddress için bekleyen bir veli davetiyesi varsa veya sağlanan invitedEmailAddress, bu kullanıcının mevcut Guardian Google hesabıyla 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 gövdesi, yeni oluşturulan GuardianInvitation örneğini 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 göz atın.