Prydffurfweddu rhestruAr gyfer eich integreiddiad OneRoster, dylech gefnogi'r ddau gyfluniad gwasanaeth rhestru a dilyn canllawiau arfer gorau.
Mae dilyn canllawiau arfer gorau ar gyfer eich integreiddio yn sicrhau trosglwyddiadau data rhestru cywir ac yn dileu dyfalu cywiro cofrestru.
Nodyn:Mae Instructure yn Ddefnyddiwr OneRoster. Am ddiffiniadau Defnyddiwr a Darparwr OneRoster, gweler yCyflwyniad i OneRoster.
Sesiynau/Tymhorau Academaidd
Os yw eich system wybodaeth electronig (SIS) yn defnyddio ID term cyffredin i grwpio termau, cofiwch gynnwys yr ID term cyffredin yn yr ymateb API. Gellir defnyddio'r ID term cyffredin i nodi termau os oes angen eu huno yn Canvas.
Dysgu mwy am OneRostermanylebau sesiwn academaidd.
Enghraifft |
|---|
{
"title": "A 707 07/08",
"sourcedid": "{hash}-{schoolId}-{termIdentifer}",
...
}
|
Set Data sydd ar Gael
Gosodwch eich pwyntiau terfyn echdynnu data OneRoster ar gyfer y flwyddyn ysgol gyfredol, gan gynnwys yr holl ddata hanesyddol a data yn y dyfodol o fewn y flwyddyn ysgol fel y'i diffinnir gan eich system. Yn ogystal, cynnwys yr holl wrthrychau data yn yr echdynnu data gyda'r dyddiadau gorffen angenrheidiol i osgoi dileu data yn ddiangen yn y systemau targed.
Dysgu mwy am OneRosterpwyntiau terfyn rhestruacydymffurfiaeth â phwyntiau terfyn rhestru.
Cofnodion Cofrestru Dyblyg
Os oes gan ddefnyddiwr sawl cofnod cofrestru ar gyfer yr un dosbarth, dim ond y cofnod cofrestru cyfredol sydd ei angen.
Er enghraifft, os yw Myfyriwr A yn Nosbarth 123 wedi cofrestru yn y dosbarth, wedi'i dynnu, ac yna wedi'i ailgofrestru, darparwch y statws cofrestru mwyaf priodol ar yr adeg y gwneir yr alwad API yn lle cofnodion cofrestru lluosog Myfyriwr A.
Dyddiadau Dechrau a Gorffen Cofrestru
Rhaid i bob cofnod cofrestru gynnwys dyddiad cychwyn a dyddiad diwedd, hyd yn oed os yw'r dyddiadau hynny yr un fath â dyddiadau'r tymor. Drwy gymharu dyddiadau cofrestru a dyddiadau tymor, gall Canvas gynnal statws cofrestru cywir.
caelPobDefnyddiwr/defnyddwyr
Os yw eich sefydliad yn cefnogi defnyddio rôl arsylwr Canvas (ar gyfer rhieni, gwarcheidwaid, ac ati), argymhellir eich bod yn cynnwys y proffiliau defnyddwyr hyn yn eich ffurfweddiad gweithredu.
Cysoni Data Cynyddrannol
Yn lle defnyddio tynnu data llawn, gallwch ffurfweddu cysoni data cynyddrannol gan ddefnyddio adyddiadDiwygiwydDiwethafhidlydd ymholiad.
Nodyn:Er mwyn gweithredu cydamseriadau data cynyddrannol yn ddibynadwy, rhaid i chi gynnwys y statws dileu neu'r dyddiad gorffen ar gyfer pob cofnod cofrestru. Heb y wybodaeth hon, dim ond trwy wahaniaethu cydamseriad data llawn newydd yn erbyn cydamseriad data llawn y gellir cyfrifo gostyngiadau cofrestru.