Quand configuration des planningsPour votre intégration OneRoster, vous devez prendre en charge les deux configurations de service de planification et respecter les bonnes pratiques.
Le respect des bonnes pratiques d'intégration garantit des transferts corrects des données de gestion des effectifs et élimine les conjectures liées à la correction des inscriptions.
Note:Instructure est un consommateur OneRoster. Pour les définitions de consommateur et de fournisseur OneRoster, consultez la documentation.Introduction à OneRoster.
Sessions/Semestres académiques
Si votre système d'information scolaire utilise un identifiant de terme commun pour regrouper les termes, veuillez inclure cet identifiant dans la réponse de l'API. Cet identifiant permettra d'identifier les termes à fusionner dans Canvas.
En savoir plus sur OneRosterspécifications de la session académique.
Exemple |
|---|
{
"title": "A 707 07/08",
"sourcedId": "{hash}-{schoolId}-{termIdentifer}",
...
}
|
Ensemble de données disponible
Configurez vos points de terminaison d'extraction de données OneRoster pour l'année scolaire en cours, y compris toutes les données historiques et futures de cette année scolaire, telles que définies par votre système. De plus, incluez tous les objets de données dans l'extraction, avec les dates de fin nécessaires, afin d'éviter toute suppression indésirable de données dans les systèmes cibles.
En savoir plus sur OneRosterpoints de terminaison de la planification et conformité des points de terminaison de planification.
Dossiers d'inscription dupliqués
Si un utilisateur a plusieurs inscriptions pour le même cours, ne fournissez que l'inscription actuelle.
Par exemple, si l'étudiant A de la classe 123 est inscrit au cours, retiré, puis réinscrit, fournissez le statut d'inscription le plus approprié au moment où l'appel API est effectué au lieu des multiples enregistrements d'inscription de l'étudiant A.
Dates de début et de fin des inscriptions
Chaque inscription doit comporter une date de début et une date de fin, même si ces dates correspondent aux dates du semestre. En comparant les dates d'inscription et de semestre, Canvas peut garantir l'exactitude des statuts d'inscription.
obtenirTousLesUtilisateurs/utilisateurs
Si votre établissement prend en charge l'utilisation du rôle d'observateur Canvas (pour les parents, les tuteurs, etc.), il est recommandé d'inclure ces profils d'utilisateur dans votre configuration d'implémentation.
Synchronisations de données incrémentales
Au lieu d'utiliser des extractions complètes de données, vous pouvez configurer des synchronisations de données incrémentielles à l'aide d'undateLastModifiedFiltre de requête.
Note:Pour une mise en œuvre fiable des synchronisations de données incrémentielles, il est impératif d'inclure le statut de suppression ou la date de fin de chaque enregistrement d'inscription. Sans ces informations, les suppressions d'inscriptions ne peuvent être calculées qu'en comparant une nouvelle synchronisation complète des données à une synchronisation complète précédente.