Catalogue API

Titel	Catalogue API
Status	In ontwikkeling ROSA-Architectuurscan BEsluitvorming implementatie in beheer
Versie	documentatie: 1.0.0
Versie	schemaVersion: 1.0.0
Datum	13 maart 2025
Auteur	Werkgroep Verwerven en in gebruik nemen
Acties	Geen openstaande acties

De Catalogue API wordt gebruikt om informatie over producten (leermiddelen en sets van leermiddelen) te delen in het Afsprakenstelsel Edu-V. Deze API wordt aangeboden als onderdeel van de gegevensdienst Leermiddelen met de referentiecomponent Leveranciersspecifieke leermiddelencatalogus als Bron.

Het product bevat alle informatie noodzakelijk voor het (laten) verwerven van leermiddelen. Ook bevat het product de toegangslink die geplaatst wordt in het Leermiddelenportaal. Deze toegangslink wordt gebruikt voor het in gebruik nemen van een leermiddel door een onderwijsdeelnemer of -medewerker.

De technische specificatie bestaat uit:

1 Samenvatting
2 Objecten: Product
- 2.1 Object CourseReference
- 2.2 Object Study
- 2.3 Object Subject
- 2.4 Object Price
- 2.5 Object ActivationPeriod
- 2.6 Object LicensePeriod
- 2.7 Object Authors
- 2.8 Object Individual
- 2.9 Object MediaCollection
- 2.10 Object Media
3 Object: ProductInfo
- 3.1 Object MediaCollectionProductInfo
4 Status- en foutcodes
5 Technisch: API specificatie
6 Release notes

Samenvatting

Gegevensdienst	Leermiddelen
Scopes	eduv.catalogue
Objecten	Product ProductInfo
Bron	Leveranciersspecfieke leermiddelencatalogus
Afnemers	Overkoepelende leermiddelencatalogus Selectieomgeving leermiddelen Bestelomgeving leermiddelen Aanspraakmanager Leermiddelenportaal Onderwijsleeromgeving Leermiddelendashboard
Endpoints	Leverancierspecifieke leermiddelencatalogus GET Products GET Product by ID GET Products Info for Display in Portal GET Product Info by ID for Display in Portal
Notifications	De Notifications API kan gebruikt worden om als afnemer een notificatie te ontvangen bij een wijziging in de stand (nieuw/gewijzigd/verwijderd Product). 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

Objecten: Product

Het object Product beschrijft een LeermiddelBeschrijving of een SetBeschrijving. In de ProductBeschrijving is alle informatie opgenomen om het Product te kunnen tonen in een Overkoepelende leermiddelencatalogus, Selectieomgeving leermiddelen of een Bestelomgeving leermiddelen voor oriënteren, selecteren en/of bestellen. Voor deze activiteiten kan een leverancier van leermiddelen onder meer metadata over de toepassing in het onderwijs (levelSubjects), media (foto’s, video’s en documenten) en businessmodellen (models) toevoegen.

Via de velden status, forSale en de diverse datumvelden wordt de actuele status uit de levenscyclus van het Product gespecificeerd. Indien het Product een combiproduct betreft kan gebruik worden gemaakt van bundledProducts om de onderliggende Leermiddelen te specificeren. Tot slot is het mogelijk om voor ieder digitaal Leermiddel een referentie te maken naar een CursusBeschrijving uit de Course API.

Werkgroep combineren en arrangeren

De link naar de Course API is geplaatst om het combineren en arrangeren van leermaterialen mogelijk te maken. De detailuitwerking hiervan wordt gedaan binnen de werkgroep Combineren en arrangeren.

