Instructure OneRoster Grade Passback (GPB)-integrationen understøtter enten standard- eller modificerede GPB-slutpunktskonfigurationer. Fordi den mere nøje følger OneRoster-konfigurationen.specifikationer for slutpunktskonfiguration, Standard GPB-konfigurationen anbefales.
For at forbedre ydeevnen skal du desuden inkludere et ydeevneslutpunkt i din GPB-konfiguration.
Lær mere om OneRosterOverholdelse af slutpunkter for karakterbogen.
Note:Instructure er en OneRoster-forbruger. For definitioner af OneRoster-forbrugere og -udbydere, seIntroduktion til OneRoster.
Standard Grade Passback
Standard GPB-integrationsslutpunktet inkluderer opgavens sourcedId, når karakterbogsdata synkroniseres fra Canvas til dit SIS.
Serviceopkald | Endepunkt | HTTP-verbum | Påkrævet |
|---|
hentAlleKategorier | /kategorier | FÅ | ✓ |
hentAlleLinjeelementer | /linjeelementer | FÅ | ✓ |
hentResultaterForKlassen | /klasser/{klasse_id}/resultater | FÅ | ✓ |
hentLineItemsForKlasse | /klasser/{klasse_id}/linjeelementer | FÅ | ✓ |
hentResultaterForLinjeItemForKlasse | /klasser/{klasse_id}/linjeelementer/{li_id}/resultater | FÅ | ✓ |
hentResultaterForElevForKlasse | /klasser/{klasse_id}/elever/{elev_id}/resultater | FÅ | ✓ |
putKategori | /kategorier/{id} | SÆTTE | 𝗫 |
putLineItem | /linjeelementer/{id} | SÆTTE | ✓ |
putResult | /resultater/{id} | SÆTTE | ✓ |
Modificeret karaktertilbagekobling
Det modificerede GPB-slutpunkt udelader opgavens sourcedId, når karakterbogsdata synkroniseres fra Canvas til dit SIS.
Som svar på PUT-kaldet for nye poster skal sourcedId returneres af OneRoster-udbyderen. Integrationen gemmer derefter disse data til fremtidig brug, når der udføres API-kald.
Serviceopkald | Endepunkt | HTTP-verbum | Påkrævet |
|---|
hentAlleKategorier | /kategorier | FÅ | ✓ |
hentAlleLinjeelementer | /linjeelementer | FÅ | ✓ |
hentResultaterForKlassen | /klasser/{klasse_id}/resultater | FÅ | ✓ |
hentLineItemsForKlasse | /klasser/{klasse_id}/linjeelementer | FÅ | ✓ |
hentResultaterForLinjeItemForKlasse | /klasser/{klasse_id}/linjeelementer/{li_id}/resultater | FÅ | ✓ |
hentResultaterForElevForKlasse | /klasser/{klasse_id}/elever/{elev_id}/resultater | FÅ | ✓ |
putKategori | /kategorier/{id} | SÆTTE | 𝗫 |
putLineItem | /linjeelementer/{id} | SÆTTE | ✓ |
putResult | /resultater/{id} | SÆTTE | ✓ |
putKategori* | /kategorier* | SÆTTE | 𝗫 |
putLineItem* | /linjeelementer* | SÆTTE | ✓ |
putResult* | /resultater* | SÆTTE | ✓ |
*sourcedId udeladt fra disse API-kald
Slutpunkter for passback med ydeevne
Mindst én af følgende Performance Grade Passback-integrationsmetoder skal implementeres.
Serviceopkald | Endepunkt | HTTP-verbum | Påkrævet |
|---|
getFilteredClassCategory | /kategorier?filter=metadata.klasseId='{klasse_id}' | FÅ | 𝗫* |
hentKategorierForKlasse | /klasser/{klasse_id}/kategorier | FÅ | ✓** |
*Selvom det ikke er strengt påkrævet, forhindrer implementering af dette filter behovet for at hente og cache alle kategorier.
**Hvis du ikke implementerer kategorienmetadata.classid, denne implementering er påkrævet. Dette giver klasser mulighed for at associere med en kategori.