Table of contents
TOC
Inhaltsverzeichnis reduzieren
Inhaltsverzeichnis erweitern
Zuletzt aktualisiert: 25.07.2018

Schulen-REST-API-Verweis

Betrifft: Office 365 Education

Diese Dokumentation umfasst Funktionen, die sich derzeit in der Vorschauversion befinden.

Office 365 Education-APIs helfen bei der Auswahl von Daten Ihres Office 365-Inhabers, die von Microsoft School Data Sync mit der Cloud synchronisiert wurden. Diese Ergebnisse enthalten Informationen über Schulen, Bereiche, Lehrer, Schüler und Dienstplaninformationen. Die Schul REST API bietet Zugang zu den Schulentitäten in Office 365 für Mandanten im Bildungsbereich.

Die API basiert auf Microsoft Azure Active Directory und OAuth zur Authentifizierung von Anwendungsanforderungen.

Um von Ihrer Anwendung aus auf die Schüler-REST-API zuzugreifen, müssen Sie diese in Azure Active Directory registrieren. Sie müssen außerdem Authentifizierungstoken verwalten sowie die richtige URL und Abfragen erstellen, um Ihren Anforderungen gerecht zu werden. Die folgenden Beispiele können Ihnen bei der Erstellung Ihrer Abfragen behilflich sein.

Alle Schulen REST API Operationen

Schulen werden als Verwaltungseinheiten im Azure Active Directory dargestellt. Sie können die Schulen bekommen, die bei einem Inhaber verfügbar sind, aber auch die Abschnitte, Schüler und Lehrer, die Teil jeder Schul-Einheit sind.

Schulen abrufen | Abschnitte innerhalb einer Schule abrufen | Schüler innerhalb einer Schule | Lehrer innerhalb einer Schule

Testen der APIs

Alle Dienstplaninformation-APIs der Schulen können in einer EDU-Umgebung mit Graph-Testergetestet werden. Navigieren Sie zum Graph Explorer, melden Sie sich mit Ihren O365 EDU-Umgebungsdaten an, wählen Sie "Beta" als Version, kopieren Sie die URLs und überprüfen Sie die Antwort.

Verwendung der Schulen-REST-API

Um mit der Schüler-REST-API zu interagieren, senden Sie HTTP-Abrufanfragen.

Alle REST-API-Anforderungen von Schulen verwenden die folgende Stamm-URL:

https://graph.microsoft.com/beta/administrativeUnits

Schulen werden im Azure Active Directory als Administrative Einheitendargestellt. Erweiterungsattribute auf den Verwaltungseinheiten fügen bildungsspezifische Informationen hinzu.
Beispielsweise enthält das Attribut extension_fe2174665583431c953114ff7268b7b3_Education_HighestGrade die höchste Stufe innerhalb der Schule.

Hinweis Alle Anforderungen sind erforderlich, um 'beta' in der URL anzugeben.

Schul-Attribute

Die Beschreibung der Attribute, die bei der Identifizierung der Informationen über die Schule helfen, finden Sie hier: Schul-Attribute


Schulen erhalten

Sie können alle Schulen erhalten oder nur eine einzelne Schule id, oder eine Sammlung von Schulen, die zu einer Reihe von Abfrage-Filter gehören.

Alle Schulen erhalten

Erhalen Sie alle Schulen, die im Azure Active Directory-Mandanten vorhanden sind.

https://graph.microsoft.com/beta/administrativeUnits/?$filter=extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType%20eq%20'School'

Antworttyp

Eine Sammlung von Schul-Entitäten.


Eine Schule erhalten

Erhalten Sie eine Schule mit der id.

GET https://graph.microsoft.com/beta/administrativeUnits/{id}
Erforderliche ParameterTypBeschreibung
URL-Parameter
idstringDie Objekt-ID der Schulverwaltung im Azure Active Directory.

Antworttyp

Die gewünschte Schulentität.


Abschnitte innerhalb einer Schule abrufen

Bereiche werden im Azure Active Directory als Vereinheitlichte Gruppendargestellt. Erweiterungsattribute auf den vereinheitlichten Gruppen fügen bereichsspezifische Informationen hinzu. Beispielsweise enthält das Attribut extension_fe2174665583431c953114ff7268b7b3_Education_CourseName den Kursnamen für den Bereich.

