FragDenStaat-API

Wir bieten einen maschinenlesbaren Zugriff auf die Daten von FragDenStaat.de an und ermöglichen die Parametrisierung der „Anfrage stellen“-Seite.

API-Root: https://fragdenstaat.de/api/v1/

OpenAPI-Schema: https://fragdenstaat.de/api/v1/schema

Swagger UI, um die API zu erkunden

Beispiele für Ressourcen-Endpunkte:

  • Anfragen: https://fragdenstaat.de/api/v1/request/
  • Behörden: https://fragdenstaat.de/api/v1/publicbody/

Mit einem FragDenStaat-Account können sich Entwickler*innen eine OAuth-Anwendung registrieren, um darüber externe Dienste anzubieten.

Anfrage-Formular


Das Anfrage-Formular lässt sich mit Query-Parametern vorausfüllen:

Als Basis kann eine normale URL:
https://fragdenstaat.de/anfrage-stellen/
oder eine URL mit Behörden-Slug genommen werden:
https://fragdenstaat.de/anfrage-stellen/an/testbehorde/
oder eine URL mit einer Behörden-ID:
https://fragdenstaat.de/anfrage-stellen/an/7681/

Mit eingeloggtem Konto und Berechtigung für FragDenStaat+ lassen sich auch mehrere Behörden gleichzeitig anfragen. Dazu werden Behörden-IDs mit + verbunden:
https://fragdenstaat.de/anfrage-stellen/an/7681+7682/

Folgende Query-Parameter stehen zur Verfügung, alle optional.

  • subject - wird als Betreff verwendet.
  • body - wird als Text verwendet.
  • tags - wird als komma-separierte Liste von Tags verwendet.
  • publicbody - Behörden-ID, auch als Query-Parameter möglich.
  • law_type - ein Gesetzes-Typ kann übergeben werden, z.B. UIG, um die Gesetze, die auf die Behörde zutreffen, nach dem Typ zu filtern und damit den Brieftext anzupassen.

Die Parameter subject und body können mit zusätzlichen Variablen interpoliert werden, die mit einem $-Präfix übergeben werden. Das kann hilfreich sein, wenn ein Formular mit entsprechend benannten Feldern per GET-Methode an die Anfrage-Stellen-URL abgeschickt wird. Ein Beispiel findet sich auf unserer Kampagnen-Seite zu Abwendungsvereinbarungen:

$adresse=Teststr&
subject=Abwendungsvereinbarung+$adresse

Außerdem gibt es weitere Parameter, die das Aussehen des Formulars verändern:

  • hide_similar=1 - versteckt den „ähnliche Anfragen“-Bereich, bei Kampagnen mit vielen ähnlich-lautenden Anfragen nützlich.
  • hide_public=1 - erzwingt, dass die Anfrage öffentlich gestellt wird.
  • hide_draft=1 - verhindert, dass die Anfrage als Entwurf gespeichert werden kann.
  • hide_publicbody=1 - verhindert, dass die Empfänger-Behörde der Anfrage angepasst werden kann.
  • hide_full_text=1 - verhindert, dass der Anfragebrief komplett angepasst werden kann.
  • hide_editing=1 - zeigt die Anfrage ohne Texteingabe an, das Bearbeiten ist über einen separaten Klick aber möglich.

Open Source

Sämtliche Software zu FragDenStaat.de ist Open Source und auf GitHub zu finden.