Veld	Type	Format	Omschrijving	Voorbeeld	O/V	Vullingsregel
productId	string	string	De unieke identifier voor het product.	871792713 0834	V	Voor producten die verkoopbaar zijn wordt er een ISBN of EAN gehanteerd. Voor overige producten wordt een uuid gegenereerd. Waarde mag niet gewijzigd worden
publisher	string	string	Naam van de organisatie die het leermiddel aanbiedt en exploiteert: de leermiddelenaanbieder.	Noordhoff	V
reseller	string	string	Naam van de organisatie die de rol van leermiddelenverkoper vervult.	The Learning Network	O	Verplicht zodra de Catalogue API wordt aangeboden door een Leermiddelenverkoper.
type	string	ENUM	Type-aanduiding voor het product.	`physical` `digital` `combi`	V	Waarde combi als het een combi-product betreft bestaande uit fysiek en digitale leermiddelen Waarde physical of digital als het product bestaat uit enkel fysieke of digitale leermiddelen Waarde mag niet gewijzigd worden
status	string	ENUM	Status uit de levenscyclus van een Leermiddel waar dit Product zich in bevindt.	`not-yet-available` `limited-available` `available` `temporary-not-available` `no-longer-available` `will-never-be-available` `not-available-or-usable`	V	Conform levenscyclus van Leermiddel, zie pagina Producten, Aanspraken en Licenties
forSale	boolean	boolean	Indicatie of het product verkoopbaar is.	True False	V	False, zodra het product niet te verkopen is. Bijvoorbeeld voor demo-producten Waarde mag niet gewijzigd worden
saleUnitSize	integer	integer	Verkoopeenheid: het aantal exemplaren van het (mogelijk samengesteld) product dat als eenheid wordt verkocht.	1	V	Waarde >= 1
isConsumptionProduct	boolean	boolean	Indicatie of het product verbruiksmateriaal betreft. Verbruiksmateriaal gaat slechts een door de aanbieder gestelde periode mee.	True False	O	Voor digitaal materiaal waarbij de licentie voor bepaalde tijd beschikbaar is, moet dit veld de waarde "True" bevatten. Voor digitaal materiaal waarbij de licentie voor onbepaalde tijd beschikbaar is, moet dit veld de waarde "False" bevatten
name	string	string	Benaming voor het product.	Getal & Ruimte 12^e ed havo/vwo bovenbouw online	V
productFamilyName	string	string	De naam van de productfamilie waar dit product onderdeel van is.	Getal & Ruimte	O
edition	string	string	Het nummer van de druk die in de communicatie over de titel gebruikt moet worden.		O	Formaat: Nr + “Druk”
productUsages	array	ENUM	Aanduiding in welke vorm het product gebruikt kan worden	`leerrboek` `werkboek` `examenbundel` `oefenmateriaal` `naslagwerk` `docentenmateriaal` `toets` `examen` `anders`	O	De lijst met waarden is overgenomen uit de ECK DT CatalogService en uitgebreid met `docentenmateriaal`, `toets` en `examen`. De waarden worden in de doorontwikkeling van deze gegevensdienst verder herzien waarbij ook gebruiksvormen voor digitale producten worden toegevoegd.
intendedEndUserRole	string	ENUM	Indicatie voor welke eindgebruiker het product bedoeld is.	`student` `educator` `administrator`	O	De waarde `student` sluit niet uit dat een onderwijsmedewerker geen toegang kan krijgen. Andersom geldt wel dat de waarde `educator` gericht is op enkel onderwijsmedewerkers en onderwijzend personeel. Onderwijsdeelnemers kunnen geen toegang krijgen. De waarde `administrator` is gericht op producten voor beheerders.
courseReferences	array	Course Reference	Referentie naar de LeermiddelStructuur-Beschrijving die onderdeel zijn van dit Product	Zie object CourseReference	O	Een Product kan verwijzen naar één of meerdere Courses. Een Course kan in één of meerdere Producten verkocht worden. De verwijzingen mogen niet wijzigen, foutcorrecties uitgezonderd. Dit veld blijft leeg voor een set van digitale leermiddelen.
studies	array	Study	De opleidingseenheden waar dit product op gericht is.	Zie object Study	V	Werkingsregel is om dit veld te vullen conform de waardelijst afspraken voor opleidingen, opleidingsjaren en niveaus.
subjects	array	Subject	De vakken waar dit product op gericht is.	Zie object Subject	V	Werkingsregels is om dit veld te vullen conform de waardelijst afspraken voor vakken.
price	array	Price	De algemene verkoopprijs voor het product.	Zie object Price	O	Het betreft de publieke prijsstelling voor het product Om prijswijzigingen (bijvoorbeeld indexatie) mogelijk te maken kunnen meerdere prijsstellingen gedeeld worden. Werkingsregel is om indien van toepassing de vorige prijs (t-1), de actuele prijs (t) en indien bekend de toekomstige prijs (t+1) te delen.
payment Models	array	string (ENUM)	De betaalmodellen die ondersteund worden voor dit product.	`pre-paid` `post-paid` `periodically-paid`	O*	Verplicht als het product te verkopen is.
licensePeriod	object	LicensePeriod	Duur van de licentieperiode op het product	Zie object LicensencePeriod	O*	Verplicht als het een digitaal product is.
activation Period	object	Activation Period	Beschrijft de wijze waarop de Leermiddelenshop de activationUntilDate kan berekenen.	Zie object ActivationPeriod	O*	Verplicht als het een digitaal product is.
deliveryTypes	array	string	De levervarianten voor dit product.	We hanteren de levervarianten zoals gespecificeerd in dede Delivery API.	O	Verplicht als het een digitaal product is.
trial AccessUrl	string	url	Optionele URL naar een demo of trial omgeving	www.demo.nl	O
default AccessUrl	string	url	De Toegangslink naar het Leermiddel		O*	Verplicht om in te vullen als het type product digital of combi is. Voor combiproducten en sets van digitale leermiddelen wordt er een overkoepelende Toegangslink opgenomen van waaruit alle onderliggende digitale leermiddelen in gebruik zijn te nemen.
short Description	string	string	Korte omschrijving die getoond wordt in zoekpagina’s of product-beschrijvingen	-	V	Veld is gevuld en heeft tussen de 1 en 80 karakters.
long Description	string	string	Lange omschrijving die getoond wordt op productpagina	-	O
copyrightType	string	ENUM	Een aanduiding welke vorm van copyright van toepassing is op het product.	`cc-by-40` `cc-by-sa-40` `cc-by-nc-40` `cc-by-nc-sa-40` `cc-by-nd-40` `cc-by-nc-nd-40` `cc-by-30` `cc-by-sa-30` `cc-by-nc-30` `cc-by-nc-sa-30` `cc-by-nd-30` `cc-by-nc-nd-30` `yes` `no`	V	Vulling volgens CreativeCommons versie 4.0 NL LOM voorschrift: Creative Commons licentievorm yes (er zitten auteursrechten op het materiaal maar die is niet gelijk aan één van de Creative Commons licenties) no (er zitten geen auteursrechten op het materiaal)
authors	object	Authors	De personen en organisaties die hebben gewerkt aan de totstandkoming van het product	Zie object Authors	O
media	object	Media Collection	Collectie van media objecten die getoond kunnen worden bij het Product	Zie object MediaCollection	V
followUpProduct	string	productId	Verwijzing naar het productId van het product dat dit product opvolgt.	8717927130834	O
related Products	array	productId	Array van productIds van producten die gerelateerd zijn aan dit Product en getoond kunnen worden bij dit Product.	Toetsproducten passend bij het Leermiddel Of andere Producten uit een reeks	O
bundled Products	array	productId	Array van productIds van producten die onderdeel zijn van de Set of het Combiproduct	[8717927130834, 8717927130835, 8717927130836]	O*	Verplicht om in te vullen als het product een Setbeschrijving van digitale leermiddelen betreft. Advies is om voor combiproduct en ook de bundledProducts te vullen met onderliggende producten.
firstPublished Date	string	date	Datum dat product op de markt is verschenen of de verwachte verschijnings-datum	2022-08-01	V	Conform vullingsregels data passend bij status uit levenscyclus van Leermiddel, zie pagina Producten, Aanspraken en Licenties
deprecation Date	string	date	Vanaf deze datum is er een opvolger beschikbaar. Aangeraden wordt om deze te gebruiken.	2024-08-01	O*	Conform vullingsregels data passend bij status uit levenscyclus van Leermiddel, zie pagina Producten, Aanspraken en Licenties
supportedUntil Date	string	date	Vanaf deze datum is het product niet meer te bestellen.	2025-08-31	O*	Conform vullingsregels data passend bij status uit levenscyclus van Leermiddel, zie pagina Producten, Aanspraken en Licenties
endOfLifeDate	string	date	Na deze datum is het product niet meer beschikbaar.	2026-07-31	O*	Conform vullingsregels data passend bij status uit levenscyclus van Leermiddel, zie pagina Producten, Aanspraken en Licenties
dateCreated	string	datetime	Datum en tijdstip waarop de entiteit is aangemaakt	2017-07-21T17:32:28Z	V
dateLastModified	string	datetime	Tijdstempel waarop één of meerdere van de hierboven genoemde attributen het laatst zijn gewijzigd	2022-08-11T15:31:12Z	V

