Zoeken naar contactgegevens overheden en politici

API

De databron wie wij gebruiken is Overheidsorganisaties XML, deze XML converteren en importeren wij in een database die we met een REST API (PostREST) toegankelijk stellen. De API kan zowel JSON als CSV terug sturen. Let op, met PostgREST zijn database intensieve queries te maken, daarom hebben we de query limiet op tien seconden gezet.

De API heeft vele endpoints maar de overheidsorganisatie is de interessante, gezien alle objecten een overheidsorganisatie-object zijn, de andere endpoints zijn voor de onderlinge relaties, maar deze kunnen ook via PostgREST resource embedding tot op zekere hoogte worden meegenomen in de overheidsorganisatie-call.

Zie onderaan deze pagina de changelog en upgrade instructie vanaf v0. Voor meer informatie over het tijdspad van versie upgrades van de API zie de deprecation policy.

Changelog

v1

Door de Overheids Almanak wijzigingen in 2.4.10 "meerdere organisatietypes mogelijk per organisatie" moest ook de Allmanak API een nieuwe versie krijgen.

  • type van enum ootype is hernoemt naar types van enum array ootype[], zie upgrade instructie

Features:

Opgeloste bugs:

  • beleidsterreinen, resourceidentifiers en wettelijkevoorschriften zitten niet meer in een dubbele array, maar een enkele

Deprecation Policy

De API zal door dataformaat aanpassingen van de Overheids Almanak soms een update krijgen, brekende updates zullen een nieuwe versie krijgen. Als een oud API endpoint deprecated is, zal de Deprecation header worden toegevoegd (tesamen met een Sunset en successor-version link). Indien mogelijk houden we na een upgrade de oude API nog 6 maanden online met deze headers. Na deze 6 maanden zullen we de HTTP status code wijzigen naar 207 Multi-Status en na een maand naar 301 Moved Permanently welke we naar de nieuwe API zullen redirecten, waarna we na enige tijd de oude API 410 Gone zullen laten retourneren.

Vervallen v0

v0 kan nog worden gebruikt, maar deze pakt enkel het eerste type uit de array, wat kan leiden tot onvolledige resultaten.

Upgrades naar v1: waar eerder type=eq.Gemeente werd gebruikt kan nu types=cs.{Gemeente} worden gebruikt.

Tijdspad:

  • vrijdag 31 januari 2020 23:59:59 GMT: de HTTP Status zal op 207 Multi-Status worden gezet (buiten de HTTP status zal de API blijven functioneren)
  • vrijdag 28 februari 2020 23:59:59 GMT: de API verwijst d.m.v. HTTP Status 301 Moved Permanently naar v1 (de v0 API zal niet meer te bereiken zijn)
  • dinsdag 31 maart 2020 23:59:59 GMT: de v0 API zal antwoorden met HTTP Status 410 Gone

Indien er meer formaatswijzigingen komen aan de Overheids Almanak kan het zijn dat het tijdspad wordt ingekort.