REST Resource: userProfiles.guardianInvitations

Ressource: GuardianInvitation

Eine Einladung, Erziehungsberechtigter eines bestimmten Nutzers zu werden, die an eine bestimmte E‑Mail-Adresse gesendet wurde.

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

Die 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.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

GuardianInvitationState

Status einer Einladung für Erziehungsberechtigte.

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

Methoden

create

 Erstellt eine Einladung für Erziehungsberechtigte und sendet eine E‑Mail an den Erziehungsberechtigten, 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 mit Einladungen für Erziehungsberechtigte zurück, die der anfragende Nutzer ansehen darf. Die Liste wird nach den angegebenen Parametern gefiltert.

patch

 Ändert eine Einladung für Erziehungsberechtigte.