Open data: documenten
Op Rijksoverheid.nl verschijnen elke dag documenten zoals o.a. besluiten, toespraken en kamerstukken. Deze documenten zijn beschikbaar via open data.
Documenten opvragen
Vraag een set met documenten op via de url:
https://opendata.rijksoverheid.nl/v1/documents
De lijst filteren op onderwerp
De documenten op Rijksoverheid.nl horen bij nul of meer onderwerpen. U kunt alle documenten voor 1 bepaald onderwerp opvragen. De onderwerpomschrijving haalt u uit de lijst met onderwerpen:
https://opendata.rijksoverheid.nl/v1/infotypes/subject
Gebruik de waarde in het name-veld om de documenten te filteren op onderwerp.
Voorbeeld
Zo vraagt u de documenten bij het onderwerp ‘Asbest’ op:
https://opendata.rijksoverheid.nl/v1/documents?subject=asbest
Meer informatie
Uitgebreide specificatie van de lijst van onderwerpen
De lijst filteren op ministerie
De documenten op Rijksoverheid.nl horen bij nul of meer ministeries. U kunt alle documenten voor een bepaald ministerie opvragen. De ministerie-omschrijving haalt u uit de lijst met ministeries:
https://opendata.rijksoverheid.nl/v1/infotypes/ministry
Gebruik de waarde in het name-veld om de documenten te filteren op organisatieonderdeel.
Voorbeeld
Zo vraagt u de documenten van het ministerie van Algemene Zaken op:
https://opendata.rijksoverheid.nl/v1/documents?organisationalunit=ministerie-van-algemene-zaken
Meer informatie
Uitgebreide specificatie van de lijst van ministeries
De lijst filteren op informatietype
De documenten op Rijksoverheid.nl zijn van een bepaald informatietype. U kunt de beschikbare informatietypen opvragen op:
https://opendata.rijksoverheid.nl/v1/documents/infotypes
Gebruik de waarde in het name-veld om de documenten te filteren op informatietype.
Voorbeelden
Zo vraagt u documenten van het informatietype besluit op:
https://opendata.rijksoverheid.nl/v1/documents?type=besluit
Zo vraagt u de documenten van het informatietype besluit van het ministerie van Defensie op:
Zo vraagt u de documenten van het informatietype kamerstuk van het ministerie van Financiën over het onderwerp koopkracht op:
Zo vraagt u de documenten van het informatietype regeling van het onderwerp infectieziekten op:
https://opendata.rijksoverheid.nl/v1/documents?type=regeling&subject=infectieziekten
Meer informatie
Uitgebreide specificatie van de lijst met informatietypen
Parameters om de lijst met documenten verder te verfijnen
U krijgt een meer specifieke response door parameters mee te geven aan een request. U kunt hiervoor 4 parameters gebruiken.
Parameter: ‘lastmodifiedsince’
Met ‘lastmodifiedsince’ vraagt u gegevens op die sinds een bepaalde datum zijn gewijzigd. De datum maakt u op als jjjjmmdd.
Voorbeelden
Zo vraagt u de documenten op die zijn gewijzigd op of na 1 november 2017:
https://opendata.rijksoverheid.nl/v1/documents?lastmodifiedsince=20171101
Zo vraagt u de documenten van het ministerie van Financien op die zijn gewijzigd op of na 1 november 2017:
Parameter: ‘output’
Met ‘output’ bepaalt u in welke opmaak u de open data krijgt: een XML of JSON.
- voor een response in JSON: ?output=json
- voor een response in XML: ?output=xml
Voorbeelden
Zo vraagt u de documenten van het ministerie van Financien op die zijn gewijzigd op of na 1 november 2017 in JSON:
Zo vraagt u de documenten van het ministerie van Financien op die zijn gewijzigd op of na 1 november 2017 in XML:
Parameter: ‘offset’
Met ‘offset’ bepaalt u vanaf welk item in de totale set aan zoekresultaten u resultaten getoond wilt hebben. Geef een getal gelijk aan of groter dan 0 op, bijvoorbeeld: ‘?offset=12’
Zo vraagt u documenten op vanaf zoekresultaat 13 en hoger:
https://opendata.rijksoverheid.nl/v1/documents?offset=12
Parameter: ‘rows’
Met ‘rows’ geeft u aan hoeveel resultaten u getoond wilt hebben. Het maximum is 200.
Zo vraagt u 200 documenten op:
https://opendata.rijksoverheid.nl/v1/documents?rows=200
Parameters ‘offset’ en ‘rows’ combineren
Om een specifieke reeks uit een dataset op te vragen combineert u de parameters ‘offset’ en ‘rows’.
Bijvoorbeeld: u wilt uit een bepaalde dataset de zoekresultaten 100 tot en met 175 opvragen. Geef dan als input voor de parameter ‘offset’ de waarde 99 en voor de parameter ‘rows’ de waarde 75.
Omvang en weergave van datasets
Standaard krijgt u in de response maximaal 25 resultaten gepresenteerd. Die zijn gesorteerd op frontenddatum, met het meest recente item onderaan.
Wilt u meer dan 25 resultaten opvragen, gebruik dan de parameter ‘rows’. Met ‘rows’ is het maximumaantal items dat u in 1 keer kunt opvragen 200.
Wilt u meer dan 200 resultaten? Combineer dan de parameters 'offset' en 'rows' om het totale aantal items in tranches van 200 op te vragen:
- offset=0,rows=200 voor resultaten 1 t/m 200
- offset=200,rows=200 voor resultaten 201 t/m 400
- etc, etc.
Zoek in de (gefilterde) lijst het gewenste document
Het veld ‘dataurl’ bij het gewenste document bevat het volledige pad. Vraag hiermee de inhoud van het document op.
Voorbeeld
Zo vraagt u de toespraak bij de uitreiking van de Johannes Vermeerprijs op:
https://opendata.rijksoverheid.nl/v1/documents/d11fdbca-8cf4-4eb2-bcc6-466e75b8776d
Velden lijst documenten
Voor elk van de documenten in de lijst van documenten worden de volgende velden getoond:
Veld | Betekenis van het veld |
---|---|
id | Ieder document heeft een unieke code. |
type | Het type informatie in dit geval een document. |
typeid | Ieder type informatie heeft een unieke code. |
subType | De subgroep van een type informatie. |
canonical | De canonical is de URL naar de originele versie van het document. |
dataurl | De URL naar de open data set van het document. |
title | De titel van het document. |
introduction | De introductietekst van het document. |
locations | De geografische aanduiding van het document. |
lastmodified | De datum waarop het document voor de laatste keer is opgeslagen in het systeem. |
available | De datum waarop het document voor het eerst is aangemaakt in het systeem. Deze datum kan de auteur aanpassen in het systeem. |
frontenddate | De datum waarop het document formeel is uitgegeven. Deze datum wordt door de auteur verplicht ingevuld in het systeem. (NB. Voor een document is de ‘frontenddate’ altijd gelijk aan ‘issued’.) |
initialdate | De datum waarop het document is aangemaakt in het systeem. Deze datum kan de auteur niet handmatig aanpassen in het systeem (dit is een systeemdatum). |
Velden document
Een individueel document bevat de volgende velden:
Veld | Betekenis van het veld |
---|---|
id | Ieder document heeft een unieke code. |
type | Het type informatie, in dit geval een document. |
typeid | Ieder type document heeft een unieke code. |
subType | De subgroep van een type document. |
canonical | De canonical is de URL naar de originele versie van het document. |
dateurl | De URL naar de open data set van het document. |
title | De titel van het document. |
fileurl | De URL van de file. |
mimetype | Dit is een standaard die de aard en indeling van een document of bestand aangeeft. |
filesize | De grootte van de file in bytes. |
filename | De naam van de file. |
filetitle | De titel van de file. |
numberofpages | Het aantal pagina’s van de file |
introduction | De introductietekst van het document. |
content | Tekst uit de contentblokken tekst in het document. |
contentblock | Eén contentblok (paragraaf). |
paragraphtitle | Titel van de paragraaf. |
paragraph | Tekst in de paragraaf. |
authorities | De wettelijk verantwoordelijke voor de inhoud van het document. |
creators | De eindverantwoordelijke voor het creëren van het document. |
subjects | De gekoppelde onderwerpen aan het document. |
subjectids | Ieder onderwerp heeft een unieke code |
themes | De gekoppelde thema’s aan het document. |
organisationalunits | De gekoppelde organisatieonderdelen aan het document. |
lastmodified | De datum waarop het document voor de laatste keer is opgeslagen in het systeem. |
issued | De datum waarop het document formeel is uitgegeven. Deze datum wordt door de auteur verplicht ingevuld in het systeem. (NB Voor een document is de ‘issued’ altijd gelijk aan de ‘frontenddate’) |
available | De datum waarop het nieuwsbericht voor het eerst is aangemaakt in het systeem. Deze datum kan de auteur aanpassen in het systeem. |
frontenddate | De datum waarop het document formeel is uitgegeven. Deze datum wordt door de auteur verplicht ingevuld. (NB Voor een document is de ‘frontenddate’ altijd gelijk aan ‘issued’.) |
initialdate | De datum waarop het document is aangemaakt in het systeem. Deze datum kan de auteur niet handmatig aanpassen in het systeem (dit is een systeemdatum). |
licence | Informatie over de rechten van het document. |
rightsholders | De organisatie die de rechten bezit of beheert van het document. |
language | De taal van het document. |
location | De geografische aanduiding van het document. |
Bovengenoemde velden, de subvelden van files (fileurl, mimetype etc.) uitgezonderd, worden altijd allemaal in de open data weergegeven voor elk document, ook als ze geen waarde bevatten.