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/
http://api-beta.obk.kennisnet.nl/0.8/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, bijvoorbeeld Kennisnet-set. Default is het endpoint OBK.

Voorbeeld Verzoek

http://api-beta.obk.kennisnet.nl/0.7/Query/Onderwijsniveaus?api_key=1b1dbdd8-aed6-4740-97f5-3116e34a351b

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"
                }
            }
      ]}
}

Foutmeldingen

De OBK-API geeft of een error json terug (zie voorbeeld), of een HTTP status code (bijvoorbeeld 401 voor een niet-geauthentiseerde api key en alleen headers opvragen geeft altijd een 405).

Voorbeeld

{
    "Message": "An error has occurred.",
    "ExceptionMessage": "Guid should contain 32 digits with 4 dashes (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).",
    "ExceptionType": "System.FormatException",
    "StackTrace": " at System.Web.Http.ApiController.<InvokeActionWithExceptionFilters>d__1.MoveNext()\r\n--- End of stack trace from previous location where exception was thrown ---\r\n at System.Runtime.CompilerServices.TaskAwaiter.ThrowForNonSuccess(Task task)\r\n at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)\r\n at System.Web.Http.Dispatcher.HttpControllerDispatcher.<SendAsync>d__0.MoveNext()"
}

Eduterm:Interface