Partager via

Données de l’API OneRoster consultées par School Data Sync

  • Article

Importante

En vous connectant et en mettant à disposition des données d’établissement avec School Data Sync, vous reconnaissez être autorisé à partager ces données avec Microsoft et vous engagez à respecter les normes de gouvernance des données de votre organization.

L’API OneRoster (Interfaces de programmation d’applications) est un format Standard de l’industrie, de 1EdTech (anciennement IMS Global), pour l’échange de données SIS (Student Information System) / Systèmes de gestion des étudiants (SMS). À l’aide de cette méthode de synchronisation, vous pouvez vous connecter directement à votre SIS/SMS à l’aide des API OneRoster 1.1 basées sur REST développées par votre fournisseur SIS/SMS. La prise en charge de l’API vous permet de synchroniser les données directement au lieu d’utiliser des fichiers CSV (Valeur séparée par des virgules).

La liste suivante est fournie pour vous aider à mieux comprendre les données auxquelles vous accédez lors de la connexion à votre SIS/SMS via l’API OneRoster.

Points de terminaison de l’API OneRoster requis pour les données scolaires

Action URL Propriétés de filtre requises Filtre facultatif/recommandé Exemples
GetAllAcademicSessions /academicSessions status Datelastmodified /academicSessions ?offset=0&limit=5000&filter=status='active'/academicSessions ?filter=dateLastModified>'{deltaDateTime}'
GetAllOrgs /orgs status Datelastmodified /orgs ?offset=0&limit=5000&filter=status='active'/orgs ?filter=dateLastModified>'{deltaDateTime}'
GetAllUsers /Utilisateurs status Datelastmodified /users ?offset=0&limit=5000&filter=status='active'/users ?filter=dateLastModified>'{deltaDateTime}'
GetAllClasses /Classes status Datelastmodified /classes ?offset=0&limit=5000&filter=status='active'/classes ?filter=dateLastModified>'{deltaDateTime}'
GetAllEnrollments /Inscriptions status Datelastmodified /enrollments ?offset=0&limit=5000&filter=status='active'/enrollments ?filter=dateLastModified>'{deltaDateTime}'

Points de terminaison d’API facultatifs pour la synchronisation des données scolaires

Remarque

Pour les éléments de données facultatifs pour les données démographiques, les relations de contact des étudiants et les indicateurs d’utilisateur étudiant, la possibilité d’inclure ces données ou non sera basée sur les fonctionnalités de données facultatives prises en charge à partir de votre profil de fournisseur ONERoster SIS/SMS. Si le fournisseur SIS/SMS prend également en charge ces données, vous verrez le bouton bascule (par défaut) sélectionné Sur pour inclure des données supplémentaires. Vous pouvez sélectionner le bouton bascule à désactiver si vous le souhaitez. Si le bouton bascule n’est pas disponible, s’il est affiché mais désactivé et n’est pas disponible pour l’interaction, cela signifie que le profil du fournisseur ne prend actuellement pas en charge la fourniture de ces données.

Remarque

Si le profil du fournisseur affiche des indicateurs démographiques, des contacts ou des utilisateurs comme étant indisponibles et que vous souhaitez qu’il prenne en charge cette fonctionnalité, contactez votre fournisseur et demandez l’ajout d’un support pour permettre à SDS d’ingérer les données et vous permettre d’activer les scénarios et les expériences pris en charge par les données. 

Action URL Propriétés de filtre requises Filtre facultatif/recommandé Exemples
GetAllCourses /Cours status Datelastmodified /courses ?offset=0&limit=5000&filter=status='active'/courses ?filter=dateLastModified>'{deltaDateTime}'
GetAllDemographics /Démographie status Datelastmodified /demographics ?offset=0&limit=5000&filter=status='active'/demographics ?filter=dateLastModified>'{deltaDateTime}'