Wanneer het configureren van roostersVoor uw OneRoster-integratie dient u beide configuraties van de roosteringsservice te ondersteunen en de richtlijnen voor best practices te volgen.
Door de richtlijnen voor beste praktijken te volgen bij uw integratie, bent u verzekerd van een correcte overdracht van roostergegevens en wordt giswerk bij het corrigeren van inschrijvingen voorkomen.
Opmerking:Instructure is een OneRoster-consument. Voor definities van OneRoster-consumenten en -providers, zie deIntroductie tot OneRoster.
Academische sessies/termijnen
Als uw SIS een algemene term-ID gebruikt om termen te groeperen, voeg deze dan toe aan het API-antwoord. De algemene term-ID kan worden gebruikt om termen te identificeren als ze in Canvas moeten worden samengevoegd.
Leer meer over OneRosterspecificaties van de academische sessie
Voorbeeld |
|---|
{
"title": "A 707 07/08",
"sourcedId": "{hash}-{schoolId}-{termIdentifer}",
...
}
|
Beschikbare dataset
Stel uw OneRoster-data-extractie-eindpunten in voor het huidige schooljaar, inclusief alle historische en toekomstige gegevens binnen het schooljaar zoals gedefinieerd door uw systeem. Neem bovendien alle dataobjecten met de benodigde einddatums op in de data-extractie om ongewenste verwijdering van gegevens in de doelsystemen te voorkomen.
Leer meer over OneRostereindpunten in de rooster En naleving van de roosteringseisen voor eindpunten.
Dubbele inschrijvingsgegevens
Als een gebruiker meerdere inschrijvingsgegevens voor dezelfde cursus heeft, toon dan alleen de huidige inschrijvingsgegevens.
Als student A in klas 123 bijvoorbeeld is ingeschreven voor de klas, uitgeschreven en vervolgens opnieuw ingeschreven, geef dan de meest relevante inschrijvingsstatus op het moment dat de API-aanroep wordt gedaan, in plaats van de meerdere inschrijvingsgegevens van student A.
Start- en einddatum van de inschrijving
Elk inschrijvingsrecord moet zowel een startdatum als een einddatum bevatten, zelfs als die datums gelijk zijn aan de semesterdata. Door inschrijvings- en semesterdata te vergelijken, kan Canvas de juiste inschrijvingsstatus bijhouden.
getAllUsers/users
Als uw instelling het gebruik van de Canvas-observatorrol ondersteunt (voor ouders, voogden, enz.), is het raadzaam om deze gebruikersprofielen in uw implementatieconfiguratie op te nemen.
Incrementele gegevenssynchronisatie
In plaats van volledige data-ophalingen te gebruiken, kunt u incrementele datasynchronisaties configureren met behulp van eendatumLaatstGewijzigdqueryfilter.
Opmerking:Om incrementele gegevenssynchronisaties betrouwbaar te implementeren, moet u voor elk inschrijvingsrecord de status 'verwijderd' of de einddatum vermelden. Zonder deze informatie kunnen dalingen in het aantal inschrijvingen alleen worden berekend door een nieuwe volledige gegevenssynchronisatie te vergelijken met een eerdere volledige gegevenssynchronisatie.