REST Resource: userProfiles.guardianInvitations

Kaynak: GuardianInvitation

Belirli bir kullanıcının velisi olması için belirli bir 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 davetin benzersiz tanımlayıcısı.

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 durumu.
creationTime

string (Timestamp format)

Bu davetiyenin oluşturulduğu zaman.

Salt okunur.

Oluşturulan çıkışın her zaman Z ile normalleştirildiği ve 0, 3, 6 veya 9 kesirli basamak kullandığı RFC 3339'u kullanır. "Z" dışındaki saat farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

GuardianInvitationState

Veli davetiyesinin durumu.

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

Yöntemler

create

 Veli daveti 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 davetiyelerinin listesini, sağlanan parametrelere göre filtrelenmiş olarak döndürür.

patch

 Veli davetiyesini değiştirir.