API

De informatie die op deze website getoond wordt, is ook beschikbaar via een API. Deze pagina is bedoeld voor ontwikkelaars die daarvan gebruik willen maken.

Voor gebruik van de API dient een formeel verzoek ingediend te worden met uw contactgegevens bij servicedesk@ivdnt.org.

De informatie kan worden opgevraagd via HTTP-verzoeken en zal worden teruggestuurd in JSON.

Basis-URL: https://pinkhof.ivdnt.org/api/pinkhof/v1.0/

Zoeken

GET

search?q.<veldnaam>=<zoekterm>

Parameter	Standaardwaarde	Beschrijving
q.<veldnaam>		De zoekterm. Voeg de veldnaam toe om in dat veld te zoeken. Meerdere parameters mogelijk. Waarde mag wildcards (*) bevatten.
rows	20	(optioneel) Het aantal rijen dat het resultaten maximaal mag bevatten. Maximaal 100.

Voorbeeld

https://pinkhof.ivdnt.org/api/pinkhof/v1.0/search?q.lemma-tokenized=test&q.variant-tokenized=*test*&rows=10

{
  "summary": {
    "params": {
      "q.lemma-tokenized": "test",
      "q.variant-tokenized": "*test*",
      "rows": "10",
    },
    "numFound": 415,
    "start": 0,
  },
  "results": [
    {
      "pid": "6078acd9uec.NL01",
      "title": "test",
      "lemma": "test",
      "lemma-suggest": ["test"],
      "lemma-sort": "test",
      "definition": [
        "procedure of onderzoek ten behoeve van diagnostiek; vb. COVID-19-test",
      ],
      "definition-trunc": [
        "procedure of onderzoek ten behoeve van diagnostiek; vb. COVID-19-test",
      ],
      "seeAlso-name": ["proef", "toets"],
      "seeAlso-target": ["6078acd9ov1.NL01", "663b92d74v.NL01"],
      "xml": 'testprocedure of onderzoek ten behoeve van diagnostiek; vb. COVID-19-testproeftoetstesten',
      "_version_": 1718492906196566026,
    },
    ...
  ],
}

Informatie per document

GET

docs/<pid>

Parameter	Standaardwaarde	Beschrijving
<pid>		De identifier van het document (te vinden via /search).

Beschikbare velden

Per document zijn de volgende velden beschikbaar:

Parameter	Beschrijving
pid	Identifier van het document.
title	Leesbare titel, zoals weergegeven boven het document.
lemma	Het hele lemma. Meestal gelijk aan title.
lemma-suggest	Lemma zoals verwerkt voor betere autocomplete-suggesties. Voor intern gebruik.
lemma-sort	Lemma ontdaan van alle apostrophes om het sorteren te vereenvoudigen.
definition	Definitie(s) van de term.
definition-trunc	Definitie(s) ingekort tot maximaal 100 tekens voor preview-doeleinden.
see-name	Namen van de 'zie'-verwijzingen. Volgorde correspondeert met see-target.
see-target	PIDs van de 'zie'-verwijzingen.
seeAlso-target	PIDs van de 'zie ook'-verwijzingen. Volgorde correspondeert met seeAlso-target.
synonym-name	Synonymen van de term.
xml	De oorspronkelijke xml-structuur van het document, voor het indexeren.
_version_	Intern versienummer.
xslt_result	HTML-weergave zoals gebruikt op de website.

Voorbeeld

https://pinkhof.ivdnt.org/api/pinkhof/v1.0/docs/6078acd91no.NL01

{
  "pid": "6078acd91no.NL01", 
  "title": "anti-ds-DNA", 
  "lemma": "anti-ds-DNA", 
  "lemma-suggest": [
    "anti-ds-DNA"
  ], 
  "lemma-sort": "anti-ds-DNA", 
  "definition": [
    "antinucleaire antistof, gericht tegen dubbelstrengs DNA"
  ], 
  "definition-trunc": [
    "antinucleaire antistof, gericht tegen dubbelstrengs DNA"
  ], 
  "seeAlso-name": [
    "DNA"
  ], 
  "seeAlso-target": [
    "6078acd98kh.NL01"
  ], 
  "synonym-name": [
    "anti-ds-DNA-antistof"
  ], 
  "xml": "...", 
  "_version_": 1718492903954710529, 
  "xslt_result": "..."
}