REST Resource: userProfiles.guardianInvitations

Kaynak: Veli Daveti

Belirli bir kullanıcının velisi olmak için gönderilen, belirtilen e-posta adresine gönderilen davetiye.

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 davetiyenin benzersiz tanımlayıcısı.

Salt okunur.
invitedEmailAddress

string

Davetiyenin gönderildiği e-posta adresi. Bu alanı yalnızca alan yöneticileri görebilir.
state

enum (GuardianInvitationState)

Bu davetiyenin bulunduğu eyalet.
creationTime

string (Timestamp format)

Bu davetiyenin oluşturulduğu tarih.

Salt okunur.

Nanosaniye çözünürlüğe ve en fazla dokuz kesir basamağına sahip, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

GuardianInvitationState

Veli davetiyesinin durumu.

Sıralamalar
GUARDIAN_INVITATION_STATE_UNSPECIFIED Hiçbir zaman döndürülmemelidir.
PENDING Davetiye etkin ve yanıt bekliyor.
COMPLETE Davetiye artık etkin değil. Hesap kabul edilmiş, reddedilmiş, geri çekilmiş veya süresi dolmuş olabilir.

Yöntemler

create

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

get

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

list

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

patch

 Veli davetiyesinde değişiklik yapar.