- Ressource: GuardianInvitation
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- GuardianInvitationState
- Methoden
Ressource: GuardianInvitation
Eine Einladung, Betreuer eines bestimmten Nutzers zu werden, die an eine angegebene E-Mail-Adresse gesendet wird.
JSON-Darstellung |
---|
{
"studentId": string,
"invitationId": string,
"invitedEmailAddress": string,
"state": enum ( |
Felder | |
---|---|
studentId |
ID des Schülers/Studenten (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 dieser Einladung. |
creationTime |
Der Zeitpunkt, zu dem die Einladung erstellt wurde. Schreibgeschützt. Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: |
GuardianInvitationState
Status der Einladung für einen 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 möglicherweise akzeptiert, abgelehnt, zurückgezogen oder ist abgelaufen. |
Methoden |
|
---|---|
|
erstellt eine Einladung für Erziehungsberechtigte und sendet eine E-Mail an sie, in der sie gebeten werden, zu bestätigen, dass sie der Erziehungsberechtigte des Schülers sind. |
|
Gibt eine bestimmte Einladung für einen Erziehungsberechtigten zurück. |
|
Gibt eine Liste der Einladungen für Erziehungsberechtigte zurück, die der anfragende Nutzer ansehen darf, gefiltert nach den angegebenen Parametern. |
|
Ändert die Einladung eines Erziehungsberechtigten. |