Object CourseReference

Een aantal van de attributen uit het Product object zijn nader gespecificeerd. De productDescriptionIds verwijzen naar de LeermiddelStructuurBeschrijving uit de Course API. Deze verwijzing is gespecificeerd in onderstaande tabel.

Veld	Type	Format	Omschrijving	Voorbeeld	O/V	Vullingsregel
courseId	string	string	Referentie naar courseId uit de Course API	-	V	Waarde mag niet gewijzigd worden
title	string	string	Naam van de LeermiddelStructuurBeschrijving	-	O
description	string	string	Korte omschrijving van de LeermiddelStructuurBeschrijving	-	O

Object Study

Een leverancier van leermiddelen specificeert voor welke opleidingen, niveaus en opleidingsjaren een product ontwikkeld is. Hiervoor is het object Study gespecificeerd in onderstaande tabel.

Veld	Type	Format	Omschrijving	Voorbeeld	O/V	Vullingsregel
studyName	string	string	De opleidingseenheid korte naam erkende opleiding voor po en vo of de naam van de kwalificatie voor het mbo.	vwo-gymnasium-onderbouw basisonderwijs	V	Werkingsregel is om per sector de volgende waardelijsten te gebruiken: Primair onderwijs: po-opleidingseenheden korte naam conform erkende opleiding in waardelijst RIO po Voortgezet onderwijs: vo-opleidingseenheden korte naam conform erkende opleiding in waardelijst RIO vo Middelbaar beroepsonderwijs: kwalificatienaam zoals conform Register kwalificatiestructuur van SBB
studyCode	string	string	De opleidingseenheidcode (po en vo) of de crebocode van de opleiding	1002O0222 1000O0001	O	Werkingsregel is om per sector de volgende waardelijsten te gebruiken: Primair onderwijs: opleidingseenheidcode conform waardelijst RIO po Voortgezet onderwijs: opleidingseenheidcode conform waardelijst RIO vo Middelbaar beroepsonderwijs: crebocode zoals conform Register kwalificatiestructuur van SBB
studyLevels	array	studyLevel	Het onderwijsniveau waarop dit product is gericht.	Zie studyLevel object	O

