REST Resource: userProfiles.guardianInvitations

Zasób: GuardianInvitation

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

string

Legitymacja 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, w którym znajduje się to zaproszenie.
creationTime

string (Timestamp format)

Czas utworzenia tego zaproszenia.

Tylko do odczytu.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

GuardianInvitationState

Stan zaproszenia opiekuna.

Wartości w polu enum
GUARDIAN_INVITATION_STATE_UNSPECIFIED Nie powinny być nigdy zwracane.
PENDING Zaproszenie jest aktywne i oczekuje na odpowiedź.
COMPLETE Zaproszenie nie jest już aktywne. Mogła zostać zaakceptowana, odrzucona, wycofana lub wygasła.

Metody

create

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

get

 Zwraca określone zaproszenie opiekuna.

list

 Zwraca listę zaproszeń opiekuna, które użytkownik wysyłający prośbę może wyświetlić, przefiltrowaną według podanych parametrów.

patch

 Modyfikuje zaproszenie opiekuna.