REST Resource: userProfiles.guardianInvitations

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 (GuardianInvitationState),
  "creationTime": string
}
Pola
studentId

string

dokument tożsamości ucznia (w standardowym formacie)
invitationId

string

Unikalny identyfikator tej zaproszenia.

Tylko do odczytu.
invitedEmailAddress

string

Adres e-mail, na który wysłano zaproszenie. To pole jest widoczne tylko dla administratorów domeny.
state

enum (GuardianInvitationState)

Stan, w którym jest to zaproszenie.
creationTime

string (Timestamp format)

Czas utworzenia tego zaproszenia.

Tylko do odczytu.

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Dopuszczalne są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".

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

create

 Tworzy zaproszenie dla opiekuna i wysyła do niego e-maila z prośbą o potwierdzenie, że jest on opiekunem ucznia.

get

 Zwraca zaproszenie do konkretnego opiekuna.

list

 Zwraca listę zaproszeń do grupy opiekunów, które użytkownik może wyświetlić, odfiltrowane według podanych parametrów.

patch

 Modyfikuje zaproszenie do opiekuna.