Object Subject

Een leverancier van leermiddelen kan specificeren voor welke vakken het Product ontwikkeld is. Hiervoor is het object Subject gespecificeerd in onderstaande tabel.

Waardelijst nog in ontwikkeling

De waardelijst voor vakken is nog in ontwikkeling. De attributen voor dit object kunnen nog wijzigen. Wellicht wordt er nog een code of een id toegevoegd.

Veld

Type

Format

Omschrijving

Voorbeeld

O/V

Vullingsregel

subjectPrefix

string

De officiële afkorting voor het vakleergebied.

en

V

Werkingsregel is om per sector de volgende waardelijsten te gebruiken:

Primair onderwijs: naam van vakleergebied prefix conform vakleergebieden van SLO curriculum
Voortgezet onderwijs: naam van vakleergebied prefix conform vakleergebieden van SLO curriculum

subjectName

string

De naam van het vakleergebied.

Engels

V

Werkingsregel is om per sector de volgende waardelijsten te gebruiken:

Primair onderwijs: naam van vakleergebied conform vakleergebieden in deze waardenlijst
Voortgezet onderwijs: naam van vakleergebied conform vakleergebieden in deze waardenlijst

Object Price

Een leverancier van leermiddelen specificeert voor producten die verkocht kunnen worden de verkooprijzen in het object Price. Een prijs wordt gespecificeerd conform onderstaande tabel.

