Die Instructure OneRoster Grade Passback (GPB)-Integration unterstützt entweder die Standard- oder die modifizierte GPB-Endpunktkonfiguration. Da sie sich strikter an OneRoster hält, …Spezifikationen für die EndpunktkonfigurationDie Standard-GPB-Konfiguration wird empfohlen.
Um die Leistung weiter zu verbessern, sollten Sie außerdem einen Performance-Endpunkt in Ihre GPB-Konfiguration aufnehmen.
Erfahren Sie mehr über OneRosterEinhaltung der Endpunktvorgaben für NotenbücherDie
Notiz:Instructure ist ein OneRoster-Nutzer. Definitionen von OneRoster-Nutzern und -Anbietern finden Sie hier:Einführung in OneRosterDie
Standard Grade Passback
Der Standard-GPB-Integrationsendpunkt enthält die Zuordnungs-SourcedId, wenn Notenbuchdaten von Canvas mit Ihrem SIS synchronisiert werden.
Serviceeinsatz | Endpunkt | HTTP-Verb | Erforderlich |
|---|
getAllCategories | /Kategorien | ERHALTEN | ✓ |
getAllLineItems | /lineItems | ERHALTEN | ✓ |
getResultsForClass | /classes/{class_id}/results | ERHALTEN | ✓ |
getLineItemsForClass | /classes/{class_id}/lineItems | ERHALTEN | ✓ |
getResultsForLineItemForClass | /classes/{class_id}/lineItems/{li_id}/results | ERHALTEN | ✓ |
getResultsForStudentForClass | /classes/{class_id}/students/{student_id}/results | ERHALTEN | ✓ |
Kategorie einfügen | /categories/{id} | SETZEN | 𝗫 |
putLineItem | /lineItems/{id} | SETZEN | ✓ |
putResult | /results/{id} | SETZEN | ✓ |
Modifizierte Notenrückgabe
Der modifizierte GPB-Endpunkt lässt die Zuordnungs-sourcedId aus, wenn Notenbuchdaten von Canvas mit Ihrem SIS synchronisiert werden.
In der Antwort auf den PUT-Aufruf für neue Datensätze muss die sourcedId vom OneRoster-Anbieter zurückgegeben werden. Die Integration speichert diese Daten anschließend zur späteren Verwendung bei API-Aufrufen.
Serviceeinsatz | Endpunkt | HTTP-Verb | Erforderlich |
|---|
getAllCategories | /Kategorien | ERHALTEN | ✓ |
getAllLineItems | /lineItems | ERHALTEN | ✓ |
getResultsForClass | /classes/{class_id}/results | ERHALTEN | ✓ |
getLineItemsForClass | /classes/{class_id}/lineItems | ERHALTEN | ✓ |
getResultsForLineItemForClass | /classes/{class_id}/lineItems/{li_id}/results | ERHALTEN | ✓ |
getResultsForStudentForClass | /classes/{class_id}/students/{student_id}/results | ERHALTEN | ✓ |
Kategorie einfügen | /categories/{id} | SETZEN | 𝗫 |
putLineItem | /lineItems/{id} | SETZEN | ✓ |
putResult | /results/{id} | SETZEN | ✓ |
Kategorie einfügen* | /Kategorien* | SETZEN | 𝗫 |
putLineItem* | /lineItems* | SETZEN | ✓ |
putResult* | /results* | SETZEN | ✓ |
*sourcedId wurde bei diesen API-Aufrufen weggelassen.
Performance Grade Passback-Endpunkte
Mindestens eine der folgenden Integrationsendpunktmethoden für Performance Grade Passback sollte implementiert werden.
Serviceeinsatz | Endpunkt | HTTP-Verb | Erforderlich |
|---|
getFilteredClassCategory | /categories?filter=metadata.classId='{class_id}' | ERHALTEN | 𝗫* |
getCategoriesForClass | /classes/{class_id}/categories | ERHALTEN | ✓** |
*Obwohl nicht unbedingt erforderlich, erspart die Implementierung dieses Filters das Abrufen und Zwischenspeichern aller Kategorien.
**Wenn Sie die Kategorie nicht implementierenmetadata.classidDiese Implementierung ist erforderlich. Dadurch können Klassen einer Kategorie zugeordnet werden.