Eduterm:Zoekopdrachten: verschil tussen versies

Uit Kennisnet Developers Documentatie
Ga naar: navigatie, zoeken
k (Admin heeft pagina OBKAPI:Zoekopdrachten hernoemd naar Eduterm:Zoekopdrachten)
(remove query releases)
Regel 2: Regel 2:
 
{{Info|Let wel, voor toegang is wel een API key nodig.}}
 
{{Info|Let wel, voor toegang is wel een API key nodig.}}
  
== Query Releases ==
 
Voor elke query kunnen er 1-3 varianten bestaan. Een "latest" rolling-release query en 2 static queries. In principe werken alle klanten op de rolling release tenzij ze dit expliciet aanvragen voor een query.
 
{| class="wikitable"
 
|-
 
! type
 
! voorbeeld
 
! release
 
! verwijdering
 
|-
 
| latest, rolling
 
| Kerndoelen
 
| 2 weken na release nieuwe query
 
| niet
 
|-
 
| nieuw
 
| Kerndoelen20150901
 
| wanneer de query inhoudelijk is aangepast en door ons getest
 
| niet, pas wanneer deze variant de status "oud" krijgt
 
|-
 
| oud
 
| Kerndoelen20150101
 
| wanneer een nieuwe query wordt gereleased
 
| 3 maanden na release van een nieuwe query
 
|-
 
|}
 
  
 
== Kernprogramma ==
 
== Kernprogramma ==

Versie van 9 jul 2018 om 07:51

Op deze pagina staat een overzicht van alle zoekopdrachten voor publiek gebruik.

Info.gif Let wel, voor toegang is wel een API key nodig.


Kernprogramma

Obkapi-relaties-tussen-queries.png

Onderwijsniveaus

Geeft alle onderwijsniveau's met de bijbehorende parent relatie.

voorbeeld:

https://api.onderwijsbegrippen.kennisnet.nl/1.0/Query/Onderwijsniveaus?api_key=geheim

VakLeergebieden

Geeft de vakken bij een bepaald onderwijsniveau.

parameters:

naam beschrijving voorbeeldwaarde
onderwijsniveau Geeft het onderwijsniveau waarvan de vakken opgevraagd worden. bk:78f5cabe-6649-4dc3-84bf-36d82c6c2d31 (Havo 1)

voorbeeld:

https://api.onderwijsbegrippen.kennisnet.nl/1.0/Query/VakLeergebieden?api_key=geheim&onderwijsniveau=bk:78f5cabe-6649-4dc3-84bf-36d82c6c2d31

Vakkernen

Geeft de vakkernen van een bepaald vak bij een bepaald onderwijsniveau.

parameters:

naam beschrijving voorbeeldwaarde
onderwijsniveau Geeft het onderwijsniveau waarvan de vakken opgevraagd worden. bk:78f5cabe-6649-4dc3-84bf-36d82c6c2d31 (Havo 1)
vak Geeft het vak waarvan de vakkernen worden opgevraagd. bk:7afbb7a6-c29b-425c-9c59-6f79c845f5f0 (Wiskunde)

voorbeeld:

https://api.onderwijsbegrippen.kennisnet.nl/1.0/Query/Vakkernen?api_key=geheim&onderwijsniveau=bk:78f5cabe-6649-4dc3-84bf-36d82c6c2d31&vak=bk:7afbb7a6-c29b-425c-9c59-6f79c845f5f0

Subkernen

Geeft de subkernen van een bepaalde vakkern binnen een bepaald vak bij een bepaald onderwijsniveau.

parameters:

naam beschrijving voorbeeldwaarde
onderwijsniveau Geeft het onderwijsniveau waarvan de vakken opgevraagd worden. bk:e05b5eb1-6a65-4f45-9556-79b25cd91da8 (SBO)
vak Geeft het vak waarvan de vakkernen worden opgevraagd. bk:c001f86a-4f8f-4420-bd78-381c615ecedc (Aardrijkskunde)
vakkern Geeft de vakkern waarvoor de subkernen worden opgevraagd. bk:aa2f68ba-69e5-415d-8d9b-8d6ab98942b1 (Burgerschap)

voorbeeld:

