REST Resource: userProfiles.guardianInvitations

Kaynak: GuardianInvitation

Belirli bir e-posta adresine gönderilen, belirli bir kullanıcının koruyucusu olma davetiyesi.

JSON gösterimi 
{
  "studentId": string,
  "invitationId": string,
  "invitedEmailAddress": string,
  "state": enum (GuardianInvitationState),
  "creationTime": string
}
Alanlar
studentId

string

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

string

Bu davetin benzersiz tanımlayıcısıdır.

Salt okunur.
invitedEmailAddress

string

Davetiyenin gönderildiği e-posta adresi. Bu alan yalnızca alan yöneticileri tarafından görülebilir.
state

enum (GuardianInvitationState)

Bu davetiyenin bulunduğu eyalet.
creationTime

string (Timestamp format)

Bu davetiyenin oluşturulduğu saat.

Salt okunur.

Oluşturulan çıktının her zaman Z normalleştirileceği ve 0, 3, 6 veya 9 kesirli basamak kullanacağı RFC 3339'u kullanır. "Z" dışındaki ofsetler de kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

GuardianInvitationState

Veli davetinin durumu.

Sıralamalar
GUARDIAN_INVITATION_STATE_UNSPECIFIED Hiçbir zaman iade edilmemelidir.
PENDING Davet etkin ve yanıt bekleniyor.
COMPLETE Davetiye artık etkin değil. Davetiye kabul edilmiş, reddedilmiş, geri çekilmiş veya süresi dolmuş olabilir.

Yöntemler

create

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

get

 Belirli bir veli davetiyesini döndürür.

list

 İstekte bulunan kullanıcının görüntülemesine izin verilen veli davetlerinin listesini, sağlanan parametrelere göre filtrelenmiş olarak döndürür.

patch

 Veli davetiyesini değiştirir.