U bent hier

REST API


Let op: deze pagina beschrijft versie 1.0 van de API welke medio april 2019 wordt vervangen door versie 2.0. Zie het laatste nieuws voor meer informatie.

De feed regelt de verwerking van de data, met Next en Resume indien er veel data beschikbaar is. Dat is bij REST standaard zo. Zodra de lijst met data opgehaald is, kunnen de betreffende entiteiten en bestanden opgehaald worden via hun eigen end-points. Het is mogelijk om de data al in de feed te laten zien of ervoor te zorgen dat de data extern wordt opgehaald. Aangezien het om een grote dataset kan gaan, kunt u hiervoor zelf kiezen, via “Content=internal/external”.

End-points van REST:

  • /REST/Feed
    • /Feed.xml of /Feed?format=xml
    • /Feed.json of /Feed?format=json
  • /REST/Entiteiten: Per identiteit (GUID, Globally Unique Identifier) zijn de entiteiten terug te vinden.
  • /REST/Resources: Bestanden kunnen op deze manier opgehaald worden.

Entiteiten

U kunt entiteiten eenvoudig ophalen via de feed door de link te volgen. De data wordt dan gepresenteerd. Een voorbeeldlink is in de paragraaf hiervoor al beschreven. Binnen de entiteiten kunt u zoeken via een querytaal. In principe kunt u in de gehele XML zoeken.
Een voorbeeld:
https://gegevensmagazijn.tweedekamer.nl/REST/feed.xml?filter=/kamerstukdossier[vetnummer=34475]&content=internal

Hier is te zien dat de REST/Entiteiten nu wordt aangesproken. De applicatie zal de betreffende entiteit teruggeven. Op GUID kunt u ook naar de entiteit gaan:
https://gegevensmagazijn.tweedekamer.nl/REST/Entiteiten/497ed9dd-cc0a-440a-a566-8234bed094a2?format=xml&content=internal

Een complexer voorbeeld om op datum te filteren met de functie "xs:dateTime":
https://gegevensmagazijn.tweedekamer.nl/REST/feed.xml?filter=/vergadering[((begin >= xs:dateTime("2018-02-01T00:00:00")))]&content=internal

Voorbeeld van hoe dit met 2 data zou kunnen:
https://gegevensmagazijn.tweedekamer.nl/REST/feed.xml?filter=/vergadering[((begin >= xs:dateTime("2018-02-01T00:00:00"))) and ((begin < xs:dateTime("2018-03-01T00:00:00")))]&content=internal

Resources / Bestanden

Bij het klikken op een link kunt u bestanden downloaden. Hieronder ziet u een voorbeeldlink, met daarbij het bestand weergegeven in de browser.
Een praktijkvoorbeeld:
Een parlementair document bevat verwijzing(en) naar een bestand:
https://gegevensmagazijn.tweedekamer.nl/REST/feed.xml?filter=/parlementairDocument[nummer='2017D08829']&content=internal

Het bestand is op te vragen en dus te downloaden via de “bestand ref”:
https://gegevensmagazijn.tweedekamer.nl/REST/Resources/c26ab0c7-16c4-4f63-91d8-aaab5443e03a

REST maakt gebruik van paginering, zichtbaar aan het einde van het bericht:
 <link rel="self" href="https://gegevensmagazijn.tweedekamer.nl/REST/feed.xml?filter=/activiteit/agendapunt%5Bbesluit/stemming%5D&content=internal" />
 <link rel="next"
href="https://gegevensmagazijn.tweedekamer.nl/REST/Feed?filter=%2Factiviteit%2Fagendapunt%5Bbesluit%2Fstemming%5D&content=internal&piket=F8PbAAAAAAA%3
D" />