REST Resource: userProfiles.guardianInvitations

Ressource: GuardianInvitation

Eine Einladung, zum Betreuer eines bestimmten Nutzers zu werden, wird an eine angegebene E-Mail-Adresse gesendet.

JSON-Darstellung 
{
  "studentId": string,
  "invitationId": string,
  "invitedEmailAddress": string,
  "state": enum (GuardianInvitationState),
  "creationTime": string
}
Felder
studentId

string

ID des Schülers/Studenten (im Standardformat)
invitationId

string

Eindeutige Kennung für diese Einladung.

Schreibgeschützt.
invitedEmailAddress

string

E-Mail-Adresse, an die die Einladung gesendet wurde. Dieses Feld ist nur für Domainadministratoren sichtbar.
state

enum (GuardianInvitationState)

Der Status dieser Einladung.
creationTime

string (Timestamp format)

Der Zeitpunkt, zu dem diese Einladung erstellt wurde.

Schreibgeschützt.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

GuardianInvitationState

Status der Einladung eines Erziehungsberechtigten.

Enums
GUARDIAN_INVITATION_STATE_UNSPECIFIED Sollte nie zurückgegeben werden.
PENDING Die Einladung ist aktiv und es wird auf eine Antwort gewartet.
COMPLETE Die Einladung ist nicht mehr aktiv. Sie wurde akzeptiert, abgelehnt oder zurückgezogen oder sie ist abgelaufen.

Methoden

create

 Es erstellt eine Einladung für den Erziehungsberechtigten und sendet eine E-Mail an den Erziehungsberechtigten, in der er gebeten wird, zu bestätigen, dass er der Erziehungsberechtigte des Schülers ist.

get

 Gibt eine bestimmte Einladung zum Betreuer zurück.

list

 Gibt eine Liste mit Einladungen von Erziehungsberechtigten zurück, die der anfragende Nutzer ansehen darf, gefiltert nach den angegebenen Parametern.

patch

 Ändert die Einladung für Erziehungsberechtigte.