Ressource: GuardianInvitation
Eine Einladung, der Erziehungsberechtigte eines bestimmten Nutzers zu werden, die an eine bestimmte E-Mail-Adresse gesendet wurde.
JSON-Darstellung |
---|
{
"studentId": string,
"invitationId": string,
"invitedEmailAddress": string,
"state": enum ( |
Felder | |
---|---|
studentId |
ID des Schülers (im Standardformat) |
invitationId |
Eindeutige Kennung für diese Einladung. Schreibgeschützt. |
invitedEmailAddress |
E-Mail-Adresse, an die die Einladung gesendet wurde. Dieses Feld ist nur für Domainadministratoren sichtbar. |
state |
Der Status, in dem sich diese Einladung befindet. |
creationTime |
Der Zeitpunkt, zu dem diese Einladung erstellt wurde Schreibgeschützt. Zeitstempel im Format RFC3339 UTC ZuZulu“ mit einer Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: |
GuardianInvitationState
Status der Einladung eines Erziehungsberechtigten.
Enums | |
---|---|
GUARDIAN_INVITATION_STATE_UNSPECIFIED |
Sollte nie zurückgegeben werden. |
PENDING |
Die Einladung ist aktiv und wartet auf eine Antwort. |
COMPLETE |
Die Einladung ist nicht mehr aktiv. Er wurde akzeptiert, abgelehnt, zurückgezogen oder ist abgelaufen. |
Methoden |
|
---|---|
|
Es wird eine Einladung für Erziehungsberechtigte erstellt. Der Erziehungsberechtigte wird per E-Mail gebeten, zu bestätigen, dass er der Erziehungsberechtigte des Kindes ist. |
|
Gibt eine bestimmte Einladung für Erziehungsberechtigte zurück. |
|
Gibt eine Liste der Einladungen von Erziehungsberechtigten zurück, die der anfragende Nutzer ansehen darf. Diese Liste ist nach den angegebenen Parametern gefiltert. |
|
Ändert die Einladung eines Erziehungsberechtigten. |