Instructure OneRoster-integrationen av grade passback (GPB) stöder antingen standard- eller modifierade GPB-slutpunktskonfigurationer. Eftersom den följer OneRoster-standardkonfigurationen mer striktspecifikationer för slutpunktskonfiguration, rekommenderas standard GPB-konfigurationen.
För att förbättra prestandan bör du dessutom inkludera en prestandaslutpunkt i din GPB-konfiguration.
Läs mer om OneRosterEfterlevnad av slutpunkter för betygsboken.
Notera:Instructure är en OneRoster-konsument. För definitioner av OneRoster-konsumenter och leverantörer, seIntroduktion till OneRoster.
Standardbetyg Passback
Standard GPB-integrationsslutpunkten inkluderar uppgiftens sourcedId när betygsboksdata synkroniseras från Canvas till ditt SIS.
Servicebesök | Slutpunkt | HTTP-verb | Nödvändig |
|---|
hämta alla kategorier | /kategorier | FÅ | ✓ |
hämtaAllaRadobjekt | /radobjekt | FÅ | ✓ |
hämtaResultatFörKlass | /klasser/{klass_id}/resultat | FÅ | ✓ |
hämtaRadobjektFörKlass | /klasser/{klass_id}/radobjekt | FÅ | ✓ |
hämtaResultatFörLinjeItemFörKlass | /klasser/{klass_id}/radobjekt/{li_id}/resultat | FÅ | ✓ |
hämtaResultatFörStudentFörKlass | /klasser/{klass_id}/elever/{student_id}/resultat | FÅ | ✓ |
putCategory | /kategorier/{id} | SÄTTA | 𝗫 |
putLineItem | /radobjekt/{id} | SÄTTA | ✓ |
putResult | /resultat/{id} | SÄTTA | ✓ |
Modifierad betygsåterkoppling
Den modifierade GPB-slutpunkten utelämnar uppgiftens sourcedId när betygsboksdata synkroniseras från Canvas till ditt SIS.
Som svar på PUT-anropet för nya poster måste sourcedId returneras av OneRoster-leverantören. Integrationen lagrar sedan dessa data för framtida bruk vid API-anrop.
Servicebesök | Slutpunkt | HTTP-verb | Nödvändig |
|---|
hämta alla kategorier | /kategorier | FÅ | ✓ |
hämtaAllaRadobjekt | /radobjekt | FÅ | ✓ |
hämtaResultatFörKlass | /klasser/{klass_id}/resultat | FÅ | ✓ |
hämtaRadobjektFörKlass | /klasser/{klass_id}/radobjekt | FÅ | ✓ |
hämtaResultatFörLinjeItemFörKlass | /klasser/{klass_id}/radobjekt/{li_id}/resultat | FÅ | ✓ |
hämtaResultatFörStudentFörKlass | /klasser/{klass_id}/elever/{student_id}/resultat | FÅ | ✓ |
putCategory | /kategorier/{id} | SÄTTA | 𝗫 |
putLineItem | /radobjekt/{id} | SÄTTA | ✓ |
putResult | /resultat/{id} | SÄTTA | ✓ |
putCategory* | /kategorier* | SÄTTA | 𝗫 |
putLineItem* | /radobjekt* | SÄTTA | ✓ |
putResult* | /resultat* | SÄTTA | ✓ |
*sourcedId utelämnades från dessa API-anrop
Slutpunkter för återkoppling av prestandaklass
Minst en av följande slutpunktsmetoder för integration av prestandaklass för passback bör implementeras.
Servicebesök | Slutpunkt | HTTP-verb | Nödvändig |
|---|
getFilteredClassCategory | /kategorier?filter=metadata.klassId='{klass_id}' | FÅ | 𝗫* |
hämta kategorier för klass | /klasser/{klass_id}/kategorier | FÅ | ✓** |
*Även om det inte är absolut nödvändigt, förhindrar implementeringen av detta filter behovet av att hämta och cachelagra alla kategorier.
**Om du inte implementerar kategorinmetadata.klassid, denna implementering krävs. Detta gör att klasser kan associeras med en kategori.