Zasób: Zaproszenie dla opiekuna
Zaproszenie do zostania opiekunem określonego użytkownika wysłane na podany adres e-mail.
Zapis JSON |
---|
{
"studentId": string,
"invitationId": string,
"invitedEmailAddress": string,
"state": enum ( |
Pola | |
---|---|
studentId |
legitymacja ucznia (w formacie standardowym) |
invitationId |
Unikalny identyfikator tego zaproszenia. Tylko do odczytu. |
invitedEmailAddress |
Adres e-mail, na który zostało wysłane zaproszenie. To pole jest widoczne tylko dla administratorów domeny. |
state |
Stan, w którym znajduje się to zaproszenie. |
creationTime |
Godzina utworzenia tego zaproszenia. Tylko do odczytu. Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: |
GuardianInvitationState
Stan zaproszenia opiekuna.
Wartości w polu enum | |
---|---|
GUARDIAN_INVITATION_STATE_UNSPECIFIED |
Nie należy go nigdy zwracać. |
PENDING |
Zaproszenie jest aktywne i czeka na odpowiedź. |
COMPLETE |
Zaproszenie nie jest już aktywne. Mogła zostać zaakceptowana, odrzucona, wycofana lub wygasła. |
Metody |
|
---|---|
|
Tworzy zaproszenie dla opiekuna i wysyła do niego e-maila z prośbą o potwierdzenie, że jest opiekunem ucznia. |
|
Zwraca określone zaproszenie opiekuna. |
|
Zwraca listę zaproszeń opiekunów, które może wyświetlić użytkownik wysyłający prośbę, przefiltrowaną według podanych parametrów. |
|
Modyfikuje zaproszenie opiekuna. |