Veld	Type	Format	Omschrijving	Voorbeeld	O/V	Vullingsregel
priceExcl	number	number	De prijs exclusief btw en afgerond op twee decimalen	18.34	V	Verplicht veld
priceIncl	number	number	De prijs inclusief btw en afgerond op twee decimalen	19.99	V	Verplicht veld
priceCurrency	string	currency	De munteenheid van de genoemde price	EUR DKK CHF	V	Conform ISO 4217 currency codes
validFrom	string	date	Ingangsdatum van de prijsstelling	2025-09-01	V	Verplicht veld

Object ActivationPeriod

De Bestelomgeving leermiddelen specificeert in de leveringsorder in welke periode een product in gebruik genomen kan worden: de activatieperiode. Dit betreft de met de Besteller overeengekomen startdatum en een volgens de leverancier van de leermiddelen voorgeschreven activationUntilDate. De leverancier van de leermiddelen neemt in de productBeschrijving op volgens welke regels de Bestelomgeving leermiddelen deze activationUntilDate kan berekenen. Deze gegevens zijn beschreven in onderstaande tabel.

Veld	Type	Format	Omschrijving	Voorbeeld	O/V	Vullingsregel
activationVariant	string	ENUM	De variant die gehanteerd kan worden om de activiation UntilDate te berekenen.	`days` `date` `schoolyear`	V	Verplicht veld. Indien gekozen wordt voor schoolyear dan is de activationUntilDate op de eerste 31 juli na de startDate.
activiationDays	Integer	integer	Aantal dagen na de startDate van de activationPeriode	30	O*	Verplicht als activationVariant days is gekozen
activationUntilDate	string	date	Vaste activation UntilDate voor alle aanspraken op dit product.	2023-07-15	O*	Verplicht als activationVariant date is gekozen

Object LicensePeriod

Het object LicensePeriod bevat informatie over de duur van de gebruiksperiode van een licentie op het product.

Veld

Type

Format

Omschrijving

Voorbeeld

O/V

Vullingsregel

licenseVariant

string

ENUM

De variant die van toepassing op de duur van de licentie.

days

month

year

schoolyear

V

Verplicht veld.

Indien gekozen wordt voor month dan is de expirationDate 1 maand na de firstUsed datum.

Indien gekozen wordt voor year dan is de expirationDate 1 jaar na de firstUsed datum.

Indien gekozen wordt voor schoolyear dan is de expirationDate op de eerste 31 juli na de firstUsed datum.

licenseDays

Integer

integer

De licentieduur in dagen.

31

O*

Verplicht als licenseVariant days is gekozen

Object Authors

In het object Authors worden de personen en organisaties gespecificeerd die bijgedragen hebben aan de ontwikkeling van het product.

Veld

Type

Format

Omschrijving

Voorbeeld

O/V

Vullingsregel

individuals

object

Individual

De individuen die bijgedragen hebben aan de ontwikkeling van het product.

Zie object Individual

O

organisations

array

string

De namen van de organisaties die bijgedragen hebben aan de ontwikkeling van het product.

Corporate NV

Bedrijf BV

Museum A

Samenwerkingverband Y

O

Object Individual

Het object Individual bevat de voornaam, achternaam en het tussenvoegsel van een individu die als auteur bijgedragen heeft aan de ontwikkeling van een product.

Veld	Type	Format	Omschrijving	Voorbeeld	O/V	Vullingsregel
givenName	string	string	De voornamen van de auteur	Jan Pieter	V
familyName	string	string	De achternaam van de auteur	Jong	V
familyNamePrefix	string	string	Indien van toepassing het tussenvoegsel	de	O

Object MediaCollection

