Compartir a través de

Datos de api de OneRoster a los que accede School Data Sync

  • Artículo

Importante

Al conectar y hacer que los datos de la institución estén disponibles con School Data Sync, reconoce que está autorizado para compartir estos datos con Microsoft y se compromete a cumplir los estándares de gobernanza de datos de su organización.

OneRoster API (Application Programming Interfaces) es un formato estándar del sector, de 1EdTech (anteriormente IMS Global), para el intercambio de datos de Student Information System (SIS) / Student Management Systems (SMS). Con este método de sincronización, puede conectarse directamente a su SIS/SMS mediante las API de OneRoster 1.1 basadas en REST desarrolladas por su proveedor de SIS/SMS. La compatibilidad con la API permite sincronizar datos directamente en lugar de usar archivos CSV (valores separados por comas).

Se proporciona la lista siguiente para ayudarle a comprender mejor a qué datos se accede al conectarse a su SIS/SMS a través de oneroster API.

Puntos de conexión de API de OneRoster necesarios para datos educativos

Acción URL Propiedades de filtro necesarias Filtro opcional o recomendado Ejemplos
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 /Usuarios status dateLastModified /users?offset=0&limit=5000&filter=status='active'/users?filter=dateLastModified>'{deltaDateTime}'
GetAllClasses /Clases status dateLastModified /classes?offset=0&limit=5000&filter=status='active'/classes?filter=dateLastModified>'{deltaDateTime}'
GetAllEnrollments /Inscripciones status dateLastModified /enrollments?offset=0&limit=5000&filter=status='active'/enrollments?filter=dateLastModified>'{deltaDateTime}'

Puntos de conexión de API opcionales para School Data Sync

Nota:

En el caso de los datos opcionales de datos demográficos, relaciones de contacto de alumnos y marcas de usuario de alumnos, la capacidad de incluir estos datos o no se basará en las funcionalidades de datos opcionales admitidas del perfil de proveedor de OneRoster de SIS/SMS. Si el proveedor SIS/SMS también admite estos datos, verá el botón de alternancia (valor predeterminado) seleccionado Activado para incluir datos adicionales. Puede seleccionar el botón de alternancia para desactivar si lo desea. Si el botón de alternancia no está disponible, se muestra pero no está disponible para la interacción, esto significa que el perfil del proveedor no admite actualmente proporcionar esos datos.

Nota:

Si el perfil del proveedor muestra la demografía, los contactos o las marcas demográficas del usuario como no disponibles y desea que admitan esa característica, póngase en contacto con su proveedor y solicite que se agregue soporte técnico para permitir que SDS ingiere los datos y le permita habilitar los escenarios y experiencias que admiten los datos. 

Acción URL Propiedades de filtro necesarias Filtro opcional o recomendado Ejemplos
GetAllCourses /Cursos status dateLastModified /courses?offset=0&limit=5000&filter=status='active'/courses?filter=dateLastModified>'{deltaDateTime}'
GetAllDemographics /Demografía status dateLastModified /demographics?offset=0&limit=5000&filter=status='active'/demographics?filter=dateLastModified>'{deltaDateTime}'