REST Resource: userProfiles.guardianInvitations

Kaynak: Veli Davetiyesi

Belirli bir kullanıcının velisi olmanız 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 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 zaman.

Salt okunur.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

GuardianInvitationState

Veli davetiyesinin durumu.

Sıralamalar
GUARDIAN_INVITATION_STATE_UNSPECIFIED Asla iade edilmemelidir.
PENDING Davetiye etkin ve yanıt bekliyor.
COMPLETE Davetiye artık etkin değil. 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 davetiyelerinin, sağlanan parametrelere göre filtrelenmiş listesini döndürür.

patch

 Veli davetiyesinde değişiklik yapar.