Een leverancier van leermiddelen kan een Product voorzien van één of meerdere ondersteunende media zoals foto’s, video’s en documenten. Een van deze mediaobjecten betreft de basisminiatuur die ook gehanteerd wordt op zoekpagina’s van een Overkoepelende leermiddelencatalogus, Selectieomgeving leermiddelen of Bestelomgeving leermiddelen. Alle media objecten behorende bij het Product worden gespecificeerd conform de specificatie van een MediaCollection in onderstaande tabel.

Veld	Type	Format	Omschrijving	Voorbeeld	O/V	Vullingsregel
publisherThumbnailUrl	object	media	Referentie naar een logo van de leermiddelenaanbieder	Zie object Media	V
mainThumbnailUrl	object	media	Referentie naar een foto, video of document die getoond kan worden bij het product	Zie object Media	O
productImageUrls	array	media	Een collectie van productfoto’s	Zie object Media	O
productVideoUrls	array	media	Een collectie van productvideo’s	Zie object Media	O
productDocUrls	array	media	Een collectie van productdocumenten	Zie object Media	O

Object Media

Het object Media specificeert de url en optioneel een omschrijving, breedte en hoogte van een mediaobject uit de MediaCollection.

Veld	Type	Format	Omschrijving	Voorbeeld	O/V	Vullingsregel
url	string	url	De url waar het mediaobject is opgeslagen		V
description	string	string	Een korte omschrijving van het mediaobject, te gebruiken voor hover	Demovideo	O
width	integer	integer	De breedte van het mediaobject in pixels	500	O
height	integer	integer	De hoogte van het mediaobject in pixels	1000	O

Object: ProductInfo

Het object ProductInfo bevat een subset van de attributen en is voornamelijk gericht op de referentiecomponenten Leermiddelenportaal en Onderwijsleeromgeving. Dit object bevat met name informatie om toegangslinks en/of toegangstegels op een goede manier te kunnen tonen. Daarnaast bevat het object ook informatie over de levenscyclus en de metadata over opleidingen en vakken.

