{ "openapi": "3.1.0", "info": { "title": "TSA Infodienste - ID REST GD", "description": "Dies ist die Dokumentation der RestApi der 'TSA Infodienste REST API - Gebietsservice'. Der Zugriff auf die RestApi ist über einen ApiKey geschützt, dieser wird im Redaktionssystem der Infodienste konfiguriert.", "contact": { "name": "TSA - Infodienste", "url": "https://infodienste.de" }, "license": { "name": "1.0.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.9.0-SNAPSHOT" }, "servers": [ { "url": "[...]", "description": "Generated server url" } ], "security": [ { "api_key": [] } ], "paths": { "/PoliticalArea": { "get": { "tags": ["PoliticalAreaResource"], "summary": "showAll", "description": "Gibt alle verwaltungspolitischen Gebiete zurück.", "operationId": "PoliticalAreaResourceShowAll", "parameters": [ { "name": "includeDeactivatedAreas", "in": "query", "description": "Deaktivierte Gebiete (validFrom,validTo nicht im aktuellen Zeitraum) in Ergebnismenge einbinden. Default ist FALSE.", "required": false, "schema": {"type": "boolean"} }, { "name": "lastUpdated", "in": "query", "description": "Geändert seit diesem Datum", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "selectAttributes", "in": "query", "description": "Attribute des Objektes die ausgegeben werden sollen", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "structuralKey", "parentStructuralKey", "displayName", "uniqueName", "ags", "rs", "vnr", "otnr", "postalCodes", "population", "dataSource", "parent", "areaType", "geoCodingShapes" ] } } }, { "name": "sort", "in": "query", "description": "Name des Attributes nach dem sortiert werden soll", "required": false, "schema": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "structuralKey", "parentStructuralKey", "displayName", "uniqueName", "ags", "rs", "vnr", "otnr", "postalCodes", "population" ] } }, { "name": "sortdescending", "in": "query", "description": "Absteigende Sortierung festlegen. Standard ist false.", "required": false, "schema": {"type": "boolean"} }, { "name": "offset", "in": "query", "description": "Startposition der Teilmenge der Ergebnismenge.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Anzahl der Teilmenge der Ergebnismenge. Maximum ist 500.", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/ResultObjectCollectionPoliticalArea"} } } }, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, "/PoliticalArea/{id}": { "get": { "tags": ["PoliticalAreaResource"], "summary": "show", "description": "Gibt das verwaltungspolitische Gebiet anhand seiner Id zurück.", "operationId": "PoliticalAreaResourceShow", "parameters": [ { "name": "id", "in": "path", "description": "Id des Gebietes", "required": true, "schema": {"type": "string"} }, { "name": "selectAttributes", "in": "query", "description": "Attribute des Objektes die ausgegeben werden sollen", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "structuralKey", "parentStructuralKey", "displayName", "uniqueName", "ags", "rs", "vnr", "otnr", "postalCodes", "population", "dataSource", "parent", "areaType", "geoCodingShapes" ] } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/PoliticalArea"} } } }, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, "/PoliticalArea/{id}/structure": { "get": { "tags": ["PoliticalAreaResource"], "summary": "structure", "description": "Gibt die Struktur des verwaltungspolitischen Gebietes zurück. Die Struktur kann nach Gebietstypen gefiltert werden.", "operationId": "PoliticalAreaResourceStructure", "parameters": [ { "name": "id", "in": "path", "description": "Id des Startknoten der Struktur", "required": true, "schema": {"type": "string"} }, { "name": "areaTypes", "in": "query", "description": "zulässige Gebietstypen im Ergebnis", "required": false, "schema": { "type": "array", "items": {"type": "string"} } }, { "name": "includeDeactivatedAreas", "in": "query", "description": "Deaktivierte Gebiete (validFrom,validTo nicht im aktuellen Zeitraum) in Ergebnismenge einbinden. Default ist FALSE.", "required": false, "schema": {"type": "boolean"} }, { "name": "lastUpdated", "in": "query", "description": "Geändert seit diesem Datum", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "selectAttributes", "in": "query", "description": "Attribute des Objektes die ausgegeben werden sollen", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "structuralKey", "parentStructuralKey", "displayName", "uniqueName", "ags", "rs", "vnr", "otnr", "postalCodes", "population", "dataSource", "parent", "areaType", "geoCodingShapes" ] } } }, { "name": "sort", "in": "query", "description": "Name des Attributes nach dem sortiert werden soll", "required": false, "schema": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "structuralKey", "parentStructuralKey", "displayName", "uniqueName", "ags", "rs", "vnr", "otnr", "postalCodes", "population" ] } }, { "name": "sortdescending", "in": "query", "description": "Absteigende Sortierung festlegen. Standard ist false.", "required": false, "schema": {"type": "boolean"} } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/PoliticalAreaTreeNode"} } } }, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, "/PoliticalArea/{bl}/{infoserviceId}": { "get": { "tags": ["PoliticalAreaResource"], "summary": "show", "description": "Gibt das verwaltungspolitische Gebiet anhand seiner Bundeslandürzel und der Id aus den Infodiensten zurück.", "operationId": "PoliticalAreaResourceShow_1", "parameters": [ { "name": "bl", "in": "path", "description": "Bundeslandkürzel (z.b. st für Sachsen-Anhalt, bb für Brandenburg)", "required": true, "schema": { "type": "string", "enum": [ "bb", "he", "mv", "ni", "nw", "rp", "sh", "st", "th" ] } }, { "name": "infoserviceId", "in": "path", "description": "("Alte") Id des Gebiets in den Infodiensten", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "selectAttributes", "in": "query", "description": "Attribute des Objektes die ausgegeben werden sollen", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "structuralKey", "parentStructuralKey", "displayName", "uniqueName", "ags", "rs", "vnr", "otnr", "postalCodes", "population", "dataSource", "parent", "areaType", "geoCodingShapes" ] } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/PoliticalArea"} } } }, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, "/PoliticalArea/{bl}/{infoserviceId}/structure": { "get": { "tags": ["PoliticalAreaResource"], "summary": "structure", "description": "Gibt die Struktur des verwaltungspolitischen Gebietes zurück. Die Struktur kann nach Gebietstypen gefiltert werden.", "operationId": "PoliticalAreaResourceStructure_1", "parameters": [ { "name": "bl", "in": "path", "description": "Bundeslandkürzel (z.b. 15 für Sachsen-Anhalt)", "required": true, "schema": { "type": "string", "enum": [ "bb", "he", "mv", "ni", "nw", "rp", "sh", "st", "th" ] } }, { "name": "infoserviceId", "in": "path", "description": "("Alte") Id des Gebiets in den Infodiensten", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "areaTypes", "in": "query", "description": "zulässige Gebietstypen im Ergebnis", "required": false, "schema": { "type": "array", "items": {"type": "string"} } }, { "name": "includeDeactivatedAreas", "in": "query", "description": "Deaktivierte Gebiete (validFrom,validTo nicht im aktuellen Zeitraum) in Ergebnismenge einbinden. Default ist FALSE.", "required": false, "schema": {"type": "boolean"} }, { "name": "lastUpdated", "in": "query", "description": "Geändert seit diesem Datum", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "selectAttributes", "in": "query", "description": "Attribute des Objektes die ausgegeben werden sollen", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "structuralKey", "parentStructuralKey", "displayName", "uniqueName", "ags", "rs", "vnr", "otnr", "postalCodes", "population", "dataSource", "parent", "areaType", "geoCodingShapes" ] } } }, { "name": "sort", "in": "query", "description": "Name des Attributes nach dem sortiert werden soll", "required": false, "schema": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "structuralKey", "parentStructuralKey", "displayName", "uniqueName", "ags", "rs", "vnr", "otnr", "postalCodes", "population" ] } }, { "name": "sortdescending", "in": "query", "description": "Absteigende Sortierung festlegen. Standard ist false.", "required": false, "schema": {"type": "boolean"} } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/PoliticalAreaTreeNode"} } } }, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, "/PoliticalArea/search": { "get": { "tags": ["PoliticalAreaResource"], "summary": "search", "description": "Gibt alle verwaltungspolitischen Gebiete anhand von Suchbegriffen zurück.", "operationId": "PoliticalAreaResourceSearch", "parameters": [ { "name": "searchTypes", "in": "query", "description": "Spezielle vordefinierte Schlüsselwörter zur Einschränkung der Gebiete. ADDRESSABLE - nur addressierbare Orte, COMMUNEDISTRICT - GemeindeTeile, MUNICIPAL_ASSOCIATION - Gemeindeverband", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "ADDRESSABLE", "COMMUNEDISTRICT", "MUNICIPAL_ASSOCIATION" ] } } }, { "name": "searchWords", "in": "query", "description": "Suchbegriffe (RegEx: '[a-zA-ZäöüÄÖÜß]+|[0-9]{2,5}', Wildcards: '*' oder '%'). Es können auch Postleitzahlen als Suchbegriffe verwendet werden. Es wird in den Eigenschaften name, displayName und postalCodes gesucht. Suchbegriffe dürfen entweder aus Wörtern, ohne Sonderzeichen, Leerzeichen und Ziffern bestehen, oder nur aus Ziffern.", "required": false, "schema": { "type": "array", "items": {"type": "string"} } }, { "name": "startAreaId", "in": "query", "description": "Startkonten von denen aus nach unten (Richtung: Welt -> Gemeindeteil) gesucht wird", "required": false, "schema": { "type": "array", "items": {"type": "string"} } }, { "name": "areaTypes", "in": "query", "description": "zulässige Gebietstypen im Ergebnis", "required": false, "schema": { "type": "array", "items": {"type": "string"} } }, { "name": "includeDeactivatedAreas", "in": "query", "description": "Deaktivierte Gebiete (validFrom,validTo nicht im aktuellen Zeitraum) in Ergebnismenge einbinden. Default ist FALSE.", "required": false, "schema": {"type": "boolean"} }, { "name": "lastUpdated", "in": "query", "description": "Geändert seit diesem Datum", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "selectAttributes", "in": "query", "description": "Attribute des Objektes die ausgegeben werden sollen", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "structuralKey", "parentStructuralKey", "displayName", "uniqueName", "ags", "rs", "vnr", "otnr", "postalCodes", "population", "dataSource", "parent", "areaType", "geoCodingShapes" ] } } }, { "name": "sort", "in": "query", "description": "Name des Attributes nach dem sortiert werden soll", "required": false, "schema": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "structuralKey", "parentStructuralKey", "displayName", "uniqueName", "ags", "rs", "vnr", "otnr", "postalCodes", "population" ] } }, { "name": "sortdescending", "in": "query", "description": "Absteigende Sortierung festlegen. Standard ist false.", "required": false, "schema": {"type": "boolean"} }, { "name": "offset", "in": "query", "description": "Startposition der Teilmenge der Ergebnismenge.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Anzahl der Teilmenge der Ergebnismenge. Maximum ist 500.", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/ResultObjectCollectionPoliticalArea"} } } }, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, "/PoliticalArea/getByRs": { "get": { "tags": ["PoliticalAreaResource"], "summary": "showByRs", "description": "Gibt das verwaltungspolitische Gebiet anhand des Regionalschlüssels (RS) zurück. ", "operationId": "PoliticalAreaResourceShowByRs", "parameters": [ { "name": "rs", "in": "query", "description": "Regionalschlüssel (Wildcards: '*' oder '%')", "required": false, "schema": {"type": "string"} }, { "name": "includeCommuneDistrict", "in": "query", "description": "Ortsteile in Ergebnismenge einbinden. Default ist FALSE.", "required": false, "schema": {"type": "boolean"} }, { "name": "includeDeactivatedAreas", "in": "query", "description": "Deaktivierte Gebiete (validFrom,validTo nicht im aktuellen Zeitraum) in Ergebnismenge einbinden. Default ist FALSE.", "required": false, "schema": {"type": "boolean"} }, { "name": "lastUpdated", "in": "query", "description": "Geändert seit diesem Datum", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "selectAttributes", "in": "query", "description": "Attribute des Objektes die ausgegeben werden sollen", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "structuralKey", "parentStructuralKey", "displayName", "uniqueName", "ags", "rs", "vnr", "otnr", "postalCodes", "population", "dataSource", "parent", "areaType", "geoCodingShapes" ] } } }, { "name": "sort", "in": "query", "description": "Name des Attributes nach dem sortiert werden soll", "required": false, "schema": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "structuralKey", "parentStructuralKey", "displayName", "uniqueName", "ags", "rs", "vnr", "otnr", "postalCodes", "population" ] } }, { "name": "sortdescending", "in": "query", "description": "Absteigende Sortierung festlegen. Standard ist false.", "required": false, "schema": {"type": "boolean"} }, { "name": "offset", "in": "query", "description": "Startposition der Teilmenge der Ergebnismenge.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Anzahl der Teilmenge der Ergebnismenge. Maximum ist 500.", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/ResultObjectCollectionPoliticalArea"} } } }, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, "/PoliticalArea/getByPostalCode": { "get": { "tags": ["PoliticalAreaResource"], "summary": "showByPostalCode", "description": "Gibt das verwaltungspolitische Gebiet anhand der Postleitzahl zurück. ", "operationId": "PoliticalAreaResourceShowByPostalCode", "parameters": [ { "name": "postalCode", "in": "query", "description": "Postleitzahl (Wildcards: '*' oder '%')", "required": false, "schema": {"type": "string"} }, { "name": "includeCommuneDistrict", "in": "query", "description": "Ortsteile in Ergebnismenge einbinden. Default ist FALSE.", "required": false, "schema": {"type": "boolean"} }, { "name": "includeDeactivatedAreas", "in": "query", "description": "Deaktivierte Gebiete (validFrom,validTo nicht im aktuellen Zeitraum) in Ergebnismenge einbinden. Default ist FALSE.", "required": false, "schema": {"type": "boolean"} }, { "name": "lastUpdated", "in": "query", "description": "Geändert seit diesem Datum", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "selectAttributes", "in": "query", "description": "Attribute des Objektes die ausgegeben werden sollen", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "structuralKey", "parentStructuralKey", "displayName", "uniqueName", "ags", "rs", "vnr", "otnr", "postalCodes", "population", "dataSource", "parent", "areaType", "geoCodingShapes" ] } } }, { "name": "sort", "in": "query", "description": "Name des Attributes nach dem sortiert werden soll", "required": false, "schema": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "structuralKey", "parentStructuralKey", "displayName", "uniqueName", "ags", "rs", "vnr", "otnr", "postalCodes", "population" ] } }, { "name": "sortdescending", "in": "query", "description": "Absteigende Sortierung festlegen. Standard ist false.", "required": false, "schema": {"type": "boolean"} }, { "name": "offset", "in": "query", "description": "Startposition der Teilmenge der Ergebnismenge.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Anzahl der Teilmenge der Ergebnismenge. Maximum ist 500.", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/ResultObjectCollectionPoliticalArea"} } } }, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, "/PoliticalArea/getByAgs": { "get": { "tags": ["PoliticalAreaResource"], "summary": "showByAgs", "description": "Gibt das verwaltungspolitische Gebiet anhand des Amtlichen Gemeindeschlüssels (AGS) zurück. ", "operationId": "PoliticalAreaResourceShowByAgs", "parameters": [ { "name": "ags", "in": "query", "description": "Amtlicher Gemeindeschlüssel (Wildcards: '*' oder '%')", "required": false, "schema": {"type": "string"} }, { "name": "includeCommuneDistrict", "in": "query", "description": "Ortsteile in Ergebnismenge einbinden. Default ist FALSE.", "required": false, "schema": {"type": "boolean"} }, { "name": "includeDeactivatedAreas", "in": "query", "description": "Deaktivierte Gebiete (validFrom,validTo nicht im aktuellen Zeitraum) in Ergebnismenge einbinden. Default ist FALSE.", "required": false, "schema": {"type": "boolean"} }, { "name": "lastUpdated", "in": "query", "description": "Geändert seit diesem Datum", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "selectAttributes", "in": "query", "description": "Attribute des Objektes die ausgegeben werden sollen", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "structuralKey", "parentStructuralKey", "displayName", "uniqueName", "ags", "rs", "vnr", "otnr", "postalCodes", "population", "dataSource", "parent", "areaType", "geoCodingShapes" ] } } }, { "name": "sort", "in": "query", "description": "Name des Attributes nach dem sortiert werden soll", "required": false, "schema": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "structuralKey", "parentStructuralKey", "displayName", "uniqueName", "ags", "rs", "vnr", "otnr", "postalCodes", "population" ] } }, { "name": "sortdescending", "in": "query", "description": "Absteigende Sortierung festlegen. Standard ist false.", "required": false, "schema": {"type": "boolean"} }, { "name": "offset", "in": "query", "description": "Startposition der Teilmenge der Ergebnismenge.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Anzahl der Teilmenge der Ergebnismenge. Maximum ist 500.", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/ResultObjectCollectionPoliticalArea"} } } }, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, "/PoliticalArea/getAreaTree": { "get": { "tags": ["PoliticalAreaResource"], "summary": "showAreaTree", "description": "Gibt den Gebietsbaum vom angegebenen Startpunkt (rootId) bis zu den durch areaIds angegebenen Gebieten zurück. Startpunkt ist 'Welt', falls rootId nicht angegeben wird.", "operationId": "PoliticalAreaResourceShowAreaTree", "parameters": [ { "name": "rootId", "in": "query", "description": "Id des Startknoten", "required": false, "schema": {"type": "string"} }, { "name": "areaIds", "in": "query", "description": "IDs der Zielknoten des Gebietsbaums", "required": false, "schema": { "type": "array", "items": {"type": "string"} } }, { "name": "areaTypes", "in": "query", "description": "zulässige Gebietstypen im Ergebnis", "required": false, "schema": { "type": "array", "items": {"type": "string"} } }, { "name": "includeDeactivatedAreas", "in": "query", "description": "Deaktivierte Gebiete (validFrom, validTo nicht im aktuellen Zeitraum) in Ergebnismenge einbinden. Default ist FALSE.", "required": false, "schema": {"type": "boolean"} }, { "name": "lastUpdated", "in": "query", "description": "Geändert seit diesem Datum", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "selectAttributes", "in": "query", "description": "Attribute des Objektes die ausgegeben werden sollen", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "structuralKey", "parentStructuralKey", "displayName", "uniqueName", "ags", "rs", "vnr", "otnr", "postalCodes", "population", "dataSource", "parent", "areaType", "geoCodingShapes" ] } } }, { "name": "sort", "in": "query", "description": "Name des Attributes nach dem sortiert werden soll", "required": false, "schema": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "structuralKey", "parentStructuralKey", "displayName", "uniqueName", "ags", "rs", "vnr", "otnr", "postalCodes", "population" ] } }, { "name": "sortdescending", "in": "query", "description": "Absteigende Sortierung festlegen. Standard ist false.", "required": false, "schema": {"type": "boolean"} } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/PoliticalAreaTreeNode"} } } }, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, "/PoliticalArea/findByIds": { "get": { "tags": ["PoliticalAreaResource"], "summary": "findByIds", "description": "Gibt die verwaltungspolitischen Gebiete anhand ihrer IDs zurück.", "operationId": "PoliticalAreaResourceFindByIds", "parameters": [ { "name": "ids", "in": "query", "description": "IDs der Gebiete", "required": false, "schema": { "type": "array", "items": {"type": "string"} } }, { "name": "lastUpdated", "in": "query", "description": "Geändert seit diesem Datum", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "selectAttributes", "in": "query", "description": "Attribute des Objektes die ausgegeben werden sollen", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "structuralKey", "parentStructuralKey", "displayName", "uniqueName", "ags", "rs", "vnr", "otnr", "postalCodes", "population", "dataSource", "parent", "areaType", "geoCodingShapes" ] } } }, { "name": "sort", "in": "query", "description": "Name des Attributes nach dem sortiert werden soll", "required": false, "schema": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "structuralKey", "parentStructuralKey", "displayName", "uniqueName", "ags", "rs", "vnr", "otnr", "postalCodes", "population" ] } }, { "name": "sortdescending", "in": "query", "description": "Absteigende Sortierung festlegen. Standard ist false.", "required": false, "schema": {"type": "boolean"} }, { "name": "offset", "in": "query", "description": "Startposition der Teilmenge der Ergebnismenge.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Anzahl der Teilmenge der Ergebnismenge. Maximum ist 500.", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/ResultObjectCollectionPoliticalArea"} } } }, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, "/PoliticalArea/calculateDistances": { "get": { "tags": ["PoliticalAreaResource"], "summary": "calcDistances", "description": "Gibt die Liste der relevanten Gebiete, sortiert nach der Entfernung zum Ausgangsort zurück.", "operationId": "PoliticalAreaResourceCalcDistances", "parameters": [ { "name": "id", "in": "query", "description": "Gebiets-ID des Ausgangsortes", "required": false, "schema": {"type": "string"} }, { "name": "relevantAreaIds", "in": "query", "description": "List von Gebiets-IDs relevanter Orte (Zielorte)", "required": false, "schema": { "type": "array", "items": {"type": "string"} } }, { "name": "selectAttributes", "in": "query", "description": "Attribute des Objektes die ausgegeben werden sollen", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "distance" ] } } }, { "name": "sort", "in": "query", "description": "Name des Attributes nach dem sortiert werden soll", "required": false, "schema": { "type": "string", "enum": [ "id", "distance" ] } }, { "name": "sortdescending", "in": "query", "description": "Absteigende Sortierung festlegen. Standard ist false.", "required": false, "schema": {"type": "boolean"} }, { "name": "offset", "in": "query", "description": "Startposition der Teilmenge der Ergebnismenge.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Anzahl der Teilmenge der Ergebnismenge. Maximum ist 500.", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/PoliticalAreaDistance"} } } } }, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, "/GeographicalArea": { "get": { "tags": ["GeographicalAreaResource"], "summary": "showAll", "description": "Gibt alle geografischen Gebiete zurück.", "operationId": "GeographicalAreaResourceShowAll", "parameters": [ { "name": "includeDeactivatedAreas", "in": "query", "description": "Deaktivierte Gebiete (validFrom,validTo nicht im aktuellen Zeitraum) in Ergebnismenge einbinden. Default ist FALSE.", "required": false, "schema": {"type": "boolean"} }, { "name": "lastUpdated", "in": "query", "description": "Geändert seit diesem Datum", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "selectAttributes", "in": "query", "description": "Attribute des Objektes die ausgegeben werden sollen", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "secondaryId", "synonyms", "dataSource", "parent", "areaType" ] } } }, { "name": "sort", "in": "query", "description": "Name des Attributes nach dem sortiert werden soll", "required": false, "schema": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "secondaryId", "synonyms" ] } }, { "name": "sortdescending", "in": "query", "description": "Absteigende Sortierung festlegen. Standard ist false.", "required": false, "schema": {"type": "boolean"} }, { "name": "offset", "in": "query", "description": "Startposition der Teilmenge der Ergebnismenge.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Anzahl der Teilmenge der Ergebnismenge. Maximum ist 500.", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/ResultObjectCollectionGeographicalArea"} } } }, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, "/GeographicalArea/{id}": { "get": { "tags": ["GeographicalAreaResource"], "summary": "show", "description": "Gibt das geografische Gebiet anhand seiner Id zurück.", "operationId": "GeographicalAreaResourceShow", "parameters": [ { "name": "id", "in": "path", "description": "Id des Gebietes.", "required": true, "schema": {"type": "string"} }, { "name": "selectAttributes", "in": "query", "description": "Attribute des Objektes die ausgegeben werden sollen", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "secondaryId", "synonyms", "dataSource", "parent", "areaType" ] } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/GeographicalArea"} } } }, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, "/GeographicalArea/{id}/structure": { "get": { "tags": ["GeographicalAreaResource"], "summary": "structure", "description": "Gibt die Struktur des geografischen Gebietes zurück. Die Struktur kann nach Gebietstypen gefiltert werden.", "operationId": "GeographicalAreaResourceStructure", "parameters": [ { "name": "id", "in": "path", "description": "Id des Startknoten der Struktur", "required": true, "schema": {"type": "string"} }, { "name": "areaTypes", "in": "query", "description": "Erlaubte Gebietstypen in der Struktur. Leer entpriccht alle ", "required": false, "schema": { "type": "array", "items": {"type": "string"} } }, { "name": "includeDeactivatedAreas", "in": "query", "description": "Deaktivierte Gebiete (validFrom,validTo nicht im aktuellen Zeitraum) in Ergebnismenge einbinden. Default ist FALSE.", "required": false, "schema": {"type": "boolean"} }, { "name": "lastUpdated", "in": "query", "description": "Geändert seit diesem Datum", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "selectAttributes", "in": "query", "description": "Attribute des Objektes die ausgegeben werden sollen", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "secondaryId", "synonyms", "dataSource", "parent", "areaType" ] } } }, { "name": "sort", "in": "query", "description": "Name des Attributes nach dem sortiert werden soll", "required": false, "schema": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "secondaryId", "synonyms" ] } }, { "name": "sortdescending", "in": "query", "description": "Absteigende Sortierung festlegen. Standard ist false.", "required": false, "schema": {"type": "boolean"} } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/GeographicalAreaTreeNode"} } } }, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, "/GeographicalArea/{id}/geoCodings": { "get": { "tags": ["GeographicalAreaResource"], "summary": "showGeoCodings", "description": "Gibt die Geo-Codings des geografischen Gebietes zurück.", "operationId": "GeographicalAreaResourceShowGeoCodings", "parameters": [ { "name": "id", "in": "path", "description": "Id des Gebietes.", "required": true, "schema": {"type": "string"} }, { "name": "selectAttributes", "in": "query", "description": "Attribute des Objektes die ausgegeben werden sollen", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "geoCodingShapes" ] } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/GeographicalAreaGeoCodingsDTO"} } } }, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, "/GeographicalArea/search": { "get": { "tags": ["GeographicalAreaResource"], "summary": "search", "description": "Gibt alle geografischen Gebiete anhand der Suchkriterien zurück.", "operationId": "GeographicalAreaResourceSearch", "parameters": [ { "name": "searchTypes", "in": "query", "description": "Spezielle vordefinierte Schlüsselwörter zur Einschränkung der Gebiete", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": ["SHAPE"] } } }, { "name": "searchWords", "in": "query", "description": "Suchbegriffe (RegEx: '[a-zA-ZäöüÄÖÜß]+|[0-9]{2,5}', Wildcards: '*' oder '%'). Es können auch Postleitzahlen als Suchbegriffe verwendet werden. Es wird in den Eigenschaften name, displayName und postalCodes gesucht. Suchbegriffe dürfen entweder aus Wörtern, ohne Sonderzeichen, Leerzeichen und Ziffern bestehen, oder nur aus Ziffern.", "required": false, "schema": { "type": "array", "items": {"type": "string"} } }, { "name": "startArea", "in": "query", "description": "Startkonten von denen aus nach unten (Richtung: Welt -> Gemeindeteil) gesucht wird", "required": false, "schema": { "type": "array", "items": {"type": "string"} } }, { "name": "includeDeactivatedAreas", "in": "query", "description": "Deaktivierte Gebiete (validFrom,validTo nicht im aktuellen Zeitraum) in Ergebnismenge einbinden. Default ist FALSE.", "required": false, "schema": {"type": "boolean"} }, { "name": "lastUpdated", "in": "query", "description": "Geändert seit diesem Datum", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "selectAttributes", "in": "query", "description": "Attribute des Objektes die ausgegeben werden sollen", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "secondaryId", "synonyms", "dataSource", "parent", "areaType" ] } } }, { "name": "sort", "in": "query", "description": "Name des Attributes nach dem sortiert werden soll", "required": false, "schema": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "secondaryId", "synonyms" ] } }, { "name": "sortdescending", "in": "query", "description": "Absteigende Sortierung festlegen. Standard ist false.", "required": false, "schema": {"type": "boolean"} }, { "name": "offset", "in": "query", "description": "Startposition der Teilmenge der Ergebnismenge.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Anzahl der Teilmenge der Ergebnismenge. Maximum ist 500.", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/ResultObjectCollectionGeographicalArea"} } } }, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, "/GeographicalArea/getAreaTree": { "get": { "tags": ["GeographicalAreaResource"], "summary": "showAreaTree", "description": "Gibt den Gebietsbaum vom angegebenen Startpunkt (rootId) bis zu den durch areaIds angegebenen Gebieten zurück. Startpunkt ist 'Welt', falls rootId nicht angegeben wird.", "operationId": "GeographicalAreaResourceShowAreaTree", "parameters": [ { "name": "rootId", "in": "query", "description": "Id des Startknoten", "required": false, "schema": {"type": "string"} }, { "name": "areaIds", "in": "query", "description": "IDs der Zielknoten des Gebietsbaums", "required": false, "schema": { "type": "array", "items": {"type": "string"} } }, { "name": "areaTypes", "in": "query", "description": "zulässige Gebietstypen im Ergebnis", "required": false, "schema": { "type": "array", "items": {"type": "string"} } }, { "name": "includeDeactivatedAreas", "in": "query", "description": "Deaktivierte Gebiete (validFrom, validTo nicht im aktuellen Zeitraum) in Ergebnismenge einbinden. Default ist FALSE.", "required": false, "schema": {"type": "boolean"} }, { "name": "lastUpdated", "in": "query", "description": "Geändert seit diesem Datum", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "selectAttributes", "in": "query", "description": "Attribute des Objektes die ausgegeben werden sollen", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "secondaryId", "synonyms", "dataSource", "parent", "areaType" ] } } }, { "name": "sort", "in": "query", "description": "Name des Attributes nach dem sortiert werden soll", "required": false, "schema": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "secondaryId", "synonyms" ] } }, { "name": "sortdescending", "in": "query", "description": "Absteigende Sortierung festlegen. Standard ist false.", "required": false, "schema": {"type": "boolean"} }, { "name": "offset", "in": "query", "description": "Startposition der Teilmenge der Ergebnismenge.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Anzahl der Teilmenge der Ergebnismenge. Maximum ist 500.", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/GeographicalAreaTreeNode"} } } } }, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, "/GeographicalArea/findByIds": { "get": { "tags": ["GeographicalAreaResource"], "summary": "findByIds", "description": "Gibt die geographischen Gebiete anhand ihrer IDs zurück.", "operationId": "GeographicalAreaResourceFindByIds", "parameters": [ { "name": "ids", "in": "query", "description": "IDs der Gebiete", "required": false, "schema": { "type": "array", "items": {"type": "string"} } }, { "name": "lastUpdated", "in": "query", "description": "Geändert seit diesem Datum", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "selectAttributes", "in": "query", "description": "Attribute des Objektes die ausgegeben werden sollen", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "secondaryId", "synonyms", "dataSource", "parent", "areaType" ] } } }, { "name": "sort", "in": "query", "description": "Name des Attributes nach dem sortiert werden soll", "required": false, "schema": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "secondaryId", "synonyms" ] } }, { "name": "sortdescending", "in": "query", "description": "Absteigende Sortierung festlegen. Standard ist false.", "required": false, "schema": {"type": "boolean"} }, { "name": "offset", "in": "query", "description": "Startposition der Teilmenge der Ergebnismenge.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Anzahl der Teilmenge der Ergebnismenge. Maximum ist 500.", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/ResultObjectCollectionGeographicalArea"} } } }, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, "/GeographicalArea/findByGeoCoding": { "get": { "tags": ["GeographicalAreaResource"], "summary": "findByGeoCoding", "description": "Gibt alle geografischen Gebiete anhand eines Geocodings zurück", "operationId": "GeographicalAreaResourceFindByGeoCoding", "parameters": [ { "name": "coordinateX", "in": "query", "description": "X Koordiante des Geocodings", "required": true, "schema": { "type": "number", "format": "double" } }, { "name": "coordinateY", "in": "query", "description": "Y Koordiante des Geocodings", "required": true, "schema": { "type": "number", "format": "double" } }, { "name": "coordinateSystem", "in": "query", "description": "Das Koordinatensystem, welches das GeoCoding nutzt", "required": true, "schema": { "type": "string", "enum": [ "UNKNOWN", "EPSG31466", "EPSG31467", "EPSG31468", "EPSG25832", "EPSG25833", "EPSG4326", "EPSG2398", "EPSG900913", "EPSG3857", "EPSG5650" ] } }, { "name": "lastUpdated", "in": "query", "description": "Geändert seit diesem Datum", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "selectAttributes", "in": "query", "description": "Attribute des Objektes die ausgegeben werden sollen", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "secondaryId", "synonyms", "dataSource", "parent", "areaType" ] } } }, { "name": "sort", "in": "query", "description": "Name des Attributes nach dem sortiert werden soll", "required": false, "schema": { "type": "string", "enum": [ "id", "name", "nameShort", "description", "sourceId", "validFrom", "validTo", "lastUpdated", "secondaryId", "synonyms" ] } }, { "name": "sortdescending", "in": "query", "description": "Absteigende Sortierung festlegen. Standard ist false.", "required": false, "schema": {"type": "boolean"} }, { "name": "offset", "in": "query", "description": "Startposition der Teilmenge der Ergebnismenge.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Anzahl der Teilmenge der Ergebnismenge. Maximum ist 500.", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/ResultObjectCollectionGeographicalArea"} } } }, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, "/Verification/getByGeoCoding": { "get": { "tags": ["VerificationResource"], "summary": "getByGeoCoding", "operationId": "VerificationResourceGetByGeoCoding", "parameters": [ { "name": "coordinateX", "in": "query", "description": "X Koordinate des Geo-Codings", "required": true, "schema": { "type": "number", "format": "double" } }, { "name": "coordinateY", "in": "query", "description": "Y Koordinate des Geo-Codings", "required": true, "schema": { "type": "number", "format": "double" } }, { "name": "coordinateSystem", "in": "query", "description": "Das Koordinatensystem, welches das Geo-Coding nutzt", "required": true, "schema": { "type": "string", "enum": [ "UNKNOWN", "EPSG31466", "EPSG31467", "EPSG31468", "EPSG25832", "EPSG25833", "EPSG4326", "EPSG2398", "EPSG900913", "EPSG3857", "EPSG5650" ] } }, { "name": "areaClass", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "Area", "PoliticalArea", "GeographicalArea" ] } }, { "name": "sortByDistance", "in": "query", "required": false, "schema": {"type": "boolean"} }, { "name": "lastUpdated", "in": "query", "description": "Geändert seit diesem Datum", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "radius", "in": "query", "description": "Radius in Metern", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "addressType", "in": "query", "description": "Detailgrad der gesuchten Angabe", "required": false, "schema": { "type": "string", "enum": [ "Address", "Street", "Locality", "Postal_Code", "Geoname" ] } }, { "name": "selectAttributes", "in": "query", "description": "Attribute des Objektes die ausgegeben werden sollen", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "displayName", "nameShort", "postalCodes", "ags", "rs", "areaType", "areaClass", "addresses" ] } } }, { "name": "sort", "in": "query", "description": "Name des Attributes nach dem sortiert werden soll", "required": false, "schema": { "type": "string", "enum": [ "id", "name", "displayName", "nameShort", "postalCodes", "ags", "rs" ] } }, { "name": "sortdescending", "in": "query", "description": "Absteigende Sortierung festlegen. Standard ist false.", "required": false, "schema": {"type": "boolean"} }, { "name": "offset", "in": "query", "description": "Startposition der Teilmenge der Ergebnismenge.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Anzahl der Teilmenge der Ergebnismenge. Maximum ist 500.", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/ResultObjectCollectionVerificationAreaDTO"} } } }, "400": { "description": "Conflict", "content": { "application/json": { "schema": { "properties": { "message": {} } } } } }, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, "/Verification/getByAddress": { "get": { "tags": ["VerificationResource"], "summary": "getByAddress", "operationId": "VerificationResourceGetByAddress", "parameters": [ { "name": "areaId", "in": "query", "description": "Gebiet-Id", "required": false, "schema": {"type": "string"} }, { "name": "areaName", "in": "query", "description": "Ortsname", "required": false, "schema": {"type": "string"} }, { "name": "street", "in": "query", "description": "Straße", "required": false, "schema": {"type": "string"} }, { "name": "postalCode", "in": "query", "description": "Postleitzahl", "required": false, "schema": {"type": "string"} }, { "name": "houseNumber", "in": "query", "description": "Hausnummer", "required": false, "schema": {"type": "string"} }, { "name": "federalState", "in": "query", "description": "Bundesland", "required": false, "schema": { "type": "string", "enum": [ "Baden_Wuerttemberg", "Bayern", "Berlin", "Brandenburg", "Bremen", "Hamburg", "Hessen", "Mecklenburg_Vorpommern", "Niedersachsen", "Nordrhein_Westfalen", "Rheinland_Pfalz", "Saarland", "Sachsen", "Sachsen_Anhalt", "Schleswig_Holstein", "Thueringen" ] } }, { "name": "sortByDistance", "in": "query", "description": "Sortierung nach Distanz", "required": false, "schema": {"type": "boolean"} }, { "name": "lastUpdated", "in": "query", "description": "Geändert seit diesem Datum", "required": false, "schema": { "type": "string", "format": "date-time" } }, { "name": "selectAttributes", "in": "query", "description": "Attribute des Objektes die ausgegeben werden sollen", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "displayName", "nameShort", "postalCodes", "ags", "rs", "areaType", "areaClass", "addresses" ] } } }, { "name": "sort", "in": "query", "description": "Name des Attributes nach dem sortiert werden soll", "required": false, "schema": { "type": "string", "enum": [ "id", "name", "displayName", "nameShort", "postalCodes", "ags", "rs" ] } }, { "name": "sortdescending", "in": "query", "description": "Absteigende Sortierung festlegen. Standard ist false.", "required": false, "schema": {"type": "boolean"} }, { "name": "offset", "in": "query", "description": "Startposition der Teilmenge der Ergebnismenge.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Anzahl der Teilmenge der Ergebnismenge. Maximum ist 500.", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {"$ref": "#/components/schemas/ResultObjectCollectionVerificationAreaDTO"} } } }, "400": { "description": "Conflict", "content": { "application/json": { "schema": { "properties": { "message": {} } } } } }, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, "/AreaType/political": { "get": { "tags": ["AreaTypeResource"], "summary": "showAllPoliticalAreaTypes", "description": "Gibt alle bekannten Typen für Verwaltungspolitische Gebiete zurück.", "operationId": "AreaTypeResourceShowAllPoliticalAreaTypes", "parameters": [ { "name": "selectAttributes", "in": "query", "description": "Attribute des Objektes die ausgegeben werden sollen", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "shortName", "usedInState", "classification" ] } } }, { "name": "sort", "in": "query", "description": "Name des Attributes nach dem sortiert werden soll", "required": false, "schema": { "type": "string", "enum": [ "id", "name", "shortName", "usedInState", "classification" ] } }, { "name": "sortdescending", "in": "query", "description": "Absteigende Sortierung festlegen. Standard ist false.", "required": false, "schema": {"type": "boolean"} }, { "name": "offset", "in": "query", "description": "Startposition der Teilmenge der Ergebnismenge.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Anzahl der Teilmenge der Ergebnismenge. Maximum ist 500.", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/PoliticalAreaType"} } } } }, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, "/AreaType/geographical": { "get": { "tags": ["AreaTypeResource"], "summary": "showAllGeographicalAreaTypes", "description": "Gibt alle bekannten Typen für geografische Gebiete zurück.", "operationId": "AreaTypeResourceShowAllGeographicalAreaTypes", "parameters": [ { "name": "selectAttributes", "in": "query", "description": "Attribute des Objektes die ausgegeben werden sollen", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "shortName", "usedInState" ] } } }, { "name": "sort", "in": "query", "description": "Name des Attributes nach dem sortiert werden soll", "required": false, "schema": { "type": "string", "enum": [ "id", "name", "shortName", "usedInState" ] } }, { "name": "sortdescending", "in": "query", "description": "Absteigende Sortierung festlegen. Standard ist false.", "required": false, "schema": {"type": "boolean"} }, { "name": "offset", "in": "query", "description": "Startposition der Teilmenge der Ergebnismenge.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Anzahl der Teilmenge der Ergebnismenge. Maximum ist 500.", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/GeographicalAreaType"} } } } }, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } }, "/AreaClass": { "get": { "tags": ["AreaClassResource"], "summary": "showAllAreaClasses", "description": "Gibt alle Gebietsklassen aus", "operationId": "AreaClassResourceShowAllAreaClasses", "parameters": [ { "name": "selectAttributes", "in": "query", "description": "Attribute des Objektes die ausgegeben werden sollen", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "areaClassId", "name", "areaClassClass" ] } } }, { "name": "sort", "in": "query", "description": "Name des Attributes nach dem sortiert werden soll", "required": false, "schema": { "type": "string", "enum": [ "areaClassId", "name", "areaClassClass" ] } }, { "name": "sortdescending", "in": "query", "description": "Absteigende Sortierung festlegen. Standard ist false.", "required": false, "schema": {"type": "boolean"} }, { "name": "offset", "in": "query", "description": "Startposition der Teilmenge der Ergebnismenge.", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "Anzahl der Teilmenge der Ergebnismenge. Maximum ist 500.", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": {"$ref": "#/components/schemas/AreaClass"} } } } }, "401": {"description": "Unauthorized"}, "403": {"description": "Forbidden"}, "404": {"description": "Not Found"} } } } }, "components": { "schemas": { "GeoLocationDTO": { "type": "object", "properties": { "coordinateX": { "type": "number", "format": "double" }, "coordinateY": { "type": "number", "format": "double" }, "coordinateSystem": { "type": "string", "enum": [ "UNKNOWN", "EPSG31466", "EPSG31467", "EPSG31468", "EPSG25832", "EPSG25833", "EPSG4326", "EPSG2398", "EPSG900913", "EPSG3857", "EPSG5650" ] } }, "required": ["coordinateSystem"] }, "NamedReference": { "type": "object", "properties": { "type": {"type": "string"}, "name": {"type": "string"}, "refId": {"type": "string"}, "path": {"type": "string"} } }, "ResultObjectCollectionVerificationAreaDTO": { "type": "object", "properties": { "values": { "type": "array", "items": {"$ref": "#/components/schemas/VerificationAreaDTO"} }, "offset": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } } }, "VerificationAddressDTO": { "type": "object", "properties": { "name": {"type": "string"}, "street": {"type": "string"}, "houseNumber": {"type": "string"}, "district": {"type": "string"}, "postalCodes": { "type": "array", "description": "Postleitzahlen, in denen sich die Adresse befindet", "items": {"type": "string"} }, "source": {"type": "string"}, "addressType": { "type": "string", "enum": [ "Address", "Street", "Locality", "Postal_Code", "Geoname" ] }, "coordinates": {"$ref": "#/components/schemas/GeoLocationDTO"} }, "required": [ "addressType", "coordinates" ] }, "VerificationAreaDTO": { "type": "object", "properties": { "id": {"type": "string"}, "name": {"type": "string"}, "displayName": {"type": "string"}, "nameShort": {"type": "string"}, "postalCodes": { "type": "array", "description": "Alle Postleitzahlen des Gebietes", "items": {"type": "string"} }, "ags": {"type": "string"}, "rs": {"type": "string"}, "areaType": {"$ref": "#/components/schemas/NamedReference"}, "areaClass": {"$ref": "#/components/schemas/NamedReference"}, "addresses": { "type": "array", "items": {"$ref": "#/components/schemas/VerificationAddressDTO"}, "xml": {"wrapped": true} } }, "required": [ "areaClass", "areaType" ] }, "AreaHoleDTO": { "type": "object", "properties": { "geoCodings": { "type": "array", "items": {"$ref": "#/components/schemas/GeoCodingDTO"}, "xml": {"wrapped": true} } } }, "GeoCodingDTO": { "type": "object", "properties": { "coordinateX": { "type": "number", "format": "double", "description": "Breite" }, "coordinateY": { "type": "number", "format": "double", "description": "Länge" }, "altitude": { "type": "number", "format": "double", "description": "Höhe" } } }, "GeoCodingShapeDTO": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "MID_POINT", "AREA" ] }, "coordinateSystem": { "type": "string", "enum": [ "UNKNOWN", "EPSG31466", "EPSG31467", "EPSG31468", "EPSG25832", "EPSG25833", "EPSG4326", "EPSG2398", "EPSG900913", "EPSG3857", "EPSG5650" ] }, "geoCodings": { "type": "array", "items": {"$ref": "#/components/schemas/GeoCodingDTO"}, "xml": {"wrapped": true} }, "holes": { "type": "array", "items": {"$ref": "#/components/schemas/AreaHoleDTO"}, "xml": {"wrapped": true} } }, "required": [ "coordinateSystem", "type" ] }, "PoliticalArea": { "type": "object", "properties": { "id": { "type": "string", "description": "Eindeutige ID des Objektes im Gebietsservice" }, "name": { "type": "string", "description": "Bezeichnung" }, "nameShort": { "type": "string", "description": "Kurze Schreibweise der Bezeichnung" }, "description": { "type": "string", "description": "Beschreibung" }, "sourceId": { "type": "string", "description": "ID des Datensatzes in der Quelle" }, "validFrom": { "type": "string", "format": "date-time", "description": "Gültigkeit ab Zeitpunkt" }, "validTo": { "type": "string", "format": "date-time", "description": "Gültigkeit bis Zeitpunkt" }, "lastUpdated": { "type": "string", "description": "Letzte Aktualisierung" }, "dataSource": {"$ref": "#/components/schemas/NamedReference"}, "parent": {"$ref": "#/components/schemas/NamedReference"}, "areaType": {"$ref": "#/components/schemas/NamedReference"}, "structuralKey": { "type": "string", "description": "Schlüssel des Gebiets. Muss Extern vergeben werden. Für Synchronisation! Staat:Bundesland:Bezirk:Kreis:Verband:Gemeinde:Gemeindeteil XXX:XX:X:XX:XXXX:XXX:XXXX" }, "parentStructuralKey": { "type": "string", "description": "Verweis auf Parent Gebiet" }, "displayName": { "type": "string", "description": "Zu verwendender Anzeigename des Gebietes. Diese Eigenschaft ist immer gesetzt und wird aus der Eigenschaft 'Name' berechnet. Ortsteile werden z.B. mit vorangestellten Gemeindenamen berechnet." }, "uniqueName": { "type": "string", "description": "Diese Eigenschaft ist nur gesetzt, wenn der DisplayName des Gebiets nicht eindeutig ist." }, "ags": { "type": "string", "description": "Amtlicher Gemeindeschlüssel" }, "rs": { "type": "string", "description": "Regionalschlüssel" }, "vnr": { "type": "string", "description": "Verbandsschlüssel" }, "otnr": { "type": "string", "description": "Ortsteilnummer" }, "postalCodes": { "type": "array", "description": "Postleitzahlen", "items": {"type": "string"} }, "population": { "type": "integer", "format": "int64", "description": "Bevölkerungszahl" }, "geoCodingShapes": { "type": "array", "items": {"$ref": "#/components/schemas/GeoCodingShapeDTO"}, "uniqueItems": true, "xml": {"wrapped": true} } }, "required": ["areaType"], "xml": {"name": "PoliticalArea"} }, "ResultObjectCollectionPoliticalArea": { "type": "object", "properties": { "values": { "type": "array", "items": {"$ref": "#/components/schemas/PoliticalArea"} }, "offset": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } } }, "PoliticalAreaTreeNode": { "type": "object", "properties": { "id": { "type": "string", "description": "Eindeutige ID des Objektes im Gebietsservice" }, "name": { "type": "string", "description": "Bezeichnung" }, "nameShort": { "type": "string", "description": "Kurze Schreibweise der Bezeichnung" }, "description": { "type": "string", "description": "Beschreibung" }, "sourceId": { "type": "string", "description": "ID des Datensatzes in der Quelle" }, "validFrom": { "type": "string", "format": "date-time", "description": "Gültigkeit ab Zeitpunkt" }, "validTo": { "type": "string", "format": "date-time", "description": "Gültigkeit bis Zeitpunkt" }, "lastUpdated": { "type": "string", "description": "Letzte Aktualisierung" }, "dataSource": {"$ref": "#/components/schemas/NamedReference"}, "parent": {"$ref": "#/components/schemas/NamedReference"}, "areaType": {"$ref": "#/components/schemas/NamedReference"}, "structuralKey": { "type": "string", "description": "Schlüssel des Gebiets. Muss Extern vergeben werden. Für Synchronisation! Staat:Bundesland:Bezirk:Kreis:Verband:Gemeinde:Gemeindeteil XXX:XX:X:XX:XXXX:XXX:XXXX" }, "parentStructuralKey": { "type": "string", "description": "Verweis auf Parent Gebiet" }, "displayName": { "type": "string", "description": "Zu verwendender Anzeigename des Gebietes. Diese Eigenschaft ist immer gesetzt und wird aus der Eigenschaft 'Name' berechnet. Ortsteile werden z.B. mit vorangestellten Gemeindenamen berechnet." }, "uniqueName": { "type": "string", "description": "Diese Eigenschaft ist nur gesetzt, wenn der DisplayName des Gebiets nicht eindeutig ist." }, "ags": { "type": "string", "description": "Amtlicher Gemeindeschlüssel" }, "rs": { "type": "string", "description": "Regionalschlüssel" }, "vnr": { "type": "string", "description": "Verbandsschlüssel" }, "otnr": { "type": "string", "description": "Ortsteilnummer" }, "postalCodes": { "type": "array", "description": "Postleitzahlen", "items": {"type": "string"} }, "population": { "type": "integer", "format": "int64", "description": "Bevölkerungszahl" }, "geoCodingShapes": { "type": "array", "items": {"$ref": "#/components/schemas/GeoCodingShapeDTO"}, "uniqueItems": true, "xml": {"wrapped": true} }, "subAreas": { "type": "array", "items": {"$ref": "#/components/schemas/PoliticalAreaTreeNode"}, "xml": {"wrapped": true} } }, "required": ["areaType"], "xml": {"name": "PoliticalAreaTreeNode"} }, "PoliticalAreaDistance": { "type": "object", "properties": { "id": { "type": "string", "description": "Gebiets-ID" }, "distance": { "type": "number", "format": "double", "description": "Entfernung zum Ausgangsort in km" } }, "xml": {"name": "PoliticalAreaDistance"} }, "GeographicalArea": { "type": "object", "properties": { "id": { "type": "string", "description": "Eindeutige ID des Objektes im Gebietsservice" }, "name": { "type": "string", "description": "Bezeichnung" }, "nameShort": { "type": "string", "description": "Kurze Schreibweise der Bezeichnung" }, "description": { "type": "string", "description": "Beschreibung" }, "sourceId": { "type": "string", "description": "ID des Datensatzes in der Quelle" }, "validFrom": { "type": "string", "format": "date-time", "description": "Gültigkeit ab Zeitpunkt" }, "validTo": { "type": "string", "format": "date-time", "description": "Gültigkeit bis Zeitpunkt" }, "lastUpdated": { "type": "string", "description": "Letzte Aktualisierung" }, "dataSource": {"$ref": "#/components/schemas/NamedReference"}, "parent": {"$ref": "#/components/schemas/NamedReference"}, "areaType": {"$ref": "#/components/schemas/NamedReference"}, "secondaryId": { "type": "string", "description": "Kennung" }, "synonyms": { "type": "array", "items": {"type": "string"} } }, "required": ["areaType"], "xml": {"name": "GeographicalArea"} }, "ResultObjectCollectionGeographicalArea": { "type": "object", "properties": { "values": { "type": "array", "items": {"$ref": "#/components/schemas/GeographicalArea"} }, "offset": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } } }, "GeographicalAreaTreeNode": { "type": "object", "properties": { "id": { "type": "string", "description": "Eindeutige ID des Objektes im Gebietsservice" }, "name": { "type": "string", "description": "Bezeichnung" }, "nameShort": { "type": "string", "description": "Kurze Schreibweise der Bezeichnung" }, "description": { "type": "string", "description": "Beschreibung" }, "sourceId": { "type": "string", "description": "ID des Datensatzes in der Quelle" }, "validFrom": { "type": "string", "format": "date-time", "description": "Gültigkeit ab Zeitpunkt" }, "validTo": { "type": "string", "format": "date-time", "description": "Gültigkeit bis Zeitpunkt" }, "lastUpdated": { "type": "string", "description": "Letzte Aktualisierung" }, "dataSource": {"$ref": "#/components/schemas/NamedReference"}, "parent": {"$ref": "#/components/schemas/NamedReference"}, "areaType": {"$ref": "#/components/schemas/NamedReference"}, "secondaryId": { "type": "string", "description": "Kennung" }, "synonyms": { "type": "array", "items": {"type": "string"} }, "subAreas": { "type": "array", "items": {"$ref": "#/components/schemas/GeographicalAreaTreeNode"}, "xml": {"wrapped": true} } }, "required": ["areaType"], "xml": {"name": "GeographicalAreaTreeNode"} }, "GeographicalAreaGeoCodingsDTO": { "type": "object", "properties": { "id": { "type": "string", "description": "Eindeutige ID des Objektes im Gebietsservice" }, "name": { "type": "string", "description": "Bezeichnung" }, "geoCodingShapes": { "type": "array", "items": {"$ref": "#/components/schemas/GeoCodingShapeDTO"}, "uniqueItems": true, "xml": {"wrapped": true} } }, "xml": {"name": "GeographicalAreaGeoCodings"} }, "PoliticalAreaType": { "type": "object", "properties": { "id": { "type": "string", "description": "Eindeutige ID des Objektes im Gebietsservice" }, "name": { "type": "string", "description": "Name des Gebietstyps" }, "shortName": { "type": "string", "description": "Kurzbezeichnung" }, "usedInState": { "type": "array", "description": "Bundeslandkürzel für die der Type gültig ist", "items": {"type": "string"} }, "classification": { "type": "array", "items": { "type": "string", "enum": [ "ADDRESSABLE", "COMMUNEDISTRICT", "MUNICIPAL_ASSOCIATION" ] } } }, "xml": {"name": "PoliticalAreaType"} }, "GeographicalAreaType": { "type": "object", "properties": { "id": { "type": "string", "description": "Eindeutige ID des Objektes im Gebietsservice" }, "name": { "type": "string", "description": "Name des Gebietstyps" }, "shortName": { "type": "string", "description": "Kurzbezeichnung" }, "usedInState": { "type": "array", "description": "Bundeslandkürzel für die der Type gültig ist", "items": {"type": "string"} } }, "xml": {"name": "GeographicalAreaType"} }, "AreaClass": { "type": "object", "properties": { "areaClassId": { "type": "string", "description": "Id aus AreaService" }, "name": { "type": "string", "description": "Name der AreaClass" }, "areaClassClass": { "type": "string", "description": "Subklasse des Gebiets" } }, "xml": {"name": "AreaClass"} }, "AreaClasses": { "type": "string", "description": "Liste aller Gebietsklassen", "enum": [ "Area", "PoliticalArea", "GeographicalArea" ] } }, "securitySchemes": { "api_key": { "type": "apiKey", "name": "api_key", "in": "header" } } } }