Course API

Titel

Course API

Status

In ontwikkeling ROSA-Architectuurscan BEsluitvorming in beheer

Versie

Documentatie: 0.0.3

schemaVersion: 0.0.3

Datum

19 April 2024

Auteur

Werkgroep Combineren en arrangeren

Acties

• Geen openstaande acties

Gegevensdienst

Leermaterialen

Scopes

• course

Objecten

• Course

• CourseStructure

Bron

• Leermaterialencatalogus

Afnemers

• Overkoepelende leermiddelencatalogus

• Onderwijsleeromgeving

• Leermiddelendashboard

Endpoints

Leermaterialencatalogus

• GET Courses

• GET Course by ID

• GET CourseStructure by ID

Notifications

De Notifications API kan gebruikt worden om als afnemer een notificatie te ontvangen bij een wijziging in de stand (nieuw/gewijzigd/verwijderde Course). Hiervoor dient zowel de bron als de afnemer dan de Berichteninfrastructuur en de Notifications API te hebben geïmplementeerd.

• Berichteninfrastructuur voor het versturen en ontvangen van berichten

• Notifications API

Veld

Type

Format

Omschrijving

Voorbeeld

O/V

Vullingsregel

courseId

string

string

De unieke identifier voor de Course

V

Waarde mag niet gewijzigd worden

title

string

string

De benaming voor de Course.

V

description

string

string

Korte omschrijving van de Course

O

lastPublished
Version

string

string

Laatst gepubliceerde versie van de Course.

#1

#1.2

2022-03-24

V

Versienummer zoals gehanteerd door de leverancier.

Bij iedere wijziging op de Course wordt het nummer verhoogd.

studies

array

Study

De opleidingseenheden waar deze Course op gericht is.

Zie object Study in de Catalogue API

V

Werkingsregel is om dit veld te vullen conform de waardelijst afspraken voor opleidingen, opleidingsjaren en niveaus.

subjects

array

Subject

De vakken waar deze Course op gericht is.

Zie object Subject in de Catalogue API

V

Werkingsregels is om dit veld te vullen conform de waardelijst afspraken voor vakken.

Veld

Type

Format

Omschrijving

Voorbeeld

O/V

Vullingsregel

course

object

Course

Bevat de metadata over de Course

Zie course

V

objectives

array

Objective

Bevat de leerdoelen van de Course

Zie objective

O

aus

array

Au

Bevat de assignable units (Leermaterialen) van de Course

Zie au

O

Wordt gebruikt zodra de Course bestaat uit een enkel niveau en alleen bestaat uit een aantal Leermaterialen.

blocks

array

Block

Bevat de blocks (Leermodules) van de Course

Zie block

O

Wordt gebruikt zodra de Course bestaat uit meerdere niveaus (zoals hoofdstukken en paragrafen).

Veld

Type

Format

Omschrijving

Voorbeeld

O/V

Vullingsregel

id

string

string

De unieke identifier voor deze Course

V

Komt overeen met courseId uit Course object.

Waarde mag niet gewijzigd worden

title

array

[lang, langstring]

Een titel (langstring) en de taal van de titel (lang)

[nl-NL, Hallo]

V

In XML te representeren als: <langstring lang=”nl-NL”>Hallo
</langstring>

Dit is niet mogelijk in openAPI3, zie issue

description

array

[lang, langstring]

Een beschrijving (langstring) en de taal van de beschrijving (lang)

[nl-NL, Cursusbeschrijving voor Stepping Stones]

V

Zie title

image

string

URI

URI naar een afbeelding om deze Course te representeren

O

publicationdate

string

date

Datum van publicatie van de huidige versie van de Course

2022-11-02

O*

Waarde is in CMI5 niet verplicht.

Vullingsregel is om dit veld te vullen met de datum van publicatie van de versie

publisher

string

string

Naam van de uitgever van de Course

Noordhoff

O

streamcode

string

string

Benaming om de Course te identificeren

steppingstone-5e-4vwo

O

version

string

string

De versie van de Course

#1

#1.2

2022-03-24

O*

Waarde is in CMI5 niet verplicht.

Vullingsregel is om deze gelijk te stellen aan lastPublished
Version in Course object

Bij iedere wijziging op de Course wordt het nummer verhoogd.

streams

array

Stream

Aanduidingen voor streams die gebruikt worden als type in de assignable units.

Helpt Leraren om individuele leerroutes voor leerlingen te plannen.

optioneel

verdieping

Zie Stream

O

Veld

Type

Format

Omschrijving

Voorbeeld

