Condividi tramite

Dati dell'API OneRoster accessibili dalla sincronizzazione dati dell'istituto di istruzione

  • Articolo

Importante

Connettendo e rendendo disponibili i dati dell'istituto con School Data Sync, si riconosce di essere autorizzati a condividere questi dati con Microsoft e a rispettare gli standard di governance dei dati dell'organizzazione.

L'API OneRoster (Application Programming Interfaces) è un formato standard del settore, da 1EdTech (in precedenza IMS Global), per lo scambio di dati SIS (Student Information System) o SMS (Student Management Systems). Usando questo metodo di sincronizzazione, è possibile connettersi direttamente al SIS/SMS usando le API OneRoster 1.1 basate su REST sviluppate dal provider SIS/SMS. Il supporto dell'API consente di sincronizzare i dati direttamente invece di usare file CSV (valori delimitati da virgole).

L'elenco seguente consente di comprendere meglio i dati a cui si accede quando ci si connette al SIS/SMS tramite l'API OneRoster.

Endpoint api OneRoster necessari per i dati dell'istituto di istruzione

Azione URL Proprietà filtro necessarie Filtro facoltativo/consigliato Esempi
GetAllAcademicSessions /academicSessions stato dateLastModified /academicSessions?offset=0&limit=5000&filter=status='active'/academicSessions?filter=dateLastModified>'{deltaDateTime}'
GetAllOrgs /Org stato dateLastModified /orgs?offset=0&limit=5000&filter=status='active'/orgs?filter=dateLastModified>'{deltaDateTime}'
GetAllUsers /Gli utenti stato dateLastModified /users?offset=0&limit=5000&filter=status='active'/users?filter=dateLastModified>'{deltaDateTime}'
GetAllClasses /Classi stato dateLastModified /classes?offset=0&limit=5000&filter=status='active'/classes?filter=dateLastModified>'{deltaDateTime}'
GetAllEnrollments /Iscrizioni stato dateLastModified /enrollments?offset=0&limit=5000&filter=status='active'/enrollments?filter=dateLastModified>'{deltaDateTime}'

Endpoint API facoltativi per la sincronizzazione dati dell'istituto di istruzione

Nota

Per i dati facoltativi per i dati demografici, le relazioni di contatto degli studenti e i flag utente degli studenti, la possibilità di includere o meno questi dati si baserà sulle funzionalità di dati facoltative supportate dal profilo del provider OneRoster SIS/SMS. Se anche il provider SIS/SMS supporta questi dati, verrà visualizzato l'interruttore (impostazione predefinita) selezionato Sì per includere dati aggiuntivi. Se lo si desidera, è possibile selezionare l'interruttore da disattivare. Se l'interruttore non è disponibile, visualizzato ma disattivato e non disponibile per l'interazione, significa che il profilo del provider non supporta attualmente la fornitura di tali dati.

Nota

Se il profilo del provider mostra i dati demografici, i contatti o i flag demografici degli utenti come non disponibili e si vuole che supportino tale funzionalità, contattare il provider e richiedere l'aggiunta del supporto per consentire a SDS di inserire i dati e consentire di abilitare gli scenari e le esperienze supportate dai dati. 

Azione URL Proprietà filtro necessarie Filtro facoltativo/consigliato Esempi
GetAllCourses /Corsi stato dateLastModified /courses?offset=0&limit=5000&filter=status='active'/courses?filter=dateLastModified>'{deltaDateTime}'
GetAllDemographics /Demografia stato dateLastModified /demographics?offset=0&limit=5000&filter=status='active'/demographics?filter=dateLastModified>'{deltaDateTime}'