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/sources/rijksoverheid/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/sources/rijksoverheid/infotypes/subject

Gebruik de waarde in het name-veld om de documenten te filteren op onderwerp.

Voorbeelden

Zo vraagt u de documenten bij het onderwerp ‘Asbest’ op: 

https://opendata.rijksoverheid.nl/v1/sources/rijksoverheid/documents?subject=asbest

Zo vraagt u de documenten bij het onderwerp ‘Kraamverlof en partnerverlof’ op: 

https://opendata.rijksoverheid.nl/v1/sources/rijksoverheid/documents?subject=kraamverlof-en-partnerverlof

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/sources/rijksoverheid/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/sources/rijksoverheid/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/sources/rijksoverheid/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/sources/rijksoverheid/documents?type=besluit

Zo vraagt u de documenten van het informatietype besluit van het ministerie van Defensie op: 

https://opendata.rijksoverheid.nl/v1/sources/rijksoverheid/documents?type=besluit&organisationalunit=ministerie-van-defensie

Zo vraagt u de documenten van het informatietype kamerstuk van het ministerie van Financiën over het onderwerp erfbelasting op: 

https://opendata.rijksoverheid.nl/v1/sources/rijksoverheid/documents?subject=erfbelasting&type=parliamentarydocument&organisationalunit=ministerie-van-financien

Zo vraagt u de documenten van het informatietype richtlijn van het onderwerp huurwoning op: 

https://opendata.rijksoverheid.nl/v1/sources/rijksoverheid/documents?type=regeling&subject=huurwoning

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/sources/rijksoverheid/documents?lastmodifiedsince=20171101

Zo vraagt u de documenten van het ministerie van Financien op die zijn gewijzigd op of na 1 november 2017:

https://opendata.rijksoverheid.nl/v1/sources/rijksoverheid/documents?organisationalunit=ministerie-van-financien&lastmodifiedsince=20171101

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:

https://opendata.rijksoverheid.nl/v1/sources/rijksoverheid/documents?organisationalunit=ministerie-van-financien&lastmodifiedsince=20171101&output=json

Zo vraagt u de documenten van het ministerie van Financien op die zijn gewijzigd op of na 1 november 2017 in XML:

https://opendata.rijksoverheid.nl/v1/sources/rijksoverheid/documents?organisationalunit=ministerie-van-financien&lastmodifiedsince=20171101&output=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/sources/rijksoverheid/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/sources/rijksoverheid/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 het document Speech uitreiking Johannes Vermeerprijs op:

https://opendata.rijksoverheid.nl/v1/sources/rijksoverheid/documents/44e4d3f6-f3a6-4a15-b986-836eac238a90

Velden lijst documenten

Voor elk van de documenten in de lijst van documenten worden de volgende velden getoond:

  • id
  • type
  • subtype
  • canonical
  • dataurl
  • title
  • introduction
  • locations
  • lastmodified
  • frontenddate

Velden document

Een individueel document bevat de volgende velden:

  • id
  • type
  • subType
  • canonical
  • dataurl
  • title
  • files
    • fileurl
    • mimetype
    • filesize
    • filename
    • filetitle
    • numberofpages
  • introduction
  • content
    • contenblock
      • paragraph
      • paragraphtitle
  • authorities
  • creators
  • subjects 
  • themes
  • organisationalunits
  • lastmodified
  • issued
  • available
  • frontenddate
  • license
  • rightsholders
  • languages
  • locations

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.