Gibt eine Liste der Erziehungsberechtigten zurück, die der anfragende Nutzer sehen darf, beschränkt auf die Erziehungsberechtigten, die der Anfrage entsprechen.
Wenn Sie die Erziehungsberechtigten aller Schüler auflisten möchten, für die der anfragende Nutzer die Erziehungsberechtigten aufrufen darf, verwenden Sie das buchstäbliche Zeichen -
für die Schüler-/Studenten-ID.
Diese Methode gibt die folgenden Fehlercodes zurück:
PERMISSION_DENIED
, wenn einestudentId
angegeben ist und der anfragende Nutzer nicht berechtigt ist, die Informationen zum Erziehungsberechtigten für diesen Schüler oder Studenten anzusehen, wenn"-"
alsstudentId
angegeben ist und der Nutzer kein Domainadministrator ist, wenn keine Erziehungsberechtigten für die betreffende Domain aktiviert sind, wenn der FilterinvitedEmailAddress
von einem Nutzer festgelegt wurde, der kein Domainadministrator ist, oder wenn andere Zugriffsfehler vorliegen.INVALID_ARGUMENT
, wenn einestudentId
angegeben ist, ihr Format jedoch nicht erkannt wird (weder eine E-Mail-Adresse noch einstudentId
von der API noch der literale Stringme
). Kann auch zurückgegeben werden, wenn ein ungültigerpageToken
angegeben wird.NOT_FOUND
, wenn einestudentId
angegeben ist und ihr Format erkannt werden kann, aber in Classroom sind keine Aufzeichnungen zu diesem Schüler/Studenten vorhanden.
HTTP-Anfrage
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
Parameter | |
---|---|
studentId |
Sie können die Ergebnisse nach dem Schüler/Studenten filtern, mit dem der Erziehungsberechtigte verknüpft ist. Folgende Kennzeichnungen sind möglich:
|
Abfrageparameter
Parameter | |
---|---|
invitedEmailAddress |
Sie können die Ergebnisse nach der E-Mail-Adresse filtern, an die die ursprüngliche Einladung gesendet wurde, und so diesen Link für Erziehungsberechtigte erhalten. Dieser Filter kann nur von Domainadministratoren verwendet werden. |
pageToken |
Die |
pageSize |
Maximale Anzahl der Elemente, die zurückgegeben werden sollen. Null oder nicht angegeben bedeutet, dass der Server einen Höchstwert zuweisen kann. Der Server gibt möglicherweise weniger als die angegebene Anzahl von Ergebnissen zurück. |
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Antwort beim Auflisten der Erziehungsberechtigten.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
JSON-Darstellung |
---|
{
"guardians": [
{
object ( |
Felder | |
---|---|
guardians[] |
Erziehungsberechtigte auf dieser Seite mit Ergebnissen, die die in der Anfrage angegebenen Kriterien erfüllt haben. |
nextPageToken |
Token, das die nächste Ergebnisseite identifiziert, die zurückgegeben werden soll. Wenn das Feld leer ist, sind keine weiteren Ergebnisse verfügbar. |
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly
https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
https://www.googleapis.com/auth/classroom.guardianlinks.students
Weitere Informationen finden Sie im Leitfaden zur Autorisierung.