Arbeiten mit Education-APIs in Microsoft Graph
Wichtig
APIs unter der /beta Version in Microsoft Graph können geändert werden. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in Version 1.0 verfügbar ist, verwenden Sie die Versionsauswahl .
Die Education-APIs in Microsoft Graph verbessern Microsoft 365-Ressourcen und-Daten mit Informationen, die für Bildungsszenarien relevant sind, einschließlich Schulen, Kursteilnehmern, Lehrkräften, Klassen, Anmeldungen und Aufgaben. Dies erleichtert das Erstellen von Lösungen, die in Bildungsressourcen integriert werden.
Die Education-APIs umfassen Dienstplan Ressourcen und Zuweisungs Ressourcen, die Sie für die Interaktion mit den Dienstplan-und Zuordnungs Diensten in Microsoft Teams verwenden können. Sie können diese Ressourcen zum Verwalten eines Schul Arbeitsplans und zum Automatisieren von Schüler Zuweisungen verwenden.
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 Dialogfeld für die Zustimmung 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 Zuordnungs bezogenen Education-APIs für die Integration in Zuweisungen in Microsoft Teams verwenden. Microsoft Teams in Microsoft 365 für Education basiert auf denselben Education-APIs und stellt einen Anwendungsfall für die Möglichkeiten bereit, die Sie mit den APIs ausführen können. Ihre APP kann diese APIs verwenden, um mit Zuweisungen während des gesamten Zuweisungs Lebenszyklus zu interagieren.
Die Zuweisungs-APIs bieten die folgenden Schlüsselressourcen:
- educationAssignment -das Kernobjekt der Zuweisungs-API. Stellt eine Aufgabe oder Arbeitseinheit dar, die einem Schüler oder Teammitglied in einer Klasse als Teil ihrer Studie zugewiesen ist.
- educationSubmission – stellt die Ressourcen dar, die eine Person (oder Gruppe) für eine Zuordnung und die zugehörige Note und das Feedback für diese Zuordnung vorlegt.
- educationResource – stellt das Lernobjekt dar, das zugewiesen oder übermittelt wird. Ein educationResource ist einem educationAssignment und/oder einem educationSubmissionzugeordnet.
Die Zuweisungs-APIs unterstützen die folgenden Szenarien:
- Zuweisung erstellen
- Zuordnung veröffentlichen
- Zugeordnete Ressource erstellen
- Übermittlungs Ressource erstellen
- Zuweisung übermitteln
- Absenden der Aufgabe
- Zurückgeben von Noten und Feedback an Schüler
- Zuordnungsdetails abrufen
Im folgenden finden Sie einige häufige Anwendungsfälle für die Zuweisungs bezogenen Bildungs-APIs.
| Anwendungsfall | Beschreibung | Siehe auch |
|---|---|---|
| Erstellen von Zuordnungen | Ein externes System kann eine Zuordnung für die Klasse erstellen und Ressourcen an die Zuordnung anfügen. | Zuweisung erstellen |
| Lesen von Zuordnungsinformationen | Eine Analyseanwendung kann Informationen zu Zuordnungen und Teilnehmern, einschließlich Datum und Noten, erhalten. | Zuweisung abrufen |
| Überwachen von Kursteilnehmer Beiträgen | Ihre APP kann ein Lehrer Dashboard bereitstellen, das zeigt, wie viele Übermittlungen von Kursteilnehmern benotet werden müssen. | Übermittlungs Ressource |
School Data Sync-Verwaltung
School Data Sync unterstützt die Automatisierung des Importierens und Synchronisierens von Dienstplan Daten aus Studenten Informationssystemen mit Azure Active Directory (Azure AD) und Microsoft 365. Sie können die School Data Sync Management-APIs in Microsoft Graph verwenden, um die Synchronisierung aus einer CSV-Datei oder aus einem unterstützten SIS-API-Konnektor einzurichten.
Die School Data Sync Management-APIs unterstützen die folgenden Szenarien:
- Auflisten von Synchronisierungs Profilen
- Abrufen des Synchronisierungsprofils
- Erstellen eines Synchronisierungsprofils
- Synchronisierungsprofil löschen
- Anhalten einer laufenden Synchronisierung
- Fortsetzen einer angehalten Synchronisierung
- Zurücksetzen einer Synchronisierung
- Starten der Synchronisierung für hochgeladene Dateien
- Abrufen einer Upload-URL
- Abrufen des Status einer Synchronisierung
- Abrufen von Synchronisierungsfehlern
Neuerungen
Informieren Sie sich über die aktuellsten neuen Features und Updates für diesen API-Satz.
Nächste Schritte
Verwenden Sie die Microsoft Graph Education-APIs, um Bildungslösungen zu erstellen, die auf Schüler Aufgaben und Schul Arbeitspläne 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
Feedback senden und anzeigen für