O/V

Vullingsregel

id

string

string

Unieke identifier voor de stream

O

Waarde mag niet gewijzigd worden

description

string

string

Beschrijving van de stream

optioneel

verdieping

O

Veld

Type

Format

Omschrijving

Voorbeeld

O/V

Vullingsregel

id

string

string

Unieke identifier voor het leerdoel

V

Waarde mag niet gewijzigd worden

title

string

string

Benaming voor het leerdoel

O

description

string

string

Korte omschrijving van het leerdoel

O

Veld

Type

Format

Omschrijving

Voorbeeld

O/V

Vullingsregel

id

string

string

Unieke identifier voor de assignable unit

-

V

Waarde mag niet gewijzigd worden

activity
Type

string

string

Beschrijft hoe het leermateriaal te interpreteren.

Oefening

Naslagwerk

Arrangement

Assignment

Test

Instructie

Theorie

V

Dit is een vrij veld. Voorkeur heeft om hier op termijn afspraken over te maken.

launch
Method

string

ENUM

Beschrijft hoe de content gepresenteerd dient te worden

AnyWindow

OwnWindow

V

Exact gebruik van launchmethod en launchParameters is nog niet gedocumenteerd.
Dit veld wordt genegeerd.

Default: AnyWindow

moveOn

string

ENUM

Wordt gebruikt door een Onderwijsleeromgeving om te bepalen of een assignable unit volwaardig is afgerond.

Passed

Completed

CompletedAndPassed

Completed
OrPassed

NotApplicable

V

Dit veld is verplicht maar wordt niet gebruikt.

Default: CompletedOrPassed

title

array

[lang, langstring]

Een titel (langstring) en de taal van de titel (lang)

[nl-NL, Hallo]

V

In XML te representeren als: <langstring lang=”nl-NL”>Hallo
</langstring>

Dit is niet mogelijk in openAPI3, zie issue

description

array

[lang, langstring]

Een beschrijving (langstring) en de taal van de beschrijving (lang)

[nl-NL, Hallo]

O

Zie title

objectives

array

objective
.id

Een array van ids van Objectives (Leerdoelen) waar dit Leermateriaal aan bijdraagt.

-

O

url

string

url

Deeplink naar het Leermateriaal

www.uitgever.nl/leermateriaal

V

Optioneel kan een Onderwijsleeromgeving gebruik maken van de parameter product om de Aanbieder een suggestie te geven van het Leermiddel waartoe het Leermateriaal behoort en waarop de onderwijsdeelnemer een aanspraak heeft.

launch
Parameters

string

string

De parameters die meegestuurd worden in een Launched statement

O

Exact gebruik van launchmethod en launchParameters is nog geen onderdeel van de specificatie.
Dit veld wordt genegeerd.

image

string

URI

URI naar een afbeelding om deze Assignable Unit te representeren

-

O

streamref

string

stream
.id

Referentie naar een stream waar dit Leermateriaal binnen valt.

-

O

Veld

Type

Format

Omschrijving

Voorbeeld

O/V

Vullingsregel

id

string

string

Unieke identifier voor de assignable unit

-

V

Waarde mag niet gewijzigd worden

title

array

[lang, langstring]

Een titel (langstring) en de taal van de titel (lang)

[nl-NL, Hallo]

V

In XML te representeren als: <langstring lang=”nl-NL”>Hallo
</langstring>

Dit is niet mogelijk in openAPI3, zie issue

description

array

[lang, langstring]

Een beschrijving (langstring) en de taal van de beschrijving (lang)

[nl-NL, Hallo]

O

Zie title

Veld wordt veelal gevuld met beschrijving van Hoofdstuk of Paragraaf.

blocks

array

Block

Een array van Blocks die onderdeel zijn van dit Block

Zie deze Tabel

O

Een Block kan weer bestaan uit één of meerdere Blocks.

aus

array

Au

Een array van Assignable Units die onderdeel zijn van dit Block

Zie object Assignable Unit

O

Een Block kan bestaan uit één of meerdere Assignable Units.

instructions

array

[lang, langstring]

Een instructie (langstring) en de taal van de instructie (lang)

[nl-NL, Hallo]

O

Zie title

image

string

URI

URI naar een afbeelding om dit Block te representeren

-

O

studyload
indicator

integer

integer

Een relatieve indicator voor de zwaarte van de studielast

1,2,5

O

Deze informatie is zeer zinvol om te representeren in de studiewijzer.

Waarde is een indicatie en geen betreft geen absolute duur in bijvoorbeeld dagen, uren of minuten.