Arbeiten mit Education-APIs in Microsoft Graph
Wichtig
Die APIs unter der /beta
Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.
Die Bildungs-APIs in Microsoft Graph erweitern Microsoft 365-Ressourcen und -Daten mit Informationen, die für Bildungsszenarien relevant sind, einschließlich Schulen, Schüler, Lehrer, Kurse, Registrierungen und Aufgaben. Dies erleichtert das Erstellen von Lösungen, die in Bildungsressourcen integriert werden.
Die Bildungs-APIs umfassen Listenressourcen und Zuordnungsressourcen, die Sie für die Interaktion mit den Listen- und Zuordnungsdiensten in Microsoft Teams verwenden können. Sie können diese Ressourcen verwenden, um eine Schulliste zu verwalten und Schüleraufgaben zu automatisieren.
Autorisierung
Damit die Education-APIs in Microsoft Graph aufgerufen werden können, muss Ihre App ein Zugriffstoken erwerben. Weitere Informationen zu Zugriffstoken finden Sie unter Abrufen von Zugriffstoken zum Aufrufen von Microsoft Graph. Zudem muss Ihre App über die entsprechenden Berechtigungen verfügen. Weitere Informationen finden Sie unter Education-Berechtigungen.
App-Berechtigungen zum Aktivieren der Zustimmung von Schul-IT-Administratoren
Um Apps bereitzustellen, die in Education-APIs in Microsoft Graph integriert sind, müssen Schul-IT-Administratoren zunächst ihre Zustimmung für die von der App angeforderten Berechtigungen erteilen. Diese Zustimmung muss nur einmal erteilt werden, sofern sich die Berechtigungen nicht ändern. Nachdem der Administrator seine Zustimmung erteilt hat, wird die App für alle Benutzer im Mandanten bereitgestellt.
Verwenden Sie den folgenden REST-Aufruf, um ein Zustimmungsdialogfeld auszulösen.
GET https://login.microsoftonline.com/{tenant}/adminconsent?
client_id={clientId}&state=12345&redirect_uri={redirectUrl}
Parameter | Beschreibung |
---|---|
Mandant | Mandanten-ID der Schule. Verwenden Sie die vollständige-ID, die „onmicrosoft.com“ enthält. |
clientId | Client-ID der App. |
redirectUrl | App-Umleitungs-URL. |
Listenerstellung
Mit Listenerstellungs-APIs können Sie Daten von einem Microsoft 365-Mandanten der Schule extrahieren, der mit Microsoft School Data Sync bereitgestellt wurde. Diese APIs bieten Zugriff auf Informationen zu Schulen, Abschnitten, Lehrern, Schülern, Studenten und Listen. Die APIs unterstützen sowohl Szenarien vom Typ „Nur App“ (Synchronisierung) als auch vom Typ „App und Benutzer“ (interaktiv). APIs, die interaktive Szenarien unterstützen, erzwingen auf Grundlage der Benutzerrolle, die die API aufruft, regionsspezifische RBAC-Richtlinien. Dies ermöglicht eine konsistente API und eine minimale Richtlinienoberfläche, unabhängig von der Verwaltungskonfiguration innerhalb der Mandanten. Die APIs bieten darüber hinaus auch bildungsspezifische Berechtigungen, um sicherzustellen, dass der richtige Benutzer auf die Daten zugreifen kann.
Mithilfe von Listenerstellungs-APIs erhält der App-Benutzer Antworten auf die folgenden Fragen:
- Wer bin ich?
- An welchen Kursen nehme ich teil bzw. welche Kurse unterrichte ich?
- Was muss ich wann tun?
Die Listenerstellungs-APIs bieten die folgenden zentralen Ressourcen:
- educationSchool: Schule.
- educationClass: Kurs in einer Schule.
- educationTerm: Ein festgelegter Teil des akademischen Jahres.
- educationTeacher: Ein Benutzer mit der primären Rolle „Lehrer“.
- educationStudent: Ein Benutzer mit der primären Rolle „Schüler/Student“.
Die Listenerstellungs-APIs unterstützen die folgenden Szenarien:
- Auflisten aller Schulen
- Auflisten von Schulen, in denen ein Kurs unterrichtet wird
- Auflisten von Schulen für einen Benutzer
- Abrufen aller Kurse
- Abrufen von Kursen einer Schule
- Auflisten von Kursen für einen Benutzer
- Hinzufügen von Kursen zu einer Schule
- Abrufen von Schülern/Studenten und Lehrern für einen Kurs
- Hinzufügen von Mitgliedern zu einem Kurs
- Auflisten von Lehrern für einen Kurs
- Abrufen von Benutzern in einer Schule
Aufgaben
Sie können die aufgabenbezogenen Education-APIs verwenden, um Aufgaben in Microsoft Teams zu integrieren. Microsoft Teams in Microsoft 365 for Education basiert auf den gleichen Education-APIs und bietet Ihnen eine Anwendungsmöglichkeit für die APIs. Ihre App kann diese APIs für die Interaktion mit Aufgaben während des gesamten Aufgabenlebenszyklus verwenden.
Die Aufgaben-APIs bieten die folgenden zentralen Ressourcen:
- educationAssignment: Das Kernobjekt der Aufgaben-API. Stellt Aufgaben oder Arbeitseinheiten dar, die einem Lernenden oder Teammitglied in einem Kurs als Teil des Unterrichts zugewiesen werden.
- educationSubmission: Stellt die Ressourcen dar, die eine Person (oder Gruppe) für eine Aufgabe abgibt sowie die zugeordnete Note und das Feedback für diese Aufgabe.
- educationResource: Stellt den Lerngegenstand dar, das zugewiesen oder abgegeben wird. Eine EducationResource ist einem EducationAssignment und/oder einer EducationSubmission zugeordnet.
Die Aufgaben-APIs unterstützen die folgenden Szenarien:
- Aufgabe erstellen
- Aufgabe veröffentlichen
- Aufgabenressource erstellen
- Abgaberessource erstellen
- Aufgabe abgeben
- Aufgabe zurücknehmen
- Noten und Feedback an Lernende senden
- Aufgabendetails abrufen
Im Folgenden finden Sie einige häufige Anwendungsfälle für die aufgabenbezogene Education-APIs.
Anwendungsfall | Beschreibung | Siehe auch |
---|---|---|
Aufgaben erstellen | Ein externes System kann eine Aufgabe für den Kurs erstellen und Ressourcen an die Aufgabe anfügen. | Aufgabe erstellen |
Aufgabeninformationen lesen | Eine Analyseanwendung kann Informationen zu Aufgaben und Abgaben von Lernenden abrufen, einschließlich Datumsangaben und Noten. | Aufgabe abrufen |
Abgaben von Lernenden nachverfolgen | Ihre App kann ein Dashboard für Lehrkräfte bereitstellen, das zeigt, wie viele Abgaben von Lernenden bewertet werden müssen. | Abgabenressource |
Verwaltung der Schuldatensynchronisierung
School Data Sync hilft dabei, den Prozess des Importierens und Synchronisierens von Listendaten aus Schülerinformationssystemen mit Microsoft Entra ID und Microsoft 365 zu automatisieren. Sie können die Verwaltungs-APIs für die Schuldatensynchronisierung in Microsoft Graph verwenden, um die Synchronisierung aus einer CSV-Datei oder einem unterstützten SIS-API-Connector einzurichten.
Die Verwaltungs-APIs für die Schuldatensynchronisierung unterstützen die folgenden Szenarien:
- Auflisten von Synchronisierungsprofilen
- Abrufen des Synchronisierungsprofils
- Erstellen eines Synchronisierungsprofils
- Synchronisierungsprofil löschen
- Anhalten einer fortlaufenden Synchronisierung
- Fortsetzen einer angehaltenen Synchronisierung
- Zurücksetzen einer Synchronisierung
- Starten der Synchronisierung für hochgeladene Dateien
- Abrufen einer Upload-URL
- Abrufen status einer Synchronisierung
- Abrufen von Synchronisierungsfehlern
Nächste Schritte
Verwenden Sie die Microsoft Graph-Bildungs-APIs, um Bildungslösungen zu erstellen, die auf Schüleraufgaben und Schullisten zugreifen. So erhalten Sie weitere Informationen:
- Erfahren Sie, welche Ressourcen und Methoden für Ihr Szenario am besten geeignet sind.
- Probieren Sie die API im Graph-Tester aus.
Feedback
https://aka.ms/ContentUserFeedback.
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unterFeedback senden und anzeigen für