Method: userProfiles.guardianInvitations.patch

Veli davetiyesini değiştirir.

Şu anda tek geçerli değişiklik, state değerinin PENDING yerine COMPLETE olarak değiştirilmesidir. Bu işlem, davetin geri çekilmesine neden olur.

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

  • Mevcut kullanıcının velileri yönetme izni yoksa, veliler söz konusu alan için etkinleştirilmediyse veya başka erişim hataları varsa PERMISSION_DENIED.
  • FAILED_PRECONDITION, veli bağlantısı PENDING durumunda değilse.
  • Sağlanan öğrenci kimliğinin biçimi tanınamıyorsa (e-posta adresi veya bu API'den bir userId değilse) veya iletilen GuardianInvitation'de 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'da bilinen bir veli davetini belirtmiyorsa 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 öğesinin id alanı.

Sorgu parametreleri

Parametreler
updateMask

string (FieldMask format)

Kurstaki hangi alanların güncelleneceğini tanımlayan maske. Güncelleme yapmak için bu alanın doldurulması gerekir. Geçersiz alanlar belirtilirse güncelleme başarısız olur. Aşağıdaki alanlar geçerlidir:

  • state

Bu alan, sorgu parametresinde ayarlandığında şu şekilde belirtilmelidir:

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

Bu, alanların tam nitelikli 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 bakın.