Zasób: GuardianInvitation
Zaproszenie do zostania opiekunem konkretnego użytkownika wysłane na określony adres e-mail.
Zapis JSON |
---|
{
"studentId": string,
"invitationId": string,
"invitedEmailAddress": string,
"state": enum ( |
Pola | |
---|---|
student |
dokument tożsamości ucznia (w standardowym formacie) |
invitation |
Unikalny identyfikator tej zaproszenia. Tylko do odczytu. |
invited |
Adres e-mail, na który zostało wysłane zaproszenie. To pole jest widoczne tylko dla administratorów domeny. |
state |
Stan zaproszenia. |
creation |
Czas utworzenia tego zaproszenia. Tylko do odczytu. Sygnatura czasowa w formacie UTC „Zulu” zdefiniowanym w dokumencie RFC 3339, z dokładnością do nanosekund i maksymalnie 9 miejsc po przecinku. Przykłady: |
GuardianInvitationState
Stan zaproszenia opiekuna.
Wartości w polu enum | |
---|---|
GUARDIAN_INVITATION_STATE_UNSPECIFIED |
Nigdy nie powinny być zwracane. |
PENDING |
Zaproszenie jest aktywne i czeka na odpowiedź. |
COMPLETE |
Zaproszenie jest już nieaktywne. Mogło zostać zaakceptowane, odrzucone, wycofane lub wygasło. |
Metody |
|
---|---|
|
Tworzy zaproszenie dla opiekuna i wysyła do niego e-maila z prośbą o potwierdzenie, że jest on opiekunem ucznia. |
|
Zwraca zaproszenie do konkretnego opiekuna. |
|
Zwraca listę zaproszeń do grupy opiekunów, które użytkownik może wyświetlić, posortowane według podanych parametrów. |
|
Modyfikuje zaproszenie do opiekuna. |