Veld	Type	Format	Omschrijving	Voorbeeld	O/V	Vullingsregel
productId	string	string	De unieke identifier voor het product.	871792713 0834	V	Voor producten die verkoopbaar zijn wordt er een ISBN of EAN gehanteerd. Voor overige producten wordt een uuid gegenereerd. Waarde mag niet gewijzigd worden
publisher	string	string	Naam van de organisatie die het leermiddel aanbiedt en exploiteert: de leermiddelenaanbieder.	Noordhoff	V
type	string	ENUM	Type-aanduiding voor het product.	`physical` `digital` `combi`	V	Waarde combi als het een combi-product betreft bestaande uit fysiek en digitale leermiddelen Waarde physical of digital als het product bestaat uit enkel fysieke of digitale leermiddelen Waarde mag niet gewijzigd worden
status	string	ENUM	Status uit de levenscyclus van een Leermiddel waar dit Product zich in bevindt.	`not-yet-available` `limited-available` `available` `temporary-not-available` `no-longer-available` `will-never-be-available` `not-available-or-usable`	V	Conform levenscyclus van Leermiddel, zie pagina Producten, Aanspraken en Licenties
name	string	string	Benaming voor het product.	Getal & Ruimte 12^e ed havo/vwo bovenbouw online	V
productFamilyName	string	string	De naam van de productfamilie waar dit product onderdeel van is.	Getal & Ruimte	O
courseReferences	array	course Reference	Referentie naar de LeermiddelStructuur-Beschrijving die onderdeel zijn van dit Product	Zie object courseReference	O	Een Product kan verwijzen naar één of meerdere Courses. Een Course kan in één of meerdere Producten verkocht worden. De verwijzingen mogen niet wijzigen, foutcorrecties uitgezonderd. Dit veld blijft leeg voor een set van digitale leermiddelen.
studies	array	study	De opleidingseenheden waar dit product op gericht is.	Zie object study	V	Werkingsregel is om dit veld te vullen conform de waardelijst afspraken voor opleidingen, opleidingsjaren en niveaus.
subjects	array	subject	De vakken waar dit product op gericht is.	Zie object subject	V	Werkingsregels is om dit veld te vullen conform de waardelijst afspraken voor vakken.
trial AccessUrl	string	url	Optionele URL naar een demo of trial omgeving	www.demo.nl	O
default AccessUrl	string	url	De Toegangslink naar het Leermiddel		V	Dit veld is in dit object verplicht en stelt het Leermiddelenportaal in staat om een toegangslink te tonen naar de eindgebruiker.
short Description	string	string	Korte omschrijving die getoond wordt in zoekpagina’s of product-beschrijvingen	-	V
long Description	string	string	Lange omschrijving die getoond wordt op productpagina	-	O
media	object	media Collection	Collectie van media objecten die getoond kunnen worden bij het Product	Zie object mediaCollectionProductInfo	V
bundled Products	array	productId	Array van Producten die onderdeel zijn van de Set of het Combiproduct	[8717927130834, 8717927130835, 8717927130836]	O*	Verplicht om in te vullen als het product een Setbeschrijving van digitale leermiddelen betreft. Advies is om voor combiproduct en ook de bundledProducts te vullen met onderliggende producten.
firstPublished Date	string	date	Datum dat product op de markt is verschenen of de verwachte verschijnings-datum	2022-08-01	V	Conform vullingsregels data passend bij status uit levenscyclus van Leermiddel, zie pagina Producten, Aanspraken en Licenties
deprecation Date	string	date	Vanaf deze datum is er een opvolger beschikbaar. Aangeraden wordt om deze te gebruiken.	2024-08-01	O*	Conform vullingsregels data passend bij status uit levenscyclus van Leermiddel, zie pagina Producten, Aanspraken en Licenties
supportedUntil Date	string	date	Vanaf deze datum is het product niet meer te bestellen.	2025-08-31	O*	Conform vullingsregels data passend bij status uit levenscyclus van Leermiddel, zie pagina Producten, Aanspraken en Licenties
endOfLifeDate	string	date	Na deze datum is het product niet meer beschikbaar.	2026-07-31	O*	Conform vullingsregels data passend bij status uit levenscyclus van Leermiddel, zie pagina Producten, Aanspraken en Licenties
dateCreated	string	datetime	Datum en tijdstip waarop de entiteit is aangemaakt	2017-07-21T17:32:28Z	V
dateLastModified	string	datetime	Tijdstempel waarop één of meerdere van de hierboven genoemde attributen het laatst zijn gewijzigd	2022-08-11T15:31:12Z	V

Object MediaCollectionProductInfo

Een Leermiddelenportaal en Onderwijsleeromgeving moet minimaal kunnen beschikken over de thumbnail van het product en het logo van de leermiddelenaanbieder. De mediacollectie voor het ProductInfo object heeft hierdoor andere vullingsregels.

Veld	Type	Format	Omschrijving	Voorbeeld	O/V	Vullingsregel
publisherThumbnailUrl	object	media	Referentie naar een logo van de leermiddelenaanbieder	Zie object media	V
mainThumbnailUrl	object	media	Referentie naar een foto, video of document die getoond kan worden bij het product	Zie object media	V

Status- en foutcodes

Voor alle APIs uit het Afsprakenstelsel Edu-V zijn de status- en foutcodes beschreven op de pagina Status- en foutcodes. Hierbij is onderscheid gemaakt in algemene en voor de API specifieke status- en foutcodes.

Technisch: API specificatie

Release notes

