Freigeben über

OneRoster-API-Daten, auf die von School Data Sync zugegriffen wird

  • Artikel

Wichtig

Durch das Verbinden und Bereitstellen von Daten von Institutionen mit School Data Sync bestätigen Sie, dass Sie berechtigt sind, diese Daten mit Microsoft zu teilen, und verpflichten sich, die Data Governance-Standards Ihrer organization einzuhalten.

OneRoster API (Application Programming Interfaces) ist ein Branchenstandardformat von 1EdTech (früher IMS Global), für den Austausch von Student Information System (SIS) / Student Management Systems (SMS)-Daten. Mit dieser Synchronisierungsmethode können Sie mithilfe der REST-basierten OneRoster 1.1-APIs, die von Ihrem SIS/SMS-Anbieter entwickelt wurden, eine direkte Verbindung mit Ihrem SIS/SMS herstellen. Die API-Unterstützung ermöglicht es Ihnen, Daten direkt zu synchronisieren, anstatt CSV-Dateien (Comma Separated Value) zu verwenden.

Die folgende Liste soll Ihnen helfen, besser zu verstehen, auf welche Daten beim Herstellen einer Verbindung mit Ihrem SIS/SMS über die OneRoster-API zugegriffen wird.

Erforderliche OneRoster-API-Endpunkte für Schuldaten

Aktion URL Erforderliche Filtereigenschaften Optionaler/empfohlener Filter Beispiele
GetAllAcademicSessions /academicSessions status dateLastModified /academicSessions?offset=0&limit=5000&filter=status='active'/academicSessions?filter=dateLastModified>'{deltaDateTime}'
GetAllOrgs /Orgs status dateLastModified /orgs?offset=0&limit=5000&filter=status='active'/orgs?filter=dateLastModified>'{deltaDateTime}'
Getallusers /Benutzer status dateLastModified /users?offset=0&limit=5000&filter=status='active'/users?filter=dateLastModified>'{deltaDateTime}'
GetAllClasses /Klassen status dateLastModified /classes?offset=0&limit=5000&filter=status='active'/classes?filter=dateLastModified>'{deltaDateTime}'
GetAllEnrollments /Anmeldungen status dateLastModified /enrollments?offset=0&limit=5000&filter=status='active'/enrollments?filter=dateLastModified>'{deltaDateTime}'

Optionale API-Endpunkte für School Data Sync

Hinweis

Für die optionalen Datenteile für demografische Daten, Kontaktbeziehungen von Schülern und Studentenbenutzerflags basiert die Möglichkeit, diese Daten einzuschließen oder nicht, auf den unterstützten optionalen Datenfunktionen ihres SIS/SMS OneRoster-Anbieterprofils. Wenn der SIS/SMS-Anbieter diese Daten ebenfalls unterstützt, wird der Umschalter (Standard) ein ausgewählt, um zusätzliche Daten einzuschließen. Sie können die Umschaltfläche auswählen, um sie bei Bedarf zu deaktivieren. Wenn die Umschaltfläche nicht verfügbar, aber deaktiviert und nicht für die Interaktion verfügbar ist, bedeutet dies, dass das Profil des Anbieters die Bereitstellung dieser Daten derzeit nicht unterstützt.

Hinweis

Wenn das Profil des Anbieters demografische Daten, Kontakte oder demografische Benutzerflags als nicht verfügbar anzeigt und Sie möchten, dass diese Dieses Feature unterstützen, wenden Sie sich an Ihren Anbieter, und fordern Sie das Hinzufügen von Support an, damit SDS die Daten erfassen kann und Sie die Szenarien und Erfahrungen aktivieren können, die von den Daten unterstützt werden. 

Aktion URL Erforderliche Filtereigenschaften Optionaler/empfohlener Filter Beispiele
GetAllCourses /Kurse status dateLastModified /courses?offset=0&limit=5000&filter=status='active'/courses?filter=dateLastModified>'{deltaDateTime}'
GetAllDemographics /Demografie status dateLastModified /demographics?offset=0&limit=5000&filter=status='active'/demographics?filter=dateLastModified>'{deltaDateTime}'