https://api.onderwijsbegrippen.kennisnet.nl/1.0/Query/Subkernen?api_key=geheim&onderwijsniveau=bk:e05b5eb1-6a65-4f45-9556-79b25cd91da8&vak=bk:c001f86a-4f8f-4420-bd78-381c615ecedc&vakkern=bk:aa2f68ba-69e5-415d-8d9b-8d6ab98942b1

Vakinhouden

Deze query geeft de vakinhouden van een bepaalde subkern (parameter 4), binnen een bepaalde vakkern (parameter 3) binnen een bepaald kernprogramma. Het kernprogramma wordt bepaald door het vak/leergebied (parameter 2) en het niveau (parameter 1).

parameters:

naam beschrijving voorbeeldwaarde
onderwijsniveau Het niveau van het kernprogramma van de gevraagde vakinhouden. bk:78f5cabe-6649-4dc3-84bf-36d82c6c2d31 (Havo 1)
vak Het vak van het kernprogramma van de gevraagde vakinhouden. bk:7afbb7a6-c29b-425c-9c59-6f79c845f5f0 (Wiskunde)
vakkern De vakkern binnen het kernprogramma van de gevraagde vakinhouden. bk:dced6368-c076-4d51-8d83-53e9a87bef40 (Getallen en variabelen)
subkern De subkern binnen het kernprogramma van de gevraagde vakinhouden. bk:ea7b2da3-82bd-400c-aea0-59f39532dda2 (Getallen, getalsystemen en -relaties)

voorbeeld:

https://api.onderwijsbegrippen.kennisnet.nl/1.0/Query/Vakinhouden?api_key=geheim&onderwijsniveau=bk:78f5cabe-6649-4dc3-84bf-36d82c6c2d31&vak=bk:7afbb7a6-c29b-425c-9c59-6f79c845f5f0&vakkern=bk:dced6368-c076-4d51-8d83-53e9a87bef40&subkern=bk:ea7b2da3-82bd-400c-aea0-59f39532dda2

Kerndoelen

Geeft bij een onderwijsniveau (parameter 1) de bijbehorende kerndoelen. Dit onderwijsniveau mag algemeen (bv. 'VO') zijn, maar ook specifiek (bv. 'VMBO Theoretische leerweg 1).

parameters:

naam beschrijving voorbeeldwaarde
onderwijsniveau Geeft het onderwijsniveau waarvan de vakken opgevraagd worden. bk:78f5cabe-6649-4dc3-84bf-36d82c6c2d31 (Havo 1)

voorbeeld:

https://api.onderwijsbegrippen.kennisnet.nl/1.0/Query/Kerndoelen?api_key=geheim&onderwijsniveau=bk:78f5cabe-6649-4dc3-84bf-36d82c6c2d31

Einddoelen

Deze query geeft de einddoelen weer. Einddoelen kunnen zowel Eindtermen (bovenbouw) zijn, als Tussendoelen (onderbouw). De parameters zijn Onderwijsniveau, Vak, Vakkern en Subkern (zie de betreffende queries). Een einddoel hangt onderaan een subkern (3e niveau), of aan een vakinhoud (4e niveau). In geval van het laatste is deze ook weergegeven.

parameters:

naam beschrijving voorbeeldwaarde
onderwijsniveau Het niveau van het kernprogramma van de gevraagde einddoelen. bk:ac188375-0a1a-4984-ac80-14d04a086a19 (Vwo 1)
vak Het vak van het kernprogramma van de gevraagde einddoelen. bk:7afbb7a6-c29b-425c-9c59-6f79c845f5f0 (Wiskunde)
vakkern De vakkern binnen het kernprogramma van de gevraagde einddoelen. bk:dced6368-c076-4d51-8d83-53e9a87bef40 (Getallen en variabelen)
subkern De subkern binnen het kernprogramma van de gevraagde einddoelen. bk:ea7b2da3-82bd-400c-aea0-59f39532dda2 (Getallen, getalsystemen en -relaties)

voorbeeld:

https://api.onderwijsbegrippen.kennisnet.nl/1.0/Query/Einddoelen?api_key=geheim&onderwijsniveau=bk:ac188375-0a1a-4984-ac80-14d04a086a19&vak=bk:7afbb7a6-c29b-425c-9c59-6f79c845f5f0&vakkern=bk:dced6368-c076-4d51-8d83-53e9a87bef40&subkern=bk:ea7b2da3-82bd-400c-aea0-59f39532dda2

KernprogrammaNiveauVak

Deze query geeft het kernprogramma weer voor een bepaald niveau en een bepaald vak. In de resultaten wordt de volledige opbouw van dit vak (van Vakleergebieden tot Einddoelen) weergegeven.

parameters:

naam beschrijving voorbeeldwaarde
onderwijsniveau Het niveau van het kernprogramma van de gevraagde einddoelen. bk:ac188375-0a1a-4984-ac80-14d04a086a19 (Vwo 1)
vak Het vak van het kernprogramma van de gevraagde einddoelen. bk:7afbb7a6-c29b-425c-9c59-6f79c845f5f0 (Wiskunde)

voorbeeld:

https://api.onderwijsbegrippen.kennisnet.nl/1.0/Query/KernprogrammaNiveauVak?api_key=geheim&onderwijsniveau=bk:ac188375-0a1a-4984-ac80-14d04a086a19&vak=bk:7afbb7a6-c29b-425c-9c59-6f79c845f5f0

KerndoelenBijEinddoel

Geeft de kerndoelen weer gegeven een onderwijsniveau (parameter 1) en een pad van Vak-Vakkern-Subkern-Einddoel (parameter 2 t/m 4). Kerndoelen horen alleen bij de onderbouw, waar de einddoelen feitelijk tussendoelen heten.

parameters:

naam beschrijving voorbeeldwaarde
onderwijsniveau Het niveau van het kernprogramma van de gevraagde kerndoelen. bk:eaa0c07f-193e-4be5-8dc6-a00bbfc7a446 (Havo 1)
vak Het vak van het kernprogramma van de gevraagde kerndoelen. bk:7afbb7a6-c29b-425c-9c59-6f79c845f5f0 (Engels)
vakkern De vakkern binnen het kernprogramma van de gevraagde kerndoelen. bk:ee274481-3a9f-4799-9f41-4b1d80b42b65 (Gesprekken voeren)
subkern De subkern binnen het kernprogramma van de gevraagde kerndoelen. bk:b74ac03b-d0f5-48fd-8753-58539f737770 (Informatie uitwisselen)
einddoel Het einddoel binnen het kernprogramma van de gevraagde kerndoelen. bk:a38ffdc5-0ead-4b17-920a-a1fe2ad48c24 (Eenvoudige feitelijke informatie achterhalen ...)

voorbeeld:

https://api.onderwijsbegrippen.kennisnet.nl/1.0/Query/Einddoelen?api_key=geheim&onderwijsniveau=bk:eaa0c07f-193e-4be5-8dc6-a00bbfc7a446&vak=bk:7afbb7a6-c29b-425c-9c59-6f79c845f5f0&vakkern=bk:ee274481-3a9f-4799-9f41-4b1d80b42b65&subkern=bk:b74ac03b-d0f5-48fd-8753-58539f737770&einddoel=bk:a38ffdc5-0ead-4b17-920a-a1fe2ad48c24

ECKDT

eck_FoutCodes

Geeft alle ECK-DT foutcodes en meldingen.

voorbeeld:

https://api.onderwijsbegrippen.kennisnet.nl/1.0/Query/eckdt_FoutCodes?api_key=geheim

eckdt_Waardelijsten

Deze query zoekt naar alle waardelijsten en geeft label, definitie en identifier van die waardelijsten terug, inclusief de servicelabel waar die waardelijst bij hoort.

voorbeeld:

https://api.onderwijsbegrippen.kennisnet.nl/1.0/Query/eckdt_eckdt_Waardelijsten?api_key=geheim

eckdt_Waardelijst

Deze query toont de labels en bijbehorende persistente identifiers van alle waarden in een waardelijst op basis van de persistente identifier van die waardenlijst.

parameters:

naam beschrijving voorbeeldwaarde
waardelijstPersistenteIdentifier identifier van waardelijst <http://purl.edustandaard.nl/concept/18fc8d2a-ede1-472e-90b2-1faa79e664e2>

voorbeeld:

https://api.onderwijsbegrippen.kennisnet.nl/1.0/Query/eckdt_Waardelijst?api_key=geheim&waardelijstPersistenteIdentifier=<http://purl.edustandaard.nl/concept/18fc8d2a-ede1-472e-90b2-1faa79e664e2>