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

Abschnitte REST-API-Verweis

Betrifft: Office 365 Education

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

Office 365 Education-APIs helfen bei der Auswahl von Daten Ihres Office 365-Mandanten, die von Microsoft School Data Sync mit der Cloud synchronisiert wurden. Diese Ergebnisse enthalten Informationen über Schulen, Abschnitte, Lehrer, Schüler und Dienstpläne. Jede Klasse in der Schule wird als Abschnitt dargestellt. Die Abschnitte-REST-API bietet Zugang zu den Abschnittseinheiten in Office 365 für Bildungseinrichtungen.

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

Um von Ihrer Anwendung aus auf die Abschnitte-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 Operationen der Abschnitte-REST-API

Abschnitte werden als Vereinheitlichte Gruppen im Azure Active Directory dargestellt. Sie können die Abschnitte, die in einem Mandanten verfügbar sind, die Schüler und Lehrer, die Teil eines jeden Abschnitts sind, und die Schuldetails, zu denen ein Abschnitt gehört, abrufen.

Abschnitte abrufen | Schule eines Abschnitts abrufen | Schüler in einem Abschnitt abrufen | Lehrer in einem Abschnitt abrufen

Testen der APIs

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

Verwendung der Abschnitte-REST-API

Um mit der Abschnitte-REST-API zu interagieren, senden Sie HTTP-Abrufanforderungen.

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

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

Abschnitte werden im Azure Active Directory als Vereinheitlichte Gruppendargestellt. Erweiterungsattribute in den vereinheitlichten Gruppen fügen bildungsspezifische Informationen hinzu.
Beispielsweise enthält das Attribut extension_fe2174665583431c953114ff7268b7b3_Education_CourseNumber die Kursnummer eines Abschnitts.

Abschnittsattribute

Die Beschreibung der Attribute, die bei der Identifizierung der Informationen über den Abschnitt helfen, finden Sie hier: Abschnittsattribute


Abschnitte abrufen

Sie können alle Abschnitte abrufen, einzelne Abschnitte durch dessen id, oder eine Sammlung von Abschnitten, die einem Satz von Abfragefiltern entsprechen.

Alle Abschnitte abrufen

Rufen Sie alle Abschnitte ab, die im Azure Active Directory-Mandanten vorhanden sind.

GET https://graph.microsoft.com/beta/groups?$filter=extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType%20eq%20'Section'

Antworttyp

Eine Sammlung von Abschnittseinheiten.


Einen Abschnitt abrufen

Rufen Sie einen Abschnitt ab mithilfe von id.

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

Antworttyp

Die gewünschte Abschnittsentität.


Schule eines Abschnitts abrufen

Schulen werden im Azure Active Directory als Verwaltungseinheiten dargestellt. Erweiterungsattribute zu diesen Verwaltungseinheiten fügen schulspezifische Informationen hinzu. Zum Beispiel enthält das Attribut extension_fe2174665583431c953114ff7268b7b3_Education_HighestGrade die höchste Jahrgangsstufe in dieser Schule.

Sie können die Schule abrufen, der ein Abschnitt zugeordnet ist, indem Sie Verwaltungseinheiten aufrufen, mithilfe der Eigenschaft SchoolId, die aus der Antwort extension_fe2174665583431c953114ff7268b7b3_Education_SchoolId von Abschnitt abfragen hervorgeht.

GET https://graph.microsoft.com/administrativeUnits?$filter=extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType%20eq%20'School'%20
and%20extension_fe2174665583431c953114ff7268b7b3_Education_SchoolId%20eq%20{school_id}
Erforderliche ParameterTypBeschreibung
URL-Parameter
school_idstringDie ID der Schule im Schulinformationssystem (SIS).

Antworttyp

Eine Schulentität.


Schüler innerhalb eines Abschnitts abrufen

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

Sie können Studenten in einem bestimmten Abschnitt abrufen, indem Sie die Mitglieder der vereinheitlichten Gruppe des Abschnitts abrufen und Benutzer aus der resultierenden Sammlung in Ihrer Anwendung herausfiltern, die keine Schüler sind.

Abschnittsmitglieder abrufen

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

Antworttyp

Eine Sammlung von Benutzern.

Schüler suchen

Eine Sammlung von Benutzern kann Schüler, Lehrer und Nicht-Bildungsbenutzer (z.B. Verwaltungspersonal) enthalten. Sie können eine Sammlung innerhalb Ihrer Anwendung nur nach Schülern filtern. Abfrage nach dem Erweiterungsattribut Education_ObjectType, das gleich ist mit Student.

extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == 'Student'

Lehrer innerhalb eines Abschnitts abrufen

Lehrer werden im Azure Active Directory als Benutzer dargestellt. Benutzererweiterungsattribute fügen lehrerspezifische Informationen hinzu. Beispielsweise enthält das Attribut extension_fe2174665583431c953114ff7268b7b3_Education_TeacherNumber die Lehrernummer des Lehrers.

Sie können Lehrer in einem bestimmten Abschnitt abrufen, indem Sie die Mitglieder der vereinheitlichten Gruppe des Abschnitts abrufen und Benutzer aus der resultierenden Sammlung in Ihrer Anwendung herausfiltern, die keine Lehrer sind.

Abschnittsmitglieder abrufen

GET https://graph.microsoft.com/beta/groups/{id}/members
Erforderliche ParameterTypBeschreibung
URL-Parameter
tenant_idstringDie Azure Active Directory-Mandanten-ID oder der Domänenname.
idstringDie ID der Abschnittsgruppe in 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. Abfrage nach dem Erweiterungsattribut Education_ObjectType, das gleich ist mit Teacher.

extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType == '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