Method: userProfiles.guardianInvitations.patch

Veli davetiyesinde değişiklik yapar.

Şu anda geçerli tek değişiklik, state değerinin PENDING iken COMPLETE olarak değiştirilmesidir. Bu durum davetiyeyi geri çeker.

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, veliler ilgili alan için etkinleştirilmemişse veya diğer erişim hatalarında.
  • Veli bağlantısı PENDING durumunda değilse FAILED_PRECONDITION.
  • Sağlanan öğrenci kimliğinin biçimi tanınamıyorsa (e-posta adresi veya bu API'den gelen bir userId değilse), iletilen GuardianInvitation öğesinde COMPLETE dışında bir state varsa ya da state dışındaki alanları değiştiriyorsa INVALID_ARGUMENT.
  • Sağlanan öğrenci kimliği geçerli bir öğrenci kimliğiyse ancak Classroom'da bu öğrenciyle ilgili kayıt yoksa veya id alanı Classroom tarafından bilinen bir veli davetini göstermiyorsa NOT_FOUND.

HTTP isteği

PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}

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

Yol parametreleri

Parametreler
studentId

string

Veli davetiyesi değiştirilecek öğrencinin kimliği.
invitationId

string

Değiştirilecek GuardianInvitation için id alanı.

Sorgu parametreleri

Parametreler
updateMask

string (FieldMask format)

Kursta hangi alanların güncelleneceğini tanımlayan maske. Bu alan güncelleme için gereklidir. Geçersiz alanlar belirtilirse güncelleme başarısız olur. Aşağıdaki alanlar geçerlidir:

  • state

Bir sorgu parametresinde ayarlandığında bu alan şu şekilde belirtilmelidir:

updateMask=<field1>,<field2>,...

Bu, tam nitelikli alan adlarının virgülle ayrılmış bir listesidir. Örnek: "user.displayName,photo".

İstek içeriği

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

Yanıt gövdesi

Başarılıysa yanıt metni, GuardianInvitation öğesinin bir ö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.