L'intégration Instructure OneRoster grade passback (GPB) prend en charge les configurations de point de terminaison GPB standard ou modifiées. Parce qu'elle suit plus strictement OneRosterspécifications de configuration du point de terminaisonLa configuration GPB standard est recommandée.
De plus, pour améliorer les performances, incluez un point de terminaison de performance dans votre configuration GPB.
En savoir plus sur OneRosterconformité du point de terminaison du carnet de notes.
Note:Instructure est un consommateur OneRoster. Pour les définitions de consommateur et de fournisseur OneRoster, consultez la documentation.Introduction à OneRoster.
Passage de grade standard
Le point de terminaison d'intégration GPB standard inclut l'identifiant source de l'affectation lors de la synchronisation des données du carnet de notes de Canvas vers votre SIS.
Appel de service | Point de terminaison | Verbe HTTP | Requis |
|---|
getAllCategories | /catégories | OBTENIR | ✓ |
obtenirTousLesÉlémentsDeLigne | /lineItems | OBTENIR | ✓ |
obtenirRésultatsPourClasse | /classes/{class_id}/résultats | OBTENIR | ✓ |
obtenirLineItemsForClass | /classes/{class_id}/lineItems | OBTENIR | ✓ |
obtenirRésultatsPourLigneÉlémentPourClasse | /classes/{class_id}/lineItems/{li_id}/results | OBTENIR | ✓ |
obtenirRésultatsPourÉtudiantPourClasse | /classes/{class_id}/students/{student_id}/results | OBTENIR | ✓ |
putCategory | /catégories/{id} | METTRE | 𝗫 |
putLineItem | /lineItems/{id} | METTRE | ✓ |
putResult | /résultats/{id} | METTRE | ✓ |
Passage de note modifié
Le point de terminaison GPB modifié omet l'identifiant source de l'affectation lors de la synchronisation des données du carnet de notes de Canvas vers votre SIS.
En réponse à l'appel PUT pour les nouveaux enregistrements, le fournisseur OneRoster doit renvoyer l'identifiant sourcedId. L'intégration stocke ensuite ces données pour une utilisation ultérieure lors des appels d'API.
Appel de service | Point de terminaison | Verbe HTTP | Requis |
|---|
obtenirToutesLesCatégories | /catégories | OBTENIR | ✓ |
obtenirTousLesÉlémentsDeLigne | /lineItems | OBTENIR | ✓ |
obtenirRésultatsPourClasse | /classes/{class_id}/résultats | OBTENIR | ✓ |
obtenirLineItemsForClass | /classes/{class_id}/lineItems | OBTENIR | ✓ |
obtenirRésultatsPourLigneÉlémentPourClasse | /classes/{class_id}/lineItems/{li_id}/results | OBTENIR | ✓ |
obtenirRésultatsPourÉtudiantPourClasse | /classes/{class_id}/students/{student_id}/results | OBTENIR | ✓ |
putCategory | /catégories/{id} | METTRE | 𝗫 |
putLineItem | /lineItems/{id} | METTRE | ✓ |
putResult | /résultats/{id} | METTRE | ✓ |
putCategory* | /catégories* | METTRE | 𝗫 |
putLineItem* | /lineItems* | METTRE | ✓ |
putResult* | /résultats* | METTRE | ✓ |
*sourcedId omis dans ces appels d'API
Points de retour de performance
Au moins une des méthodes de point de terminaison d'intégration Passback de Performance Grade suivantes doit être implémentée.
Appel de service | Point de terminaison | Verbe HTTP | Requis |
|---|
obtenirClasseFiltée | /categories?filter=metadata.classId='{class_id}' | OBTENIR | 𝗫* |
obtenirCategoriesForClass | /classes/{class_id}/categories | OBTENIR | ✓** |
*Bien que cela ne soit pas strictement nécessaire, la mise en œuvre de ce filtre évite d'avoir à extraire et à mettre en cache toutes les catégories.
**Si vous n'implémentez pas la catégoriemétadonnées.classidCette implémentation est requise. Elle permet aux classes d'être associées à une catégorie.