Sie können Abschnitte für eine bestimmte Schule erhalten, indem Sie nach Gruppen suchen, die auf ihrer Schul-ID basieren, indem Sie das extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType Attribut und das extension_fe2174665583431c953114ff7268b7b3_Education_SyncSource_SchoolId Attribut zusammen in der Abfrage verwenden.

GET  https://graph.microsoft.com/beta/groups?$filter=extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType%20eq%20'Section'%20and%20extension_fe2174665583431c953114ff7268b7b3_Education_SyncSource_SchoolId%20eq%20'10002'
Erforderliche ParameterTypBeschreibung
URL-Parameter
school_idstringDie ID der Schule im Schulinformationssystem (SIS), Ausgabe der get schools

Antworttyp

Eine Sammlung von Abschnittseinheiten.


Schüler in einer Schule erhalten

Schüler werden im Azure Active Directory als Benutzer dargestellt. Erweiterungsattribute zu den Benutzern fügen schülerspezifische Informationen hinzu. Beispielsweise enthält das Attribut extension_fe2174665583431c953114ff7268b7b3_Education_Grade die Klassenstufe des Schülers.

Sie können Schüler in einer bestimmten Schule bekommen, indem Sie die Mitglieder der Schulverwaltung holen und nichtstudentische Benutzer aus der resultierenden Sammlung in Ihrer Anwendung herausfiltern.

Holen Sie sich Schulmitglieder

GET https://graph.microsoft.com/beta/administrativeUnits/{id}/members
Erforderliche ParameterTypBeschreibung
URL-Parameter
idstringDie Objekt-ID der Schulverwaltung im Azure Active Directory.

Antworttyp

Eine Sammlung von Benutzern.

Schüler suchen

ark class="inGlossary">Schüler finden Sie können eine Sammlung innerhalb Ihrer Anwendung nur nach Schülern filtern. Suchen Sie das Attribut Education_ObjectType Erweiterung auf gleich Student.

extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'Student'
GET https://graph.microsoft.com/beta/administrativeUnits/<GUID_AAD_ID_OF_SCHOOL_AU>/members/$/microsoft.graph.user?$filter=extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType%20eq%20'Student'

Holen Sie sich Lehrer innerhalb einer Schule

Lehrer werden im Azure Active Directory als Benutzer dargestellt. Erweiterungsattribute zu den Benutzern fügen schülerspezifische Informationen hinzu. Beispielsweise enthält das Attribut extension_fe2174665583431c953114ff7268b7b3_Education_TeacherNumber die Lehrernummer des Lehrers.

Sie können Schüler in einer bestimmten Schule bekommen, indem Sie die Mitglieder der Schulverwaltung hinzuholen und nichtstudentische Benutzer aus der resultierenden Sammlung in Ihrer Anwendung herausfiltern.

Holen Sie sich Schulmitglieder

GET https://graph.microsoft.com/beta/administrativeUnits/{id}/members
Erforderliche ParameterTypBeschreibung
URL-Parameter
idstringDie Objekt-ID der Schulverwaltung im Azure Active Directory.

Antworttyp

Eine Sammlung von Benutzern.

Lehrer suchen

Eine Sammlung von Benutzern kann Schüler, Lehrer und Nicht-Bildungsbenutzer (z.B. Verwaltungspersonal) enthalten. Sie können die Sammlung innerhalb Ihrer Anwendung nach Lehrern filtern. Suchen Sie das Attribut Education_ObjectType Erweiterung als Ausgleich Teacher.

extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'Teacher'
GET https://graph.microsoft.com/beta/administrativeUnits/<GUID_AAD_ID_OF_SCHOOL_AU>/members/$/microsoft.graph.user?$filter=extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType%20eq%20'Teacher'

Nächste Schritte

Einige der anderen Ressourcen zum Thema Bildung, die Sie interessieren könnten

Egal, ob Sie bereit sind, eine App zu erstellen oder einfach nur mehr darüber erfahren möchten, wir haben alles im Griff.

Oder erfahren Sie mehr über die Verwendung der Office 365-Plattform:

© 2018 Microsoft