Bekijk de volgende informatie over de typen gegevens, ondersteunde waarden, optionaliteit en manieren waarop gegevens die worden overgedragen met OneRoster API's worden gebruikt in Brightspace®.
Academische sessies
| OneRoster |
Ondersteunde waarden |
Gebruiken op Brightspace®-platform |
Verplicht |
|---|
|
SourcedId
|
|
Opgeslagen met IPSIS voor toewijzing aan een Brightspace®-organisatie-eenheid |
J
|
|
Status
|
actief, tobedeleted
|
De academische sessie maken/bijwerken of verwijderen
|
J
|
|
DateLastModified
|
YYYY-MM-DDThh:mm:ss.sssZ
|
Genegeerd
|
J
|
|
MetaData
|
|
Genegeerd
|
N
|
|
Titel
|
|
Naam organisatie-eenheid en code organisatie-eenheid
|
J
|
|
StartDate
|
DD-MM-JJJJ
|
Academische sessies zijn beschikbaar voor instructeurs wanneer ze score-onderdelen configureren om naar het SIS te exporteren. De datums worden door IPSIS opgeslagen en zijn vereist wanneer u score-onderdelen naar het SIS verzendt.
De startdatum van de academische sessie kan worden gekopieerd naar de startdatums van gekoppelde cursusedities.
|
J
|
|
EndDate
|
DD-MM-JJJJ
|
Academische sessies zijn beschikbaar voor instructeurs wanneer ze score-onderdelen configureren om naar het SIS te exporteren. De datums worden door IPSIS opgeslagen en zijn vereist wanneer u score-onderdelen naar het SIS verzendt.
De einddatum van de academische sessie kan worden gekopieerd naar de einddatums van gekoppelde cursusedities.
|
J
|
|
Type
|
term, semester, schoolYear, gradingPeriod
|
Type organisatie-eenheid
Opmerking: Alle studentinformatiesystemen verzenden alle typen
|
J
|
|
Bovenliggend item
|
|
Genegeerd
|
N
|
|
Onderliggende onderdelen
|
|
Genegeerd
|
N
|
|
SchoolYear
|
|
Genegeerd
|
J
|
Organisaties
| OneRoster |
Ondersteunde waarden |
Gebruiken op Brightspace®-platform |
Verplicht |
|---|
|
SourcedId
|
|
Opgeslagen met IPSIS voor toewijzing aan een Brightspace®-organisatie-eenheid |
J
|
|
Status
|
actief, tobedeleted
|
De organisatie-eenheid maken/bijwerken of verwijderen
|
J
|
|
DateLastModified
|
YYYY-MM-DDTHH:mm:SS.sssZ
|
Genegeerd |
J
|
|
MetaData
|
|
Genegeerd
|
N
|
|
Naam
|
|
Naam organisatie-eenheid en code organisatie-eenheid (als id niet is ingevuld)
|
J
|
|
Id
|
|
Code organisatie-eenheid (indien opgegeven)
|
N
|
|
Type
|
afdeling, school, district, lokaal, staat, nationaal
|
Type organisatie-eenheid
Opmerking: Niet alle studentinformatiesystemen verzenden alle typen
|
J
|
|
Bovenliggend item
|
sourcedId van een organisatie
|
bovenliggende organisatie-eenheid. Voor districtorganisatie-eenheden is er geen bovenliggend item. Voor schoolorganisatie-eenheden is het bovenliggende item het district.
|
Niet specifiek vereist, maar zonder dit element maken de organisatie-eenheden geen deel uit van een hiërarchie.
|
|
Onderliggende onderdelen
|
|
Genegeerd
|
N
|
Cursussen
| OneRoster |
Ondersteunde waarden |
Gebruiken op Brightspace®-platform |
Verplicht |
|---|
|
SourcedId
|
|
Opgeslagen met IPSIS voor toewijzing aan een Brightspace®-organisatie-eenheid (cursussjabloon) |
J
|
|
Status
|
actief, tobedeleted
|
De cursussjabloon maken/bijwerken of verwijderen
|
J
|
|
DateLastModified
|
YYYY-MM-DDTHH:mm:SS.sssZ
|
Genegeerd |
J
|
|
MetaData
|
|
Genegeerd
|
N
|
|
Titel
|
|
Naam organisatie-eenheid en code organisatie-eenheid (als courseCode niet is ingevuld)
|
J
|
|
SchoolYear
|
|
Genegeerd
|
N
|
|
CourseCode
|
|
Code organisatie-eenheid (indien opgegeven)
|
N
|
|
Scores
|
|
Genegeerd
|
N
|
|
Onderwerpen
|
|
Genegeerd
|
N
|
|
Organisatie
|
sourcedId van een organisatie |
Dit is voornamelijk de organisatie-eenheid van de school, maar kan SIS-afhankelijk zijn |
Y. Wordt gebruikt om een organisatiestructuur te maken |
|
SubjectCodes
|
|
Genegeerd |
N
|
|
Bronnen
|
|
Genegeerd
|
N
|
Groepen
| OneRoster |
Ondersteunde waarden |
Gebruiken op Brightspace®-platform |
Verplicht |
|---|
|
SourcedId
|
|
Opgeslagen met IPSIS voor toewijzing aan een Brightspace®-organisatie-eenheid (cursuseditie) |
J
|
|
Status
|
actief, tobedeleted
|
De cursuseditie en sectie maken/bijwerken of verwijderen (ingesteld op inactief of verwijderen op basis van IPSIS-beheerconfiguratie)
|
J
|
|
DateLastModified
|
YYYY-MM-DDTHH:mm:SS.sssZ
|
Genegeerd |
J
|
|
MetaData
|
|
Genegeerd
|
N
|
|
Titel
|
|
Naam organisatie-eenheid en code organisatie-eenheid (als classCode niet is ingevuld)
|
J
|
|
classCode
|
|
Code organisatie-eenheid (indien opgegeven)
|
N
|
|
classType
|
gepland, thuisonderwijs
|
Genegeerd
|
J
|
|
Locatie
|
|
Genegeerd
|
N
|
|
Scores
|
|
Genegeerd
|
N
|
| Onderwerpen |
|
Genegeerd |
N |
| Cursus |
sourceId van een cursus |
Bovenliggende organisatie-eenheid van cursussjabloon |
J |
| School |
sourceId van een cursus |
Bovenliggende organisatie-eenheid van school |
J |
| Termen |
Lijst met sourceId's van academische sessies |
Eén bovenliggende organisatie-eenheid van academische sessie |
J |
| subjectCodes |
|
Genegeerd |
N |
| Perioden |
|
Genegeerd |
N |
| Bronnen |
|
Genegeerd |
N |
Gebruikers
| OneRoster |
Ondersteunde waarden |
Gebruiken op Brightspace®-platform |
Verplicht |
|---|
|
SourcedId
|
|
Opgeslagen met IPSIS voor toewijzing aan een Brightspace®-gebruik. Als er geen id wordt opgegeven, wordt sourceId de door de organisatie gedefinieerde id.
|
J
|
|
Status
|
actief, tobedeleted
|
De gebruiker maken/bijwerken of verwijderen (ingesteld op inactief of verwijderen op basis van IPSIS-beheerconfiguratie)
|
J
|
|
DateLastModified
|
YYYY-MM-DDTHH:mm:SS.sssZ
|
Genegeerd |
J
|
|
MetaData
|
|
Genegeerd
|
N
|
|
UserName
|
|
UserName
|
J
|
|
UserIds
|
|
Genegeerd
|
N
|
|
EnabledUser
|
true, false
|
De actieve status van de gebruiker
|
J
|
|
GivenName
|
|
Wettelijke voornaam
|
J
|
|
FamilyName
|
|
Wettelijke achternaam
|
J
|
|
MiddleName
|
|
Tweede naam
|
N
|
|
Rol
|
beheerder, assistent, voogd, ouder, surveillant, familielid, student, leraar
|
Brightspace®-rol in organisatie
|
J
|
|
Id
|
|
OrgDefinedId
|
N
|
|
E-mail
|
|
Extern e-mailadres
|
N
|
|
Sms
|
|
Genegeerd
|
N
|
|
Telefoon
|
|
Genegeerd
|
N
|
|
Agenten
|
Lijst met sourceIds van gebruikers
|
Brightspace® Ouder & voogd:
Voor gebruikersrecords met de rol van student en voor records die agents hebben met de rol van ouder of voogd worden ouderrelaties gemaakt.
|
N
|
|
Organisaties
|
Bovenste organisatie-eenheden
|
Inschrijving in bovenste organisatie-eenheden
|
J
|
|
Scores
|
|
Genegeerd
|
N
|
|
Wachtwoord
|
|
Gebruikerswachtwoord
|
N
|
Inschrijvingen
| OneRoster |
Ondersteunde waarden |
Gebruiken op Brightspace®-platform |
Verplicht |
|---|
|
SourcedId
|
|
Opgeslagen met IPSIS voor het traceren van inschrijving in een cursus |
J
|
|
Status
|
actief, tobedeleted
|
De gebruiker in- of uitschrijven voor de cursuseditie en het gedeelte
|
J
|
|
DateLastModified
|
YYYY-MM-DDTHH:mm:SS.sssZ
|
Genegeerd |
J
|
|
MetaData
|
|
Genegeerd
|
N
|
|
Gebruiker
|
sourcedId van een gebruiker
|
Gebruiker om in of uit te schrijven
|
J
|
|
Groep
|
sourceId van een groep
|
Cursuseditie en sectie waarin de gebruiker wordt in- of uitgeschreven
|
J
|
|
School
|
|
Genegeerd
|
J
|
|
Rol
|
beheerder, surveillant, student, docent
|
Rol van de gebruiker in de organisatie-eenheid
|
J
|
|
Primair
|
|
Genegeerd
|
N
|
|
BeginDate
|
|
Genegeerd
|
N
|
|
EndDate
|
|
Genegeerd
|
N
|