0.0.1: Eerste draft van de API.
0.0.2: Objecten en YAML files zijn toegevoegd t.b.v. de 80 procent specificatie.
0.0.3: De technische specificatie is verder uitgewerkt. Ook is de feedback uit de werkgroepen verwerkt in een volgende versie:
- GET all endpoints zijn toegevoegd voor alle objecten.
- In de YAML is aangegeven welke referentiecomponent de endpoints aanbiedt als Producer.
- De YAML is geactualiseerd op basis van de bovenstaande wijzigingen.
0.0.4: Objecten geactualiseerd op basis van herziening rollen en referentiecomponenten in het architectuurkader.
0.0.5: Typo’s verwijderd uit de YAML file.
0.0.6: Op basis van feedback uit de werkgroep Verwerven en in gebruik nemen en voorbereiding op de werkgroep Combineren en arrangeren leermaterialen zijn de volgende zaken gewijzigd:
- Metadata over opleidingen, opleidingsjaren, niveaus en vakken toegevoegd met verwijzingen naar RIO en SLO.
- Attributen dateCreated en dateLastModified en een query parameter Since toegevoegd. Dit vergemakkelijkt periodiek synchroniseren van wijzigingen.
- Object ProdutInfo opgesteld gericht op het Leermiddelenportaal en de Onderwijsleeromgeving. Dit object bevat minder attributen en de toegangslink is een verplicht veld.
0.0.7: Er zijn wijzigingen verwerkt:
- Wijzigen in de architectuur:
  - Attribuut schemaVersion is verwijderd uit de objecten.
  - Query parameter schemaVersion is verwijderd uit de koppelvlakken.
- Feedback vanuit de werkgroep Verwerven en in gebruik nemen:
  - Attribuut mediaType is verwijderd uit object media, width en height zijn optioneel gemaakt en productPdfUrls is hernoemd naar productDocUrls.
  - Attribuut productFamilyName is toegevoegd aan Product en ProductInfo
  - Attribuut deliveryTypes is toegevoegd aan Product.
  - Attribuut licensePeriod is aangepast naar een flexibeler formaat.
  - Attribuut supplier is toegevoegd aan Product en ProductInfo
  - Attribuut reseller is toegevoegd aan Product.
  - Attribuut edition is toegevoegd aan Product
  - Object studyLevel is aangepast en is een verwijzing naar de SLO Niveaus geworden. Hiervoor is ook een nieuwe pagina Waardelijst onderwijsniveaus en leerjaren toegevoegd aan Confluence.
  - Patterns zijn toegevoegd aan de YAML.
  - Pattern voor een ProductId is in formaat ean, isbn of uuid.
0.0.8: Op basis van de feedback uit de klankbordgroep en de uitkomsten van de marktverkenning zijn een aantal attributen gewijzigd en toegevoegd:
- Attribuut supplier is hernoemd naar publisher.
- Attribuut supplierThumbnailUrl is hernoemd naar publisherThumbnailUrl
- Attributen saleUnitSize, isConsumptionProduct, productUsages, intentdedEndUserRole, copyrightType, authors en followUpProduct zijn toegevoegd.
0.9.0: Het Bestuurlijk Overleg heeft tijdens de bijeenkomst van 27 juni 2024 het Afsprakenstelsel Edu-V als versie 0.9.0 goedgekeurd voor implementatie.
0.9.1: Wijzigingen naar aanleiding van RFC’s:
- Op basis van RFC002 is de scope aangepast met een prefix eduv.. Dit stelt leveranciers in staat om onderscheid te maken tussen gegevensuitwisselingen met leveranciers binnen en buiten het Edu-V afsprakenstelsel.
- De parameters voor paginering zijn uit de koppelvlakspecificatie verwijderd. Binnen het afsprakenstelsel zijn de afspraken hierover beschreven op de pagina paginering, sorteren en rate limiting.
0.9.2: Wijziging naar aanleiding van RFC:
- Op basis van RFC019 is in het StudyOffering object voor het attribuut studyCode de verwerkingsregel gewijzigd. Hierbij wordt de opleidingseenheidcode gehanteerd. en niet langer de erkendeopleidingscode. Op deze manier is de code uniek en persistent over sectoren heen.
1.0.0: Na succesvolle implementatie in najaarsrelease 2024 in beheer genomen.

Catalogue API

Samenvatting

Objecten: Product

Object CourseReference

Object Study

Object Subject

Object Price

Object ActivationPeriod

Object LicensePeriod

Object Authors

Object Individual

Object MediaCollection

Object Media

Object: ProductInfo

Object MediaCollectionProductInfo

Status- en foutcodes

Technisch: API specificatie

Release notes

Related content