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 Verwendung der OneRoster-API zum Erfassen der Daten ermöglicht es Ihnen, die wichtigsten SDS-Funktionen für die Bereitstellung zu erweitern. Außerdem können Sie die Erfahrungen der Microsoft 365-Produkte und -Features verbessern. Mit den OneRoster-APIs können Wir Objekte aus SIS/SMS synchronisieren, die OneRoster-APIs über die School Data Sync-Plattform (SDS) bereitstellen.
Mein Anbieter ist nicht in der Dropdownliste aufgeführt, und die status hier lautet Test. Was muss ich tun, damit sie in der Anbieterliste angezeigt werden?
Wenden Sie sich an das Kundensupportteam , um Ihren Mandanten zu testen und Zugriff auf die API-Anbieter zu erhalten, die derzeit getestet werden. Geben Sie beim Auslösen der Anforderung die folgenden Informationen an:
Mandanten-ID
Name des OneRoster-Anbieters
SDS-Version
Liste
Nachdem Ihr Mandant flighted wurde, arbeiten Sie mit Ihrem OneRoster-Anbieter und SDS POC zusammen, um Tests auszuführen und sicherzustellen, dass die Integration erfolgreich ist. Wenn ein Problem aufkommt, arbeiten Sie mit dem Anbieter und sds POC zusammen, um die Lösung zu erreichen.
Sobald der Test erfolgreich ist, wird der OneRoster Provider status aktualisiert (vom Testmodus auf Ja) und in der Liste der öffentlich zugänglichen Anbieter für alle Mandanten verfügbar.
Mein Anbieter ist nicht aufgeführt. Gibt es Informationen, die Sie mit ihnen teilen können, um als OneRoster-Anbieter mit SDS teilzunehmen?
Auf welche Endpunkte wird beim Erfassen von Listendaten zugegriffen?
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.
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.
Optionale Kontaktbeziehungen zwischen Kursteilnehmern
Die Kontaktbeziehung für Schüler kann für Schüler*innen festgelegt werden, um die Erfahrungen von Lehrkräften für die Kommunikation mit Eltern und Erziehungsberechtigten zu verbessern. Kontakte sind mehr Benutzer, die mit /users bereitgestellt werden, und die Zuordnung zu einem Kursteilnehmer finden Sie im Benutzerdatensatz des Kursteilnehmers unter "Agents".
familyName, givenName und email sind für Benutzer mit Kontakt-/Erziehungsberechtigtenrollen erforderlich.
Erwarten Sie, dass Telefon und SMS in E.164 und + enthalten sein müssen. (Beispiel: +1234567890)
Wenn umgekehrte Daten bereitgestellt werden, von einem Kontaktbeziehungs-Erziehungsberechtigten-Datensatz bis zum Kursteilnehmer im Feld "Agents" der Kontaktbenutzer, werden diese Datensätze herausgefiltert.
Optionale demografische Benutzerflags
Benutzerflags können für Schüler*innen angegeben werden, um ihre Teilnahme an einem Programm oder einer Kohorte anzugeben. Benutzerflags sind enthalten (wenn für den Benutzer true) oder nicht enthalten, falls nicht zutreffend.
Flags werden als Metadatenerweiterung für den Benutzer in einem Metadatenfeld nach einem Schlüssel|Wertpaar. Der Schlüssel sollte microsoft.userFlags heißen und muss als durch Trennzeichen getrennte Liste formatiert werden. Benutzerflags können in beliebiger Reihenfolge angezeigt werden, wobei die Groß-/Kleinschreibung nicht beachtet wird.
Gemäß 1EdTech ist der Anbieter dafür verantwortlich, den Datenschutz dafür zu erzwingen, welche Daten bei einer Datenanforderung verfügbar sind. School Data Sync stellt eine Anforderung für aktive Daten basierend auf dem Zeitpunkt der Anforderung.
Anmeldeinformationen für den OneRoster-API-Zugriff erforderlich
Um die Verbindung mit der OneRoster-API für Ihr SIS/SMS zu aktivieren, müssen Sie die Anmeldeinformationen für die Verbindung angeben. Weitere Informationen finden Sie in der Dokumentation Ihres jeweiligen Anbieters, um sie abzurufen oder zu generieren.
Webzugriffs-URL: URL, auf die Ihre OneRoster-API für Ihr SIS/SMS zugänglich ist
Client-ID, die zum Herstellen einer Verbindung mit Ihrer SIS/SMS OneRoster-API verwendet wird
Geheimer Clientschlüssel, der zum Herstellen einer Verbindung mit Ihrer SIS/SMS OneRoster-API verwendet wird
Zugriffstoken-URL: Wenn Ihre SIS/SMS OneRoster-API für die Authentifizierung mit OAuth2 konfiguriert ist, müssen Sie den Endpunkt der Zugriffstoken-URL angeben, der zum Herstellen der Verbindung verwendet wurde. Der Endpunkt unterscheidet sich von der Webzugriffs-URL.
Hilfreiche Hinweise und Tipps
Die Endpunkte folgen immer nach "https://{server_URL}/ims/oneroster/v1p1"
Um zu verhindern, dass bestimmte Schulen in die Daten einbezogen werden, die vom SIS an SDS bereitgestellt werden, müssen Kunden mit ihrem Anbieter zusammenarbeiten, um zu konfigurieren, welche Schulen für die Verbindung bzw. die Anmeldeinformationen enthalten sind, die verwendet werden, um SDS mit ihrem SIS zu verknüpfen.
Endpunkte haben Anforderungen an die Unterstützung von Filterparametern, um das Filtern nach status zu ermöglichen oder die Deltasynchronisierung zu aktivieren.
SDS wendet einen Filter für die dateLastModified-Eigenschaft für die Deltasynchronisierung/inkrementelle Synchronisierungsverarbeitung an und ist für die Integration in SDS erforderlich.
Anbieter müssen entweder das Authentifizierungsschema OAuth1(a) oder OAuth 2.0 (Gewährung von Clientanmeldeinformationen) implementieren. OAuth 2.0 wird bevorzugt.
Wenn das unterstützte Authentifizierungsprotokoll "OAuth 2.0" ist – Typ der Gewährung von Clientanmeldeinformationen, würde SDS die Anmeldeinformationen im Header "Authorization" senden. Wie in der OneRoster-Spezifikation empfohlen senden wir die codierten Clientanmeldeinformationen im Autorisierungsheader von Tokenanforderungen.
Details des OneRoster-Anbieters
Aequitas
SIS-Anbieter
Aequitas Solutions, Inc
Softwareversion (Mindestanforderung)
Q 3.6.1, Q Web API 3.6.0
Konfigurationsvoraussetzungen
Weitere Informationen finden Sie unter Einrichten der Q-Web-API.
Abrufen der Client-ID, des geheimen Clientschlüssels und der URLs
Weitere Informationen finden Sie unter Einrichten der Q-Web-API.
Spezifische Anweisungen
Nicht zutreffend
Help
Wenden Sie sich an den Support unter (909) 946-1600
Kontaktieren Sie den Support unter Telefon (gebührenfrei): (888) 324-5363 oder support@aeries.com
Arbor Ausbildung
SIS-Anbieter
Arbor Ausbildung
Softwareversion (Mindestanforderung)
Nicht zutreffend
Konfigurationsvoraussetzungen
Die Integration zwischen Arbor MIS und SDS ist auf Ihrem Arbor MIS aktiviert. Wenden Sie sich an Ihren Konto-Manager bei Arbor, um sicherzustellen, dass es über accountmanagers@arbor-education.comaktiviert ist. Sie müssen einen Office 365 Bildungsmandanten, globale Administratorberechtigungen und School Data Sync (Plan 1) aktiviert haben.
Abrufen der Client-ID, des geheimen Clientschlüssels und der URLs
Generieren Sie in Ihrem Arbor MIS. Die erforderlichen Schritte finden Sie im Arbor-Hilfecenter.
Spezifische Anweisungen
Wenden Sie sich an Arbor oder Ihren dedizierten Supportpartner, um diese Integration über myteam@arbor-education.comeinzurichten.
Help
Supportartikel finden Sie im Hilfecenter von Arbor. Wenden Sie sich bei Fragen an myteam@arbor-education.com oder ihren dedizierten Supportpartner.
Blackbaud Education Management
SIS-Anbieter
Blackbaud Education Management
Softwareversion (Mindestanforderung)
Die neueste Version von BEM steht Benutzern immer zur Verfügung.
Konfigurationsvoraussetzungen
Nicht zutreffend
Abrufen der Client-ID, des geheimen Clientschlüssels und der URLs
Wenn Sie Ihre Zuordnungseinstellungen für Ihre Microsoft Entra Benutzer auswählen, stellen Sie sicher, dass Ihre Einstellungen zum Ein-/Ausschließen des Domänensuffixes Mit Ihren Microsoft Entra Benutzernamen übereinstimmen. Diese Aktion stellt die besten Ergebnisse beim Abgleich von BEM-Kursteilnehmern und -Lehrern mit Ihren Microsoft Entra Benutzern sicher.
Help
support.blackbaud.com
Bubblecon
SIS-Anbieter
Bubblecon
Spezifische Anweisungen
Wenden Sie sich an das Kundensupportteam von Bubblecon.
Abrufen der Client-ID, des geheimen Clientschlüssels und der URLs
Kunden können ihre oAuth-Anmeldeinformationen über die Konsole abrufen, nachdem sie die App hinzugefügt haben. Eine E-Mail wird an den Entwickler bei Microsoft gesendet, der die App eingerichtet hat. Wählen Sie Hinzufügen von Anwendungen & Ändern von Berechtigungen aus, um den Speicherort zum Abrufen der Client-ID und des geheimnissen Schlüssels anzuzeigen.
Wenn Probleme beim Herstellen einer Verbindung auftreten, stellen Sie sicher, dass die Webzugriffs-URL "/ims/oneroster/v1p1" aufweist, um auf die richtigen Connectors zu verweisen.
Spezifische Anweisungen
Nicht zutreffend
Help
Senden Sie eine E-Mail an rostersupport@classlink.com.
Abrufen der Client-ID, des geheimen Clientschlüssels und der URLs
Wenden Sie sich an den Kundensupport.
Spezifische Anweisungen
Wenden Sie sich an den Kundensupport.
Help
Wenden Sie sich an , um Support zu benötigen educate_support@communitybrands.com.
Edulife Connect
SIS-Anbieter
Edulife Connect
Softwareversion (Mindestanforderung)
Nicht zutreffend
Konfigurationsvoraussetzungen
Nicht zutreffend
Abrufen der Client-ID, des geheimen Clientschlüssels und der URLs
Erfolgt direkt in Kontakt mit unserem Bereitstellungs- und Supportteam.
Spezifische Anweisungen
Nicht zutreffend
Help
Wenden Sie sich unter an support@wizkids.co.ukden Support. // 020 7550 9286
eSchoolData
SIS-Anbieter
eSchoolData
Softwareversion (Mindestanforderung)
Nicht zutreffend
Konfigurationsvoraussetzungen
Bezirke müssen Abonnenten des eSD GURU-Produkts sein.
Abrufen der Client-ID, des geheimen Clientschlüssels und der URLs
Weitere Informationen finden Sie in den spezifischen Anweisungen.
Spezifische Anweisungen
Um eine API-Integration mit SDS zu ermöglichen, müssen Landräte zuerst ein Anbieterkonto innerhalb von GURU erstellen. Navigieren Sie zu Konfigurationsanbieter > , und wählen Sie Neuen Anbieter erstellen aus. Geben Sie einen Anbieternamen ein, und behalten Sie die Client-ID und den geheimen Clientschlüssel bei, die automatisch generiert werden. Geben Sie zusammen mit Ihrer regionalen GURU-API-URL an, wenn Sie die SDS-Integration konfigurieren. Wählen Sie Weiter aus, und aktivieren Sie alle OneRoster-API-Berechtigungen. Wählen Sie Fertig stellen aus, um das neue Konto zu speichern.
Help
Wenden Sie sich bei Fragen an das eSchoolData-Supportteam.
eSchooling
SIS-Anbieter
eSchooling von Codevision
Softwareversion (Mindestanforderung)
1.1.20
Konfigurationsvoraussetzungen
Keine
Abrufen der Client-ID, des geheimen Clientschlüssels und der URLs
Befolgen Sie die Anweisungen in der eSchooling-Plattform: Systemverwaltung > School Data Sync
Spezifische Anweisungen
Identisch mit dem vorherigen
Help
Kontakt suporte@codevision.pt
Eum School SIS
SIS-Anbieter
DataEum
Softwareversion (Mindestanforderung)
Nicht zutreffend
Konfigurationsvoraussetzungen
Keine
Abrufen der Client-ID, des geheimen Clientschlüssels und der URLs
Email Kundensupport, um Anmeldeinformationen für die OneRoster-API anzufordern.
Spezifische Anweisungen
Kontaktieren des Kundensupports pbd@dataeum.kr
Help
Kontaktieren des Kundensupports pbd@dataeum.kr
Eventful
SIS-Anbieter
Eventful
Softwareversion (Mindestanforderung)
Eine Liste der unterstützten Studentenregister finden Sie unter Eventful OneRoster.
Konfigurationsvoraussetzungen
Kontaktieren Sie Eventful per E-Mail unter info@eventful.se oder telefonisch unter (+46) 10 209 9001
Abrufen der Client-ID, des geheimen Clientschlüssels und der URLs
Wird im Setupprozess bereitgestellt.
Spezifische Anweisungen
Nicht zutreffend
Help
Kontaktieren Sie den ereignisreichen Support per E-Mail unter info@eventful.se oder telefonisch unter (+46) 10 209 9001
TATSACHEN
SIS-Anbieter
TATSACHEN
Softwareversion (Mindestanforderung)
Nicht zutreffend. Die neueste Version ist für Kunden immer verfügbar.
Konfigurationsvoraussetzungen
Nicht zutreffend
Abrufen der Client-ID, des geheimen Clientschlüssels und der URLs
Kunden registrieren sich für die OneRoster-API, und FACTS stellt ihnen diese Informationen zur Verfügung.
Spezifische Anweisungen
Navigieren Sie innerhalb des SIS zu Systemkonfiguration >> SIS-Integrationen > OneRoster-API > Formular ausfüllen.
Help
Kundensupport 866-800-6593
Fokus Schulsoftware
SIS-Anbieter
Fokus Schulsoftware
Softwareversion (Mindestanforderung)
Focus v 8.7
Konfigurationsvoraussetzungen
Nicht zutreffend
Abrufen der Client-ID, des geheimen Clientschlüssels und der URLs
Klicken > Sie auf dem Bildschirm Fokusportal auf Systemeinrichtung > von Drittanbietersystemen. Geben Sie in der Zeile zum Einfügen des Datensatzes Titel: Microsoft Version 1.0 > Dialekt: OneRoster ein. Beim Speichern werden die URL, die Client-ID und der geheime Clientschlüssel generiert.
Spezifische Anweisungen
Nicht zutreffend
Help
Rufen Sie die Telefonsupportleitung von Focus unter 877-410-6637 an.
Follett Aspen
SIS-Anbieter
Follett Aspen
Softwareversion (Mindestanforderung)
Neueste Version von Aspen, 5.9
Konfigurationsvoraussetzungen
Nicht zutreffend
Abrufen der Client-ID, des geheimen Clientschlüssels und der URLs
Wenden Sie sich an den Customer Relationship Manager für Ihren Bezirk, um das Upgrade zu planen.
Spezifische Anweisungen
Nicht zutreffend
Help
Wenden Sie sich an Ihren Customer Relationship Manager, um Hilfe zu benötigen.
Furlong Schoolbase
SIS-Anbieter
Furlong Schoolbase
Softwareversion (Mindestanforderung)
Gehostete Schulen, die nur die neueste Version verwenden
Konfigurationsvoraussetzungen
Nicht zutreffend
Abrufen der Client-ID, des geheimen Clientschlüssels und der URLs
Vor V 1933.3 : Wechseln Sie zur Benutzeroberfläche >> von Infinite Campus und wählen Sie Systemverwaltung >> aus, wählen Sie Campus Learning >> aus Wählen Sie OneRoster Tools >> auf OneRoster aus. Version 1933.3 und höher: Navigieren Sie zur Infinite Campus-Benutzeroberfläche >> , und wählen Sie Systemverwaltung >> aus, und wählen Sie Lerninteroperabilität aus.
Stellen Sie beim Auswählen der zu synchronisierenden Attribute in Infinite Campus sicher, dass der Punkt nicht ausgewählt ist. Wenn es ausgewählt ist, besteht die Möglichkeit, dass beim Synchronisieren und Sperren des Profils in Quarantäne eine große Anzahl von Fehlern generiert wird.
Help
Wenn Sie Hilfe benötigen, wenden Sie sich an Ihren Customer Success Manager.
inLogic
SIS-Anbieter
inLogic
Softwareversion (Mindestanforderung)
V7.7.510
Konfigurationsvoraussetzungen
Nicht zutreffend
Abrufen der Client-ID, des geheimen Clientschlüssels und der URLs
Für E-Mail-Unterstützung wechseln Sie zu support@inlogic.dk, für Telefonsupport, +45 42 40 88 15 und Websupport, https://www.inlogic.dk/support/.
iSAMS von IRIS
SIS-Anbieter
iSAMS von IRIS
Softwareversion (Mindestanforderung)
21.4.23.12
Konfigurationsvoraussetzungen
Keine
Abrufen der Client-ID, des geheimen Clientschlüssels und der URLs
Sie sollten eine E-Mail an den Helpdesk senden, der Anmeldeinformationen für die OneRoster-API anfordert: helpdesk@isams.co.uk
Spezifische Anweisungen
Keine
Help
Wenden Sie sich an den iSAMS-Helpdesk, um hilfedokument unter helpdesk@isams.co.ukanzufordern.
IST
SIS-Anbieter
IST
Softwareversion (Mindestanforderung)
Nicht zutreffend.
Konfigurationsvoraussetzungen
Weitere Informationen finden Sie in den spezifischen Anweisungen.
Abrufen der Client-ID, des geheimen Clientschlüssels und der URLs
Weitere Informationen finden Sie in den spezifischen Anweisungen.
Spezifische Anweisungen
Informationen zum Setup werden privat bereitgestellt.
Help
Wenden Sie sich bei Fragen an Das IST-Supportteam.
LIBRUS
SIS-Anbieter
LIBRUS
Softwareversion (Mindestanforderung)
Aktuelle Version
Konfigurationsvoraussetzungen
Der Client muss über eine Lizenz für LIBRUS Synergia verfügen.
Abrufen der Client-ID, des geheimen Clientschlüssels und der URLs
Um eine API-Integration mit SDS zu aktivieren, müssen Sie als Administrator oder Schulleiter angemeldet sein. Navigieren Sie zu Einstellungen > Konfiguration > Weitere Optionen > Office 365 Integration
Spezifische Anweisungen
Ausführliche Anweisungen finden Sie im Hilfeabschnitt.
Help
Kontaktieren Sie unser Supportteam unter pomoc@LIBRUS.pl
MySchool
SIS-Anbieter
MySchool Ltd
Softwareversion (Mindestanforderung)
Nicht zutreffend
Konfigurationsvoraussetzungen
Erste Einrichtung des MySchool-Systems, unterstützt durch das Supportteam.
Abrufen der Client-ID, des geheimen Clientschlüssels und der URLs
Keine. Die OneRoster-Integration ist standardmäßig für alle Schulen aktiviert.
Abrufen der Client-ID, des geheimen Clientschlüssels und der URLs
Wird automatisch vom Programm generiert, wenn eine neue Schule erstellt wurde. Admin können Benutzereinstellungen über die Gradebook Manager-Anwendung verwalten.
Spezifische Anweisungen
Keine
Help
Fragen können an oder gerichtet werden.GBSupport@rediker.comAPSupport@rediker.com
SIMS
SIS-Anbieter
SIMS von Education Software Solutions
Softwareversion (Mindestanforderung)
SIMS 7 Sommer 2019 oder höher
Konfigurationsvoraussetzungen
Ein SIMS-ID-Konto ist erforderlich.
Abrufen der Client-ID, des geheimen Clientschlüssels und der URLs
Abrufen der Client-ID, des geheimen Clientschlüssels und der URLs
Über das VULCAN Admin-Portal; Wählen Sie "Konfiguration" > Office 365 Einstellungen" > für die API-Austauschkonfiguration aus. Aktivieren Sie "Synchronisierung mit Office 365". Auf dieser Registerkarte erhalten Sie die Client-ID, den geheimen Clientschlüssel und urLs.
Spezifische Anweisungen
Nicht zutreffend
Help
Wenden Sie sich an den Support während https://vulcan.edu.pl der Normalen Bürozeiten.