De Instructure OneRoster GPB-integratie (Grade Passback) ondersteunt zowel de standaard als de aangepaste GPB-eindpuntconfiguraties. Omdat deze de OneRoster-standaard strikter volgt.Specificaties voor de configuratie van het eindpuntDe standaard GPB-configuratie wordt aanbevolen.
Om de prestaties te verbeteren, kunt u bovendien een Performance-eindpunt toevoegen aan uw GPB-configuratie.
Leer meer over OneRosternaleving van de eindpunten voor het cijferboek.
Opmerking:Instructure is een OneRoster-consument. Voor definities van OneRoster-consumenten en -providers, zie deIntroductie tot OneRoster.
Standaardniveau Passback
Het standaard GPB-integratie-eindpunt bevat de sourcedId van de opdracht bij het synchroniseren van cijferlijstgegevens van Canvas naar uw SIS.
Serviceaanvraag | Eindpunt | HTTP-werkwoord | Vereist |
|---|
getAllCategories | /categorieën | KRIJGEN | ✓ |
getAllLineItems | /regelitems | KRIJGEN | ✓ |
getResultsForClass | /klassen/{klasse_id}/resultaten | KRIJGEN | ✓ |
getLineItemsForClass | /klassen/{klasse_id}/regelitems | KRIJGEN | ✓ |
getResultsForLineItemForClass | /classes/{class_id}/lineItems/{li_id}/results | KRIJGEN | ✓ |
getResultsForStudentForClass | /classes/{class_id}/students/{student_id}/results | KRIJGEN | ✓ |
putCategory | /categorieën/{id} | NEERZETTEN | X |
putLineItem | /lineItems/{id} | NEERZETTEN | ✓ |
putResult | /results/{id} | NEERZETTEN | ✓ |
Gewijzigd cijfer terugkrijgen
Het aangepaste GPB-eindpunt laat de `signature sourcedId` weg bij het synchroniseren van cijferlijstgegevens van Canvas naar uw SIS.
In het antwoord op de PUT-aanroep voor nieuwe records moet de sourcedId door de OneRoster-provider worden teruggestuurd. De integratie slaat deze gegevens vervolgens op voor toekomstig gebruik bij het uitvoeren van API-aanroepen.
Serviceaanvraag | Eindpunt | HTTP-werkwoord | Vereist |
|---|
getAllCategories | /categorieën | KRIJGEN | ✓ |
getAllLineItems | /regelitems | KRIJGEN | ✓ |
getResultsForClass | /klassen/{klasse_id}/resultaten | KRIJGEN | ✓ |
getLineItemsForClass | /klassen/{klasse_id}/regelitems | KRIJGEN | ✓ |
getResultsForLineItemForClass | /classes/{class_id}/lineItems/{li_id}/results | KRIJGEN | ✓ |
getResultsForStudentForClass | /classes/{class_id}/students/{student_id}/results | KRIJGEN | ✓ |
putCategory | /categorieën/{id} | NEERZETTEN | X |
putLineItem | /lineItems/{id} | NEERZETTEN | ✓ |
putResult | /results/{id} | NEERZETTEN | ✓ |
putCategory* | /categorieën* | NEERZETTEN | X |
putLineItem* | /lineItems* | NEERZETTEN | ✓ |
putResult* | /resultaten* | NEERZETTEN | ✓ |
*sourcedId is weggelaten uit deze API-aanroepen
Passback-eindpunten met prestatieclassificatie
Ten minste één van de volgende Performance Grade Passback-integratie-eindpuntmethoden moet worden geïmplementeerd.
Serviceaanvraag | Eindpunt | HTTP-werkwoord | Vereist |
|---|
getFilteredClassCategory | /categorieën?filter=metadata.classId='{class_id}' | KRIJGEN | X* |
getCategoriesForClass | /klassen/{klasse_id}/categorieën | KRIJGEN | ✓** |
Hoewel niet strikt noodzakelijk, voorkomt de implementatie van dit filter dat alle categorieën hoeven te worden opgehaald en in de cache opgeslagen.
**Als u de categorie niet implementeert**metadata.classidDeze implementatie is vereist. Hiermee kunnen klassen aan een categorie worden gekoppeld.