Alle Pläne zum Plantyp abfragen.
Einführung
Dieses Dokument beschreibt eine JSON-Schnittstelle, mit der die Inhalte des Planungsinformations- und Beteiligungsservers abgefragt und auf externen Webseiten dargestellt werden können. Zur Nutzung der API ist keine spezielle Authentifizierung notwendig, allerdings muss zu jeder Abfrage ein Kennschlüssel angegeben werden. Der Kennschlüssel für einzelne Städte kann per E-Mail erfragt werden.
Die API kann über folgender URL angesprochen werden:
https://portal.tetraeder.com/set/api/pb/1.0.0/
Um einen Key "{kennschluessel}" zu generieren wenden Sie sich bitte tetraeder.
Rückgabewerte
Die Anfragen geben immer ein Antwort-Objekt mit folgender Struktur zurück:
{ "status": { "code": 200, "message": '' }, "response": {...} }
Im Attribut "response" werden die unten angegebenen Antwort-Objekte zurückgegeben. Der Code entspricht dem zurückgegebenen HTTP-Fehlercode. Bei Fehlermeldungen enthält "message" zusätzliche Informationen zur Fehlerursache.
Beispiele
Die folgenden Beispiele zeigen, wie die Darstellung z.B. vollständig über Javascript und JSONP-Abfragen gestaltet werden könnte.
Operationen
GET /{kennschluessel}/plaene/alle/{plantyp}/
Alle Pläne zum Plantyp
GET
| Name | Pflicht? | Beschreibung | Typ |
|---|---|---|---|
| kennschluessel | ja | API-Kennschlüssel | string |
| plantyp | ja | Plantyp | string |
{
entries : [
{
href : "https://...",
nr : "BPL 1",
name : "Am Beispielplan Neuaufstellung"
},...
]
}
| HTTP Status Code | Ursache |
|---|---|
| 404 | Stadt nicht gefunden |
GET /{kennschluessel}/plaene/aufstellung/{plantyp}
Alle Pläne im Aufstellungsbeschluss
Alle im Aufstellungsbeschluss befindlichen Pläne abfragen. Optionale Filterung über den Plantyp.
GET
| Name | Pflicht? | Beschreibung | Typ |
|---|---|---|---|
| kennschluessel | ja | API-Kennschlüssel | string |
| plantyp | nein | Filter nach Plantyp | string |
{
entries : [
{
href : "https://...",
nr : "BPL 1",
name : "Am Beispielplan Neuaufstellung"
},...
]
}
| HTTP Status Code | Ursache |
|---|---|
| 404 | Stadt nicht gefunden |
GET /{kennschluessel}/plaene/beteiligung/{plantyp}/
Alle Pläne in der Öffentlichkeitsbeteiligung
Alle in der fruehzeitigen Öffentlichkeitsbeteiligung befindlichen Pläne. Abgabe einer Stellungnahme möglich. Optionale Filterung über den Plantyp.
GET
| Name | Pflicht? | Beschreibung | Typ |
|---|---|---|---|
| kennschluessel | ja | API-Kennschlüssel | string |
| plantyp | nein | Filter nach Plantyp | string |
{
entries : [
{
href : "https://...",
nr : "BPL 1",
name : "Am Beispielplan Neuaufstellung"
},...
]
}
| HTTP Status Code | Ursache |
|---|---|
| 404 | Stadt nicht gefunden |
GET /{kennschluessel}/plaene/offenlage/{plantyp}/
Alle Pläne in der Offenlage
Alle in der Offenlage befindlichen Pläne. Abgabe einer Stellungnahme möglich. Optionale Filterung über den Plantyp.
GET
| Name | Pflicht? | Beschreibung | Typ |
|---|---|---|---|
| kennschluessel | ja | API-Kennschlüssel | string |
| plantyp | nein | Filter nach Plantyp | string |
{
entries : [
{
href : "https://...",
nr : "BPL 1",
name : "Am Beispielplan Neuaufstellung"
},...
]
}
| HTTP Status Code | Ursache |
|---|---|
| 404 | Stadt nicht gefunden |
GET /{kennschluessel}/plaene/abgeschlossen/{plantyp}/
Alle rechtskräftigen Pläne
Alle rechtskräftigen/abgeschlossenen Pläne. Optionale Filterung über den Plantyp.
GET
| Name | Pflicht? | Beschreibung | Typ |
|---|---|---|---|
| kennschluessel | ja | API-Kennschlüssel | string |
| plantyp | nein | Filter nach Plantyp | string |
{
entries : [
{
href : "https://...",
nr : "BPL 1",
name : "Am Beispielplan Neuaufstellung"
},...
]
}
| HTTP Status Code | Ursache |
|---|---|
| 404 | Stadt nicht gefunden |
GET /{kennschluessel}/plan/{planid}/
Plandetails
Alle Daten zu einem Plan abfragen.
GET
| Name | Pflicht? | Beschreibung | Typ |
|---|---|---|---|
| kennschluessel | ja | API-Kennschlüssel | string |
| planid | ja | Plan ID | int |
{
name : "Am Beispielplan Neuaufstellung",
id : "Plan-ID im Beteiligungsserver",
nr : "Plan Nr.",
text : "Einführende Text",
// Geometrie des Plans in Well-Known-Text Repräsentation, Längen- und Breitengrade (WGS84):
wkt : "POLYGON((...))",
rechtskraft : 1 , // 0 oder 1
im_verfahren : 1, // 0 oder 1, ist der Plan in einem laufenden Verfahren?
plantyp : "b",
orte : [
{
"name": "Ortname",
// Geometrie des Plans in Well-Known-Text Repräsentation, Längen- und Breitengrade (WGS84):
"wkt" : "POLYGON((...))"
},...
],
verfahrensschritte : [
{
name : "Aufstellungsbeschluss",
von : "2013-05-05",
bis : "2013-05-05",
stellungnahme : 1 // 0 oder 1, Abgabe einer Stellungnahme zur Öffentlichkeitsbeteiligung möglich
stellungnahme_href : "https://..."
},...
],
ansprechpartner : [
{
name : "Herr Manfred Mustermann",
telefon : "0231 1234567",
email : "ManfredMustermann@meineadresse.de"
},...
],
// Bezüg zu anderen Plänen
bezuege : [
{
name : "Planname",
href : "https://..."
},...
],
// Bezüg zu anderen Plänen (Parallelverfahren)
parallelverfahren : [
{
name : "Planname",
href : "https://..."
},...
],
dateien : [
{
linkname : "Begründung",
gruppe : "Gruppenname",
titel : "Überschrift",
quelle : "Quellenangabe",
text : "Zusatztext",
download_url : "https://..."
},...
],
links : [
{
linkname : "Begründung",
url : "https://...",
gruppe : "Gruppenname"
},...
]
}
| HTTP Status Code | Ursache |
|---|---|
| 404 | Stadt oder Plan nicht gefunden |
GET /{kennschluessel}/suche/{Suchbegriff}
Suche in allen Plänen nach dem Suchbegriff
Alle Pläne suchen.
GET
| Name | Pflicht? | Beschreibung | Typ |
|---|---|---|---|
| kennschluessel | ja | API-Kennschlüssel | string |
| Suchbegriff | ja | string |
{
entries : [
{
name : "Beispielplan",
nr : "123",
href : "/plan/123"
ausgabe_url : "https://www.o-sp.de/...."
},...
]
}
| HTTP Status Code | Ursache |
|---|---|
| 404 | Keine Pläne gefunden |
GET /{kennschluessel}/orte
Alle Ortsteile
Alle Ortsteile/Stadtteile abfragen.
GET
| Name | Pflicht? | Beschreibung | Typ |
|---|---|---|---|
| kennschluessel | ja | API-Kennschlüssel | string |
{
entries : [
{
name : "Beispielort",
// Geometrie des Ortes in Well-Known-Text Repräsentation, Längen- und Breitengrade (WGS84):
"wkt" : "POLYGON((...))"
href : "https://...."
},...
]
}
| HTTP Status Code | Ursache |
|---|---|
| 404 | Stadt nicht gefunden |
GET /{kennschluessel}/ort/{ortid}
Alle Pläne im Ortsteil
Alle im Ortsteil befindlichen Pläne abfragen.
GET
| Name | Pflicht? | Beschreibung | Typ |
|---|---|---|---|
| kennschluessel | ja | API-Kennschlüssel | string |
| ortid | ja | Ort ID | int |
{
entries : [
{
name : "Am Beispielplan Neuaufstellung",
href : "https://..."
},...
]
}
| HTTP Status Code | Ursache |
|---|---|
| 404 | Stadt oder Ort nicht gefunden |
GET /{kennschluessel}/plantypen
Mögliche Plantypen abfragen
Alle Plantypen zur Stadt abfragen
GET
| Name | Pflicht? | Beschreibung | Typ |
|---|---|---|---|
| kennschluessel | ja | API-Kennschlüssel | string |
{
entries : [
{
plantyp : "b",
name : "Bebauungsplan"
},...
]
}
| HTTP Status Code | Ursache |
|---|---|
| 404 | Stadt nicht gefunden |
POST /{kennschluessel}/plan/{planid}/stellungnahme/{terminid}
Stellungnahme zur Beteiligung
Stellungnahme zu einer Öffentlichkeitsbeteiligung abgeben. Anfragen müssen über HTTPS verschlüsselt sein.
POST
| Name | Pflicht? | Beschreibung | Typ |
|---|---|---|---|
| kennschluessel | ja | API-Kennschlüssel | string |
| planid | ja | Plan ID | int |
| terminid | ja | Termin ID | int |
| Name | Pflicht? | Beschreibung | Typ |
|---|---|---|---|
| planid | ja | Plan ID | int |
| vorname | ja | Vorname | string (255) |
| nachname | ja | Nachname | string (255) |
| strasse | ja | Strasse | string (255) |
| hausnr | ja | Hausnummer | string (255) |
| plz | ja | Postleitzahl | string (255) |
| ort | ja | Ort | string (255) |
| telefon | nein | Telefon | string (255) |
| nein | E-Mail-Adresse | string (255) | |
| text | ja | Stellungnahme | Text (65000) |
| HTTP Status Code | Ursache |
|---|---|
| 400 | Fehlerhafte oder leere POST-Parameter |
| 403 | Anfrage ist nicht über HTTPS eingegangen |
| 404 | Stadt oder Plan nicht gefunden oder keine aktuelle Öffentlichkeitsbeteiligung |