REST Resource: userProfiles.guardianInvitations

Ressource: GuardianInvitation

Eine Einladung an eine bestimmte E-Mail-Adresse, der Vormund eines bestimmten Nutzers zu werden.

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 Bundesstaat, in dem sich diese Einladung befindet.
creationTime

string (Timestamp format)

Der Zeitpunkt, zu dem diese Einladung erstellt wurde.

Schreibgeschützt.

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

GuardianInvitationState

Status einer Einladung für Erziehungsberechtigte.

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. Möglicherweise wurde sie angenommen, abgelehnt, zurückgezogen oder ist abgelaufen.

Methoden

create

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

get

 Gibt eine bestimmte Einladung für Erziehungsberechtigte zurück.

list

 Gibt eine Liste der Einladungen an Erziehungsberechtigte zurück, die der anfragende Nutzer sich ansehen darf, gefiltert nach den angegebenen Parametern.

patch

 Ändert eine Einladung für Erziehungsberechtigte.