REST Resource: userProfiles.guardianInvitations

Zasób: GuardianInvitation

Zaproszenie do zostania opiekunem określonego 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

Identyfikator ucznia (w formacie standardowym)
invitationId

string

Unikalny identyfikator tego zaproszenia.

Tylko do odczytu.
invitedEmailAddress

string

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

enum (GuardianInvitationState)

Stan zaproszenia.
creationTime

string (Timestamp format)

Czas utworzenia tego zaproszenia.

Tylko do odczytu.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i używają 0, 3, 6 lub 9 cyfr ułamkowych. Akceptowane 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 powinna być zwracana.
PENDING Zaproszenie jest aktywne i oczekuje na odpowiedź.
COMPLETE Zaproszenie nie jest już aktywne. Mogło zostać zaakceptowane, odrzucone, wycofane lub mogło wygasnąć.

Metody

create

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

get

 Zwraca konkretne zaproszenie opiekuna.

list

 Zwraca listę zaproszeń dla opiekunów, które użytkownik wysyłający żądanie może wyświetlić, odfiltrowaną według podanych parametrów.

patch

 Modyfikuje zaproszenie opiekuna.