Freigeben über

Arbeiten mit Education-APIs in Microsoft Graph

  • Artikel

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.

Authorization

Um die Bildungs-APIs in Microsoft Graph aufzurufen, muss Ihre App ein Zugriffstoken abrufen. Weitere Informationen zu Zugriffstoken finden Sie unter Abrufen von Zugriffstoken zum Aufrufen von Microsoft Graph. Ihre App benötigt auch die entsprechenden Berechtigungen. Weitere Informationen finden Sie unter Education-Berechtigungen.

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:

Die Listenerstellungs-APIs unterstützen die folgenden Szenarien:

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:

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

Schularbeit

Sie können Classwork als zentrale Anlaufstelle verwenden, um Kursressourcen zu erstellen und zu organisieren, einschließlich Aufgaben, OneNote-Kursnotizbuchseiten, Weblinks, Dateien und Teams-Kanäle. Dies bedeutet, dass Sie nicht mehr durch mehrere Apps und Plattformen navigieren müssen, um das zu finden, was Sie benötigen. Mit Classwork können Sie eine Ansicht von Inhalten und Ressourcen zusammenstellen, die Ihren Kursteilnehmern hilft, durch den Kurs zu navigieren und alles an einem Ort zu sehen.

Die Classwork-API stellt die folgenden wichtigen Ressourcen bereit:

  • educationModule : Ein Modul ist einem Kurs zugeordnet. Stellt eine Gruppe einzelner Lernressourcen dar, die systematisch organisiert sind.
  • educationModuleResource : Ein Wrapperobjekt, das die einem Modul zugeordneten Ressourcen speichert. Der Kursteilnehmer kann diese Ressource nicht aktualisieren. Dies ist ein Handzettel des Lehrers an den Kursteilnehmer, bei dem nichts abgegeben werden muss.

Die folgenden Listen zeigen die Szenarien, die von der Classwork-API unterstützt werden.

Module

Die ressource educationModule unterstützt die folgenden Szenarien:

Modulressourcen

Die ressource educationModuleResource unterstützt die folgenden Szenarien:

Allgemeine Anwendungsfälle

Die folgende Tabelle enthält einige gängige Anwendungsfälle für die modulbezogenen Bildungs-APIs.

Anwendungsfall Beschreibung Siehe auch
Erstellen eines Moduls Nur Lehrkräfte in einem Kurs können ein Modul erstellen. Module beginnen im Entwurfszustand, was bedeutet, dass die Kursteilnehmer die Module erst bei der Veröffentlichung sehen. EducationModule erstellen
Module auflisten Ein Lehrer oder eine Anwendung mit Anwendungsberechtigungen kann alle Modulobjekte für den Kurs sehen. Kursteilnehmer können nur veröffentlichte Module sehen. Klassenmodule auflisten
Veröffentlichen eines Moduls Ändert den Status eines educationModule von seinem ursprünglichen draft Status in den published Status. educationModule: veröffentlichen
Erstellen einer Ressource in einem Modul Nur Lehrkräfte können diesen Vorgang ausführen. Erstellen von educationModuleResource
Auflisten von Modulressourcen Ruft alle educationModuleResource-Objekte ab, die einem Modul zugeordnet sind. Nur Lehrkräfte, Kursteilnehmer und Anwendungen mit Anwendungsberechtigungen können diesen Vorgang ausführen. Auflisten von Modulressourcen

Verwaltung der Schuldatensynchronisierung

School Data Sync hilft dabei, den Prozess des Importierens und Synchronisierens von Listendaten aus Kursteilnehmerinformationssystemen 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:

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.