Eduterm: Interface

De API is te bevragen via de url.

Endpoints

We adviseren om de 0.8 te gebruiken.

http://api-beta.obk.kennisnet.nl/0.7/Query/ = End of Life
http://api-beta.obk.kennisnet.nl/0.8/Query/ = End of Life
http://api.onderwijsbegrippen.kennisnet.nl/1.0/Query/

Argumenten

Afhankelijk van het type zoekopdracht zijn er verschillende argument. Meer informatie vindt u op de OBK-API overzichtspagina voor uw api-key. Hieronder een overzicht van de generieke argumenten.

naam	#	type	omschrijving
api_key	1	uuid	De gebruikssleutel voor uw applicatie. Deze sleutel bepaalt tot welke zoekopdrachten toegang is verleend.
format	0-1	string	Het uitvoerformaat, json, xml, html of csv. Standaard json.
endpoint	0-1	string	Verwijst naar een optioneel RDF store endpoint, Kennisnetset2015.01 of OBK. Default is het endpoint OBK.

Voorbeeld Verzoek

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

Voorbeeld Respons

{
    "head": {
        "vars": [
            "onderwijsniveau",
            "onderwijsniveauLabel",
            "lomPurpose",
            "parent",
            "parentLabel"
        ]
    },
    "results": {
        "bindings": [
            {
                "onderwijsniveauLabel": {
                    "xml:lang": "nl",
                    "type": "literal",
                    "value": "Beroepsonderwijs en Volwasseneneducatie"
                },
                "onderwijsniveau": {
                    "type": "uri",
                    "value": "http://purl.edustandaard.nl/begrippenkader/caa97efc-a713-41ea-a845-1534ca65eac9"
                },
                "lomPurpose": {
                    "type": "literal",
                    "value": "educational level"
                }
            },
            {
                "onderwijsniveauLabel": {
                    "xml:lang": "nl",
                    "type": "literal",
                    "value": "HBO"
                },
                "onderwijsniveau": {
                    "type": "uri",
                    "value": "http://purl.edustandaard.nl/begrippenkader/be140797-803f-4b9e-81cc-5572c711e09c"
                },
                "lomPurpose": {
                    "type": "literal",
                    "value": "educational level"
                }
            }
      ]}
}

Formaat

nog niet af

Afhankelijk van de HTTP Accept Header of het meegegeven format, wordt het uitvoerformaat bepaald. Het format argument heeft bij het bepalen de voorkeur.

HTTP Accept Header	format waarde	omschrijving
application/json	json	sparl json
text/html	html	formatted table

Foutmeldingen

De 1.0 versie geeft HTTP errors terug, en het bericht in HTML.

HTTP error	omschrijving
401 Unauthorized	request is goed, maar api-key niet geautoriseerd voor gevraagde query
400 Bad Request	fout in request, query of argumenten

Eduterm:Interface