Titel | Catalogue API | ||||||||||||||||||||||
Status |
| ||||||||||||||||||||||
Versie | documentatie: 1.1.0 | ||||||||||||||||||||||
schemaVersion: 1.1.0 | |||||||||||||||||||||||
Datum | 10 maart 2025 | ||||||||||||||||||||||
Auteur | Werkgroep Verwerven en in gebruik nemen | ||||||||||||||||||||||
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.
...
Veld | Type | Format | Omschrijving | Voorbeeld | O/V | Vullingsregel |
productId | string | string | De unieke identifier voor het product. | 871792713 | 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. |
| 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. |
| 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 | 1 | V | Waarde >= 1 |
isConsumptionProduct | boolean | boolean | Indicatie of het product verbruiksmateriaal Verbruiksmateriaal | True False | O | Voor digitaal materiaal |
name | string | string | Benaming voor het product. | Getal & Ruimte 12e 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 | O | Formaat: Nr + “Druk” | |
productUsages | array | ENUM | Aanduiding in welke vorm |
| O | De lijst met waarden is overgenomen uit de ECK DT CatalogService en uitgebreid met 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 |
| O | De waarde Andersom geldt wel dat de waarde De waarde |
courseReferences | array | Course | 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 | array | string (ENUM) | De betaalmodellen die ondersteund worden voor dit product. |
| 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 | object | Activation | 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 | string | url | Optionele URL naar een demo of trial omgeving | O |
| |
default | 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. |
specific AccessUrls | array | AccessUrl | Optionele aanvullende Toegangslinks voor specifieke toepassingen. | Zie object AccessUrl | O | Alleen vullen met aanvullende specifieke Toegangslinks die de uitgever ook ondersteund. |
short | 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 | 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. |
| V | Vulling volgens
|
authors | object | Authors | De personen en organisaties die hebben gewerkt aan de totstandkoming van het product | Zie object Authors | O | |
media | object | Media | 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 | 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 | 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 | 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 | 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 | 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 |
Anchor | ||
---|---|---|
|
...
|
...
Object CourseReference
Een
...
Op basis van deze link hebben gebruikers van een overkoepelende leermiddelencatalogus de mogelijkheid om aanvullende productinformatie te bekijken
...
https://edu-v.org/meerInformatie?over=dat_ene
...
O
...
Een http of https URI Scheme conform: https://www.rfc-editor.org/rfc/rfc9110.html#section-4.2; ook wel bekend als URL.
...
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 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 /wiki/spaces/AFSPRAKENS/pages/77791233 | - | V | Waarde mag niet gewijzigd worden |
title | string | string | Naam van de LeermiddelStructuurBeschrijving | - | O |
|
description | string | string | Korte omschrijving van de LeermiddelStructuurBeschrijving | - | O |
|
Anchor | ||||
---|---|---|---|---|
|
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
courseId
string
string
Referentie naar courseId uit de /wiki/spaces/AFSPRAKENS/pages/77791233
-
V
Waarde mag niet gewijzigd worden
title
string
string
Naam van de LeermiddelStructuurBeschrijving
-
O
description
string
string
Korte omschrijving van de LeermiddelStructuurBeschrijving
-
O
...
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:
|
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:
|
studyLevels | array | studyLevel | Het onderwijsniveau waarop dit product is gericht. | Zie studyLevel object | O |
Anchor | ||||
---|---|---|---|---|
|
Een leverancier van leermiddelen kan specificeren voor welke vakken het Product ontwikkeld is. Hiervoor is het object Study Subject 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
...
Info |
---|
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 | string | De officiële afkorting voor het vakleergebied. | en | V | Werkingsregel is om per sector de volgende waardelijsten te gebruiken:
|
|
Middelbaar beroepsonderwijs: crebocode zoals conform Register kwalificatiestructuur van SBB
studyLevels
array
studyLevel
Het onderwijsniveau waarop dit product is gericht.
Zie studyLevel object
O
...
| ||||||
subjectName | string | string | De naam van het vakleergebied. | Engels | V | Werkingsregel is om per sector de volgende waardelijsten te gebruiken:
|
Anchor | ||||
---|---|---|---|---|
|
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
...
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 |
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
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
...
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 |
Anchor | ||||
---|---|---|---|---|
|
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 |
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.99ENUM | De variant die gehanteerd kan worden om de activiation |
| 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
...
. 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 | 2023-07-15 | O* | Verplicht als activationVariant date is gekozen |
Anchor | ||||
---|---|---|---|---|
|
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 |
UntilDate te berekenen
V
Verplicht veldvan toepassing op de duur van de licentie. |
|
date
schoolyear
| V | Verplicht veld. Indien gekozen wordt voor Indien gekozen wordt voor Indien gekozen wordt voor |
expirationDate op de eerste 31 juli na de |
firstUsed datum. |
licenseDays | Integer | integer |
Aantal dagen na de startDate van de activationPeriode
30De licentieduur in dagen. | 31 | O* | Verplicht als |
licenseVariant days is gekozen |
activationUntilDate
string
date
Vaste activationUntilDate voor alle aanspraken op dit product.
2023-07-15
O*
Verplicht als activationVariant date is gekozen
Anchor |
---|
...
|
...
|
...
AccessUrl
Het object LicensePeriod bevat informatie over de duur van de gebruiksperiode van een licentie op het productAccessUrl specificeert een Toegangslink naar een Leermiddel.
Veld | Type | Format | Omschrijving | Voorbeeld | O/V | Vullingsregel |
accessUrl | string |
url | De |
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 gekozenToegangslink naar het Leermiddel. | V | Verplicht veld. | ||||
accessUrlType | string | ENUM | Type aanduiding behorende bij de Toegangslink. |
| V | Verplicht veld. |
Anchor | ||||
---|---|---|---|---|
|
...
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.
Het object AccessUrl specificeert een Toegangslink naar een Leermiddel.
Veld
Type
Format
Omschrijving
Voorbeeld
O/V
Vullingsregel
accessUrl
string
url
De Toegangslink naar het Leermiddel.
V
Verplicht veld.
accessUrlType
string
ENUM
Type aanduiding behorende bij de Toegangslink.
basispoort
entree federatie
nederlandse antillen
V
Verplicht veld.
Alleen vullen met aanvullende specifieke Toegangslinks die de uitgever ook ondersteundVeld | Type | Format | Omschrijving | Voorbeeld | O/V | Vullingsregel | ||||||||||
specific AccessUrls | array | AccessUrl | Optionele aanvullende Toegangslinks voor specifieke toepassingen. | Zie object AccessUrl | O | Alleen vullen met aanvullende specifieke Toegangslinks die de uitgever ook ondersteund. | ||||||||||
productId | string | string | De unieke identifier voor het product. | 871792713 | 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. |
| 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. |
| V | Conform levenscyclus van Leermiddel, zie pagina Producten, Aanspraken en Licenties | ||||||||||
name | string | string | Benaming voor het product. | Getal & Ruimte 12e 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 | 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 , 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 . | 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 vakkenom dit veld te vullen conform de waardelijst afspraken voor vakken. |
infoLink | string | url | Een URL naar een informatiepagina met betrekking tot het product. Op basis van deze link hebben gebruikers van een overkoepelende leermiddelencatalogus de mogelijkheid om aanvullende productinformatie te bekijken | O | Een http of https URI Scheme conform: https://www.rfc-editor.org/rfc/rfc9110.html#section-4.2; ook wel bekend als URL. | |||||||||||
trial | string | url | Optionele URL naar een demo of trial omgeving | O |
| |||||||||||
default | 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. | specific AccessUrls | array | AccessUrl | Optionele aanvullende Toegangslinks voor specifieke toepassingen. | Zie object AccessUrl | O | . | |||
short | string | string | Korte omschrijving die getoond wordt in zoekpagina’s of product-beschrijvingen | - | V |
| ||||||||||
long | string | string | Lange omschrijving die getoond wordt op productpagina | - | O |
| ||||||||||
media | object | media | Collectie van media objecten die getoond kunnen worden bij het Product | Zie object mediaCollectionProductInfo | V |
| ||||||||||
bundled | 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 | 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 | 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 | string | date | Vanaf deze datum is het product niet meer te bestellen. | 2025-08-31 | O*kunnen worden bij het Product | Zie object mediaCollectionProductInfo | V |
| ||||||||
bundled | 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 | 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 | string | date | Na Vanaf deze datum is het product niet meer beschikbaar.2026-07-31er 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 | dateCreated | string | ||||||||
datetime | Datum en tijdstip waarop de entiteit is aangemaakt | 2017-07-21T17:32:28Z | V | dateLastModifiedsupportedUntil | string | datetime | Tijdstempel waarop één of meerdere van de hierboven genoemde attributen het laatst zijn gewijzigd | 2022date | Vanaf deze datum is het product niet meer te bestellen. | 2025-08-11T15:31:12Z | V |
...
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 |
Anchor | ||||
---|---|---|---|---|
|
...
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 attribuutstudyCode
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.
01.91.30: Wijzigingen naar aanleiding van RFC’s:
Op basis van RFC0003 is het
ProductInfo
Product
object uitgebreid met het veldspecificAccessUrls
, waarin meerdere aanvullende specifieke Toegangslinks kunnen worden geduid.Op basis van RFC0032 is het
Product
ProductInfo
object uitgebreid met het veldinfoLink
, waarin gebruikers van een overkoepelende leermiddelen catalogus aanvullende productinformatie kunnen bekijken.