Instructure OneRoster-integrasjonen for grade passback (GPB) støtter enten standard eller modifiserte GPB-endepunktkonfigurasjoner. Fordi den følger OneRoster-konfigurasjonen strengere.spesifikasjoner for endepunktkonfigurasjon, anbefales standard GPB-konfigurasjon.
For å forbedre ytelsen, inkluder i tillegg et ytelsesendepunkt i GPB-konfigurasjonen.
Lær mer om OneRosterSamsvar med endepunktene for karakterboken.
Note:Instructure er en OneRoster-forbruker. For definisjoner av OneRoster-forbrukere og -leverandører, seIntroduksjon til OneRoster.
Standard karakter Passback
Standard GPB-integrasjonsendepunktet inkluderer oppgavens sourcedId når karakterbokdata synkroniseres fra Canvas til SIS-systemet ditt.
Serviceanrop | Endepunkt | HTTP-verb | Obligatorisk |
|---|
hentAlleKategorier | /kategorier | BLI | ✓ |
hentAlleLinjeelementer | /linjeelementer | BLI | ✓ |
hentResultaterForKlassen | /klasser/{klasse_id}/resultater | BLI | ✓ |
hentLineItemsForClass | /klasser/{klasse_id}/linjeelementer | BLI | ✓ |
hentResultaterForLinjeelementForKlasse | /klasser/{klasse_id}/linjeelementer/{li_id}/resultater | BLI | ✓ |
hentResultaterForStudentForKlassen | /klasser/{klasse_id}/elever/{student_id}/resultater | BLI | ✓ |
putTegory | /kategorier/{id} | SETTE | 𝗫 |
putLineItem | /linjeelementer/{id} | SETTE | ✓ |
putResult | /resultater/{id} | SETTE | ✓ |
Modifisert karaktertilbakeføring
Det modifiserte GPB-endepunktet utelater oppgavens sourcedId når karakterbokdata synkroniseres fra Canvas til SIS-systemet ditt.
Som svar på PUT-kallet for nye poster, må sourcedId returneres av OneRoster-leverandøren. Integrasjonen lagrer deretter disse dataene for fremtidig bruk når API-kall utføres.
Serviceanrop | Endepunkt | HTTP-verb | Obligatorisk |
|---|
hentAlleKategorier | /kategorier | BLI | ✓ |
hentAlleLinjeelementer | /linjeelementer | BLI | ✓ |
hentResultaterForKlassen | /klasser/{klasse_id}/resultater | BLI | ✓ |
hentLineItemsForClass | /klasser/{klasse_id}/linjeelementer | BLI | ✓ |
hentResultaterForLinjeelementForKlasse | /klasser/{klasse_id}/linjeelementer/{li_id}/resultater | BLI | ✓ |
hentResultaterForStudentForKlassen | /klasser/{klasse_id}/elever/{student_id}/resultater | BLI | ✓ |
putTegory | /kategorier/{id} | SETTE | 𝗫 |
putLineItem | /linjeelementer/{id} | SETTE | ✓ |
putResult | /resultater/{id} | SETTE | ✓ |
puttKategori* | /kategorier* | SETTE | 𝗫 |
putLineItem* | /linjeelementer* | SETTE | ✓ |
putResult* | /resultater* | SETTE | ✓ |
*sourcedId utelatt fra disse API-kallene
Ytelsesgrad Passback-endepunkter
Minst én av følgende endepunktmetoder for integrering av Performance Grade Passback bør implementeres.
Serviceanrop | Endepunkt | HTTP-verb | Obligatorisk |
|---|
getFilteredClassCategory | /kategorier?filter=metadata.klasseId='{klasse_id}' | BLI | 𝗫* |
hentKategorierForKlasse | /klasser/{klasse_id}/kategorier | BLI | ✓** |
*Selv om det ikke er strengt tatt påkrevd, forhindrer implementering av dette filteret behovet for å hente og mellomlagre alle kategorier.
**Hvis du ikke implementerer kategorienmetadata.classid, denne implementeringen er nødvendig. Dette tillater klasser å assosiere seg med en kategori.