Quando configurazione della programmazioneper l'integrazione con OneRoster, dovresti supportare entrambe le configurazioni del servizio di programmazione e rispettare le linee guida delle best practice.
Seguendo le linee guida delle best practice per l'integrazione, si garantisce il corretto trasferimento dei dati di registrazione ed elimina le congetture sulle correzioni delle iscrizioni.
Nota:Instructure è un consumatore OneRoster. Per le definizioni di consumatore e fornitore OneRoster, consultareIntroduzione a OneRoster.
Sessioni/Termini Accademici
Se il tuo SIS utilizza un ID termine comune per raggruppare i termini, includilo nella risposta API. L'ID termine comune può essere utilizzato per identificare i termini se devono essere uniti in Canvas.
Scopri di più su OneRosterspecifiche della sessione accademica
Esempio |
|---|
{
"title": "A 707 07/08",
"sourcedId": "{hash}-{schoolId}-{termIdentifer}",
...
}
|
Set di dati disponibili
Imposta gli endpoint di estrazione dati OneRoster per l'anno scolastico in corso, inclusi tutti i dati storici e futuri dell'anno scolastico, come definito dal tuo sistema. Inoltre, includi tutti gli oggetti dati nell'estrazione dati con le date di fine necessarie per evitare l'eliminazione indesiderata di dati nei sistemi di destinazione.
Scopri di più su OneRosterpunti finali di programmazione E conformità degli endpoint di programmazione.
Registri di iscrizione duplicati
Se un utente ha più record di iscrizione per la stessa classe, fornire solo il record di iscrizione corrente.
Ad esempio, se lo studente A della classe 123 è iscritto alla classe, rimosso e poi reiscritto, fornire lo stato di iscrizione più appropriato al momento in cui viene effettuata la chiamata API anziché i record di iscrizione multipli dello studente A.
Date di inizio e fine dell'iscrizione
Ogni record di iscrizione deve includere sia una data di inizio che una data di fine, anche se queste date coincidono con le date del trimestre. Confrontando le date di iscrizione e quelle del trimestre, Canvas può mantenere lo stato di iscrizione corretto.
getAllUsers/utenti
Se il tuo istituto supporta l'uso del ruolo di osservatore Canvas (per genitori, tutori, ecc.), ti consigliamo di includere questi profili utente nella configurazione dell'implementazione.
Sincronizzazione dati incrementale
Invece di utilizzare estrazioni complete dei dati, è possibile configurare sincronizzazioni incrementali dei dati utilizzando undataUltimaModificafiltro di query.
Nota:Per implementare in modo affidabile le sincronizzazioni incrementali dei dati, è necessario includere lo stato di eliminazione o la data di fine per ogni record di iscrizione. Senza queste informazioni, le perdite di iscrizione possono essere calcolate solo confrontando una nuova sincronizzazione completa dei dati con una sincronizzazione completa dei dati.