{ "openapi": "3.0.4", "info": { "title": "OpenPLZ API v1", "description": "Open Data API for street and postal code directories of Austria, Germany, Liechtenstein and Switzerland", "contact": { "name": "The OpenPLZ API Project", "url": "https://www.openplzapi.org" }, "license": { "name": "License", "url": "https://github.com/openpotato/openplzapi/blob/main/LICENSE" }, "version": "v1" }, "paths": { "/at/Districts/{key}/Localities": { "get": { "tags": [ "AT" ], "summary": "Returns all localities wihtin a district (Kreis).", "parameters": [ { "name": "key", "in": "path", "description": "Regional key of the district", "required": true, "schema": { "type": "string" }, "example": "701" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.LocalityResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.LocalityResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.LocalityResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.LocalityResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/at/Districts/{key}/Municipalities": { "get": { "tags": [ "AT" ], "summary": "Returns all municipalities (Gemeinden) within a district (Bezirk).", "parameters": [ { "name": "key", "in": "path", "description": "Key of the district", "required": true, "schema": { "type": "string" }, "example": "701" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.MunicipalityResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.MunicipalityResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.MunicipalityResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.MunicipalityResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/at/FederalProvinces": { "get": { "tags": [ "AT" ], "summary": "Returns all federal provinces (Bundesländer).", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.FederalProvinceResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.FederalProvinceResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.FederalProvinceResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.FederalProvinceResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/at/FederalProvinces/{key}/Districts": { "get": { "tags": [ "AT" ], "summary": "Returns all districts (Bezirke) within a federal province (Bundesland).", "parameters": [ { "name": "key", "in": "path", "description": "Key of the federal province", "required": true, "schema": { "type": "string" }, "example": "7" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.DistrictResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.DistrictResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.DistrictResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.DistrictResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/at/FederalProvinces/{key}/Localities": { "get": { "tags": [ "AT" ], "summary": "Returns all localities wihtin a federal province (Bundesland).", "parameters": [ { "name": "key", "in": "path", "description": "Regional key of the federal province", "required": true, "schema": { "type": "string" }, "example": "7" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.LocalityResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.LocalityResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.LocalityResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.LocalityResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/at/FederalProvinces/{key}/Municipalities": { "get": { "tags": [ "AT" ], "summary": "Returns all municipalities (Gemeinden) within a federal province (Bundesland).", "parameters": [ { "name": "key", "in": "path", "description": "Key of the federal province", "required": true, "schema": { "type": "string" }, "example": "7" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.MunicipalityResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.MunicipalityResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.MunicipalityResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.MunicipalityResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/at/FullTextSearch": { "get": { "tags": [ "AT" ], "summary": "Performs a full-text search using the street name, postal code and city.", "parameters": [ { "name": "searchTerm", "in": "query", "description": "Search term for full text search", "required": true, "schema": { "type": "string" }, "example": "1020 Wien Adambergergasse" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.StreetResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.StreetResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.StreetResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.StreetResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/at/Localities": { "get": { "tags": [ "AT" ], "summary": "Returns all localities whose postal code and/or name matches the given patterns.", "parameters": [ { "name": "postalCode", "in": "query", "description": "Postal code or regular expression", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name or regular expression", "schema": { "type": "string" }, "example": "Wien" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.LocalityResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.LocalityResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.LocalityResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.LocalityResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/at/Streets": { "get": { "tags": [ "AT" ], "summary": "Returns all streets whose name, postal code and/or name matches the given patterns.", "parameters": [ { "name": "name", "in": "query", "description": "Name or regular expression", "schema": { "type": "string" } }, { "name": "postalCode", "in": "query", "description": "Postal code or regular expression", "schema": { "type": "string" }, "example": "1020" }, { "name": "locality", "in": "query", "description": "Locality or regular expression", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.StreetResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.StreetResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.StreetResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.AT.StreetResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/ch/Cantons": { "get": { "tags": [ "CH" ], "summary": "Returns all cantons (Kantone).", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.CantonResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.CantonResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.CantonResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.CantonResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/ch/Cantons/{key}/Communes": { "get": { "tags": [ "CH" ], "summary": "Returns all communes (Gemeinden) within a canton (Kanton).", "parameters": [ { "name": "key", "in": "path", "description": "Key of the canton", "required": true, "schema": { "type": "string" }, "example": "10" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.CommuneResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.CommuneResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.CommuneResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.CommuneResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/ch/Cantons/{key}/Districts": { "get": { "tags": [ "CH" ], "summary": "Returns all districts (Bezirke) within a canton (Kanton).", "parameters": [ { "name": "key", "in": "path", "description": "Key of the canton", "required": true, "schema": { "type": "string" }, "example": "10" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.DistrictResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.DistrictResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.DistrictResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.DistrictResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/ch/Cantons/{key}/Localities": { "get": { "tags": [ "CH" ], "summary": "Returns all localities wihtin a canton (Kanton)", "parameters": [ { "name": "key", "in": "path", "description": "Regional key of the canton", "required": true, "schema": { "type": "string" }, "example": "7" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.LocalityResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.LocalityResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.LocalityResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.LocalityResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/ch/Districts/{key}/Communes": { "get": { "tags": [ "CH" ], "summary": "Returns all communes (Gemeinden) within a district (Bezirk).", "parameters": [ { "name": "key", "in": "path", "description": "Key of the district", "required": true, "schema": { "type": "string" }, "example": "1002" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.CommuneResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.CommuneResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.CommuneResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.CommuneResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/ch/Districts/{key}/Localities": { "get": { "tags": [ "CH" ], "summary": "Returns all localities wihtin a district (Kreis).", "parameters": [ { "name": "key", "in": "path", "description": "Regional key of the district", "required": true, "schema": { "type": "string" }, "example": "701" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.LocalityResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.LocalityResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.LocalityResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.LocalityResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/ch/FullTextSearch": { "get": { "tags": [ "CH" ], "summary": "Performs a full-text search using the street name, postal code and city.", "parameters": [ { "name": "searchTerm", "in": "query", "description": "Search term for full text search", "required": true, "schema": { "type": "string" }, "example": "8002 Zürich Bederstrasse" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.StreetResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.StreetResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.StreetResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.StreetResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/ch/Localities": { "get": { "tags": [ "CH" ], "summary": "Returns all localities whose postal code and/or name matches the given patterns.", "parameters": [ { "name": "postalCode", "in": "query", "description": "Postal code or regular expression", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name or regular expression", "schema": { "type": "string" }, "example": "Zürich" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.LocalityResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.LocalityResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.LocalityResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.LocalityResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/ch/Streets": { "get": { "tags": [ "CH" ], "summary": "Returns all streets whose name, postal code and/or name matches the given patterns.", "parameters": [ { "name": "name", "in": "query", "description": "Name or regular expression", "schema": { "type": "string" }, "example": "Bederstrasse" }, { "name": "postalCode", "in": "query", "description": "Postal code or regular expression", "schema": { "type": "string" }, "example": "8002" }, { "name": "locality", "in": "query", "description": "Locality or regular expression", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.StreetResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.StreetResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.StreetResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.CH.StreetResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/de/Districts/{key}/Localities": { "get": { "tags": [ "DE" ], "summary": "Returns all localities wihtin a district (Kreis).", "parameters": [ { "name": "key", "in": "path", "description": "Regional key of the district", "required": true, "schema": { "type": "string" }, "example": "09180" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.LocalityResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.LocalityResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.LocalityResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.LocalityResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/de/Districts/{key}/MunicipalAssociations": { "get": { "tags": [ "DE" ], "summary": "Returns all municipal associations (Gemeindeverbände) within a district (Kreis).", "parameters": [ { "name": "key", "in": "path", "description": "Regional key of the district", "required": true, "schema": { "type": "string" }, "example": "09180" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalAssociationResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalAssociationResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalAssociationResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalAssociationResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/de/Districts/{key}/Municipalities": { "get": { "tags": [ "DE" ], "summary": "Returns all municipalities (Gemeinden) within a district (Kreis).", "parameters": [ { "name": "key", "in": "path", "description": "Regional key of the district", "required": true, "schema": { "type": "string" }, "example": "09180" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalityResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalityResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalityResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalityResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/de/FederalStates": { "get": { "tags": [ "DE" ], "summary": "Returns all federal states (Bundesländer).", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.FederalStateResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.FederalStateResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.FederalStateResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.FederalStateResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/de/FederalStates/{key}/Districts": { "get": { "tags": [ "DE" ], "summary": "Returns all districts (Kreise) within a federal state (Bundesland).", "parameters": [ { "name": "key", "in": "path", "description": "Regional key of the federal state", "required": true, "schema": { "type": "string" }, "example": "09" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.DistrictResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.DistrictResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.DistrictResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.DistrictResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/de/FederalStates/{key}/GovernmentRegions": { "get": { "tags": [ "DE" ], "summary": "Returns all government regions (Regierungsbezirke) within a federal state (Bundesaland).", "parameters": [ { "name": "key", "in": "path", "description": "Regional key of the federal state", "required": true, "schema": { "type": "string" }, "example": "09" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.GovernmentRegionResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.GovernmentRegionResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.GovernmentRegionResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.GovernmentRegionResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/de/FederalStates/{key}/Localities": { "get": { "tags": [ "DE" ], "summary": "Returns all localities wihtin a federal state (Bundesland).", "parameters": [ { "name": "key", "in": "path", "description": "Regional key of the federal state", "required": true, "schema": { "type": "string" }, "example": "11" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.LocalityResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.LocalityResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.LocalityResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.LocalityResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/de/FederalStates/{key}/MunicipalAssociations": { "get": { "tags": [ "DE" ], "summary": "Returns all municipal associations (Gemeindeverbände) within a federal state (Bundesland).", "parameters": [ { "name": "key", "in": "path", "description": "Regional key of the federal state", "required": true, "schema": { "type": "string" }, "example": "09" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalAssociationResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalAssociationResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalAssociationResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalAssociationResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/de/FederalStates/{key}/Municipalities": { "get": { "tags": [ "DE" ], "summary": "Returns all municipalities (Gemeinden) within a federal state (Bundesland).", "parameters": [ { "name": "key", "in": "path", "description": "Regional key of the federal state", "required": true, "schema": { "type": "string" }, "example": "09" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalityResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalityResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalityResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalityResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/de/FullTextSearch": { "get": { "tags": [ "DE" ], "summary": "Performs a full-text search using the street name, postal code and city.", "parameters": [ { "name": "searchTerm", "in": "query", "description": "Search term for full text search", "required": true, "schema": { "type": "string" }, "example": "Berlin, Pariser Platz" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.StreetResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.StreetResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.StreetResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.StreetResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/de/GovernmentRegions/{key}/Districts": { "get": { "tags": [ "DE" ], "summary": "Returns all districts (Kreise) within a government region (Regierungsbezirk).", "parameters": [ { "name": "key", "in": "path", "description": "Regional key of the government region", "required": true, "schema": { "type": "string" }, "example": "091" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.DistrictResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.DistrictResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.DistrictResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.DistrictResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/de/GovernmentRegions/{key}/Localities": { "get": { "tags": [ "DE" ], "summary": "Returns all localities wihtin a government region (Regierungsbezirk).", "parameters": [ { "name": "key", "in": "path", "description": "Regional key of the government region", "required": true, "schema": { "type": "string" }, "example": "091" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.LocalityResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.LocalityResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.LocalityResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.LocalityResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/de/GovernmentRegions/{key}/MunicipalAssociations": { "get": { "tags": [ "DE" ], "summary": "Returns all municipal associations (Gemeindeverbünde) within a government region (Regierungsbezirk).", "parameters": [ { "name": "key", "in": "path", "description": "Regional key of the government region", "required": true, "schema": { "type": "string" }, "example": "091" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalAssociationResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalAssociationResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalAssociationResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalAssociationResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/de/GovernmentRegions/{key}/Municipalities": { "get": { "tags": [ "DE" ], "summary": "Returns all municipalities (Gemeinden) within a government region (Regierungsbezirk).", "parameters": [ { "name": "key", "in": "path", "description": "Regional key of the government region", "required": true, "schema": { "type": "string" }, "example": "091" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalityResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalityResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalityResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalityResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/de/Localities": { "get": { "tags": [ "DE" ], "summary": "Returns all localities whose postal code and/or name matches the given patterns.", "parameters": [ { "name": "postalCode", "in": "query", "description": "Postal code or regular expression", "schema": { "type": "string" }, "example": "56566" }, { "name": "name", "in": "query", "description": "Name or regular expression", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.LocalityResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.LocalityResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.LocalityResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.LocalityResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/de/Streets": { "get": { "tags": [ "DE" ], "summary": "Returns all streets whose name, postal code and/or name matches the given patterns.", "parameters": [ { "name": "name", "in": "query", "description": "Name or regular expression", "schema": { "type": "string" }, "example": "Pariser Platz" }, { "name": "postalCode", "in": "query", "description": "Postal code or regular expression", "schema": { "type": "string" } }, { "name": "locality", "in": "query", "description": "Locality or regular expression", "schema": { "type": "string" }, "example": "Berlin" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.StreetResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.StreetResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.StreetResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.DE.StreetResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/li/Communes": { "get": { "tags": [ "LI" ], "summary": "Returns all communes (Gemeinden).", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.LI.CommuneResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.LI.CommuneResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.LI.CommuneResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.LI.CommuneResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/li/FullTextSearch": { "get": { "tags": [ "LI" ], "summary": "Performs a full-text search using the street name, postal code and city.", "parameters": [ { "name": "searchTerm", "in": "query", "description": "Search term for full text search", "required": true, "schema": { "type": "string" }, "example": "Alte Landstrasse 9490 Vaduz" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.LI.StreetResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.LI.StreetResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.LI.StreetResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.LI.StreetResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/li/Localities": { "get": { "tags": [ "LI" ], "summary": "Returns all localities whose postal code and/or name matches the given patterns.", "parameters": [ { "name": "postalCode", "in": "query", "description": "Postal code or regular expression", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name or regular expression", "schema": { "type": "string" }, "example": "Vaduz" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.LI.LocalityResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.LI.LocalityResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.LI.LocalityResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.LI.LocalityResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/li/Streets": { "get": { "tags": [ "LI" ], "summary": "Returns all streets whose name, postal code and/or name matches the given patterns.", "parameters": [ { "name": "name", "in": "query", "description": "Name or regular expression", "schema": { "type": "string" }, "example": "Alte Landstrasse" }, { "name": "postalCode", "in": "query", "description": "Postal code or regular expression", "schema": { "type": "string" }, "example": "9490" }, { "name": "locality", "in": "query", "description": "Locality or regular expression", "schema": { "type": "string" }, "example": "Vaduz" }, { "name": "page", "in": "query", "description": "Page number (starting with 1)", "schema": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Page size (maximum 50)", "schema": { "maximum": 50, "minimum": 1, "type": "integer", "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.LI.StreetResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.LI.StreetResponse" } } }, "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.LI.StreetResponse" } } }, "text/csv": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenPlzApi.LI.StreetResponse" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } } }, "components": { "schemas": { "OpenPlzApi.AT.DistrictResponse": { "required": [ "code", "federalProvince", "key", "name" ], "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Code (Bezirkskodierung)", "readOnly": true, "example": "902" }, "federalProvince": { "$ref": "#/components/schemas/OpenPlzApi.AT.FederalProvinceSummary" }, "key": { "minLength": 1, "type": "string", "description": "Key (Bezirkskennziffer)", "readOnly": true, "example": "900" }, "name": { "minLength": 1, "type": "string", "description": "Name (Bezirksname)", "readOnly": true, "example": "Wien 2., Leopoldstadt" } }, "additionalProperties": false, "description": "Representation of an Austrian district (Bezirk)", "readOnly": true }, "OpenPlzApi.AT.DistrictSummary": { "required": [ "code", "key", "name" ], "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Code (Bezirkskodierung)", "readOnly": true, "example": "902" }, "key": { "minLength": 1, "type": "string", "description": "Key (Bezirkskennziffer)", "readOnly": true, "example": "900" }, "name": { "minLength": 1, "type": "string", "description": "Name (Bezirksname)", "readOnly": true, "example": "Wien 2., Leopoldstadt" } }, "additionalProperties": false, "description": "Reduced representation of an Austrian district (Bezirk)", "readOnly": true }, "OpenPlzApi.AT.FederalProvinceResponse": { "required": [ "key", "name" ], "type": "object", "properties": { "key": { "minLength": 1, "type": "string", "description": "Key (Bundeslandkennziffer)", "readOnly": true, "example": "9" }, "name": { "minLength": 1, "type": "string", "description": "Name (Bundeslandname)", "readOnly": true, "example": "Wien" } }, "additionalProperties": false, "description": "Representation of an Austrian federal province (Bundesland)", "readOnly": true }, "OpenPlzApi.AT.FederalProvinceSummary": { "required": [ "key", "name" ], "type": "object", "properties": { "key": { "minLength": 1, "type": "string", "description": "Key (Bundeslandkennziffer)", "readOnly": true, "example": "9" }, "name": { "minLength": 1, "type": "string", "description": "Name (Bundeslandname)", "readOnly": true, "example": "Wien" } }, "additionalProperties": false, "description": "Reduced representation of an Austrian federal province (Bundesland)", "readOnly": true }, "OpenPlzApi.AT.LocalityResponse": { "required": [ "district", "federalProvince", "key", "municipality", "name", "postalCode" ], "type": "object", "properties": { "district": { "$ref": "#/components/schemas/OpenPlzApi.AT.DistrictSummary" }, "federalProvince": { "$ref": "#/components/schemas/OpenPlzApi.AT.FederalProvinceSummary" }, "key": { "minLength": 1, "type": "string", "description": "Key (Ortschaftskennziffer)", "readOnly": true, "example": "17224" }, "municipality": { "$ref": "#/components/schemas/OpenPlzApi.AT.MunicipalitySummary" }, "name": { "minLength": 1, "type": "string", "description": "Name (Ortschaftsname)", "readOnly": true, "example": "Wien, Leopoldstadt" }, "postalCode": { "minLength": 1, "type": "string", "description": "Postal code (Postleitzahl)", "readOnly": true, "example": "1020" } }, "additionalProperties": false, "description": "Representation of an Austrian locality (Ortschaft)", "readOnly": true }, "OpenPlzApi.AT.MunicipalityResponse": { "required": [ "code", "district", "federalProvince", "key", "multiplePostalCodes", "name", "postalCode", "status" ], "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Code (Gemeindecode)", "readOnly": true, "example": "90201" }, "district": { "$ref": "#/components/schemas/OpenPlzApi.AT.DistrictSummary" }, "federalProvince": { "$ref": "#/components/schemas/OpenPlzApi.AT.FederalProvinceSummary" }, "key": { "minLength": 1, "type": "string", "description": "Key (Gemeindekennziffer)", "readOnly": true, "example": "90001" }, "multiplePostalCodes": { "type": "boolean", "description": "This municipality has multiple postal codes?", "readOnly": true, "example": false }, "name": { "minLength": 1, "type": "string", "description": "Name (Ortschaftsname)", "readOnly": true, "example": "Wien" }, "postalCode": { "minLength": 1, "type": "string", "description": "Postal code (Postleitzahl des Gemeindeamtes)", "readOnly": true, "example": "1020" }, "status": { "minLength": 1, "type": "string", "description": "Status (Gemeindestatus)", "readOnly": true, "example": "Statutarstadt" } }, "additionalProperties": false, "description": "Representation of an Austrian municipality (Gemeinde)", "readOnly": true }, "OpenPlzApi.AT.MunicipalitySummary": { "required": [ "code", "key", "name", "status" ], "type": "object", "properties": { "code": { "minLength": 1, "type": "string", "description": "Code (Gemeindecode)", "readOnly": true, "example": "90201" }, "key": { "minLength": 1, "type": "string", "description": "Key (Gemeindekennziffer)", "readOnly": true, "example": "90001" }, "name": { "minLength": 1, "type": "string", "description": "Name (Gemeindename)", "readOnly": true, "example": "Wien" }, "status": { "minLength": 1, "type": "string", "description": "Status (Gemeindestatus)", "readOnly": true, "example": "Statutarstadt" } }, "additionalProperties": false, "description": "Reduced representation of an Austrian municipality (Gemeinde)", "readOnly": true }, "OpenPlzApi.AT.StreetResponse": { "required": [ "district", "federalProvince", "key", "locality", "municipality", "name", "postalCode" ], "type": "object", "properties": { "district": { "$ref": "#/components/schemas/OpenPlzApi.AT.DistrictSummary" }, "federalProvince": { "$ref": "#/components/schemas/OpenPlzApi.AT.FederalProvinceSummary" }, "key": { "minLength": 1, "type": "string", "description": "Key (Straßenkennziffer)", "readOnly": true, "example": "900017" }, "locality": { "minLength": 1, "type": "string", "description": "Locality (Ortschaftsname)", "readOnly": true, "example": "Wien, Leopoldstadt" }, "municipality": { "$ref": "#/components/schemas/OpenPlzApi.AT.MunicipalitySummary" }, "name": { "minLength": 1, "type": "string", "description": "Name (Straßenname)", "readOnly": true, "example": "Adambergergasse" }, "postalCode": { "minLength": 1, "type": "string", "description": "Postal code (Postleitzahl)", "readOnly": true, "example": "1020" } }, "additionalProperties": false, "description": "Representation of an Austrian street (Straße)" }, "OpenPlzApi.CH.CantonResponse": { "required": [ "historicalCode", "key", "name", "shortName" ], "type": "object", "properties": { "historicalCode": { "minLength": 1, "type": "string", "description": "Historical code (Historisierte Nummer des Kantons)", "readOnly": true, "example": "13" }, "key": { "minLength": 1, "type": "string", "description": "Key (Bfs-Nummer des Kantons)", "readOnly": true, "example": "13" }, "name": { "minLength": 1, "type": "string", "description": "Name (Kantonsname)", "readOnly": true, "example": "Basel-Landschaft" }, "shortName": { "minLength": 1, "type": "string", "description": "Short name (Kantonskürzel)", "readOnly": true, "example": "BL" } }, "additionalProperties": false, "description": "Representation of a Swiss canton (Kanton)", "readOnly": true }, "OpenPlzApi.CH.CantonSummary": { "required": [ "key", "name", "shortName" ], "type": "object", "properties": { "key": { "minLength": 1, "type": "string", "description": "Key (Bfs-Nummer des Kantons)", "readOnly": true, "example": "13" }, "name": { "minLength": 1, "type": "string", "description": "Name (Kantonsname)", "readOnly": true, "example": "Basel-Landschaft" }, "shortName": { "minLength": 1, "type": "string", "description": "Short name (Kantonskürzel)", "readOnly": true, "example": "BL" } }, "additionalProperties": false, "description": "Reduced representation of a Swiss canton (Kanton)", "readOnly": true }, "OpenPlzApi.CH.CommuneResponse": { "required": [ "canton", "district", "historicalCode", "key", "name", "shortName" ], "type": "object", "properties": { "canton": { "$ref": "#/components/schemas/OpenPlzApi.CH.CantonSummary" }, "district": { "$ref": "#/components/schemas/OpenPlzApi.CH.DistrictSummary" }, "historicalCode": { "minLength": 1, "type": "string", "description": "Historical code (Historisierte Nummer der Gemeinde)", "readOnly": true, "example": "13844" }, "key": { "minLength": 1, "type": "string", "description": "Key (Bfs-Nummer der Gemeinde)", "readOnly": true, "example": "2786" }, "name": { "minLength": 1, "type": "string", "description": "Name (Amtlicher Gemeindename)", "readOnly": true, "example": "Grellingen" }, "shortName": { "minLength": 1, "type": "string", "description": "Short name (Gemeindename, kurz)", "readOnly": true, "example": "Grellingen" } }, "additionalProperties": false, "description": "Representation of a Swiss commune (Gemeinde)", "readOnly": true }, "OpenPlzApi.CH.CommuneSummary": { "required": [ "key", "name", "shortName" ], "type": "object", "properties": { "key": { "minLength": 1, "type": "string", "description": "Key (Bfs-Nummer der Gemeinde)", "readOnly": true, "example": "2786" }, "name": { "minLength": 1, "type": "string", "description": "Name (Amtlicher Gemeindename)", "readOnly": true, "example": "Grellingen" }, "shortName": { "minLength": 1, "type": "string", "description": "Short name (Gemeindename, kurz)", "readOnly": true, "example": "Grellingen" } }, "additionalProperties": false, "description": "Reduced representation of a Swiss commune (Gemeinde)", "readOnly": true }, "OpenPlzApi.CH.DistrictResponse": { "required": [ "canton", "historicalCode", "key", "name", "shortName" ], "type": "object", "properties": { "canton": { "$ref": "#/components/schemas/OpenPlzApi.CH.CantonSummary" }, "historicalCode": { "minLength": 1, "type": "string", "description": "Historical code (Historisierte Nummer des Bezirks)", "readOnly": true, "example": "10236" }, "key": { "minLength": 1, "type": "string", "description": "Key (Bfs-Nummer des Bezirks)", "readOnly": true, "example": "1302" }, "name": { "minLength": 1, "type": "string", "description": "Name (Bezirksname)", "readOnly": true, "example": "Bezirk Laufen" }, "shortName": { "minLength": 1, "type": "string", "description": "Short name (Bezirksname, kurz)", "readOnly": true, "example": "Laufen" } }, "additionalProperties": false, "description": "Representation of a Swiss district (Bezirk)", "readOnly": true }, "OpenPlzApi.CH.DistrictSummary": { "required": [ "key", "name", "shortName" ], "type": "object", "properties": { "key": { "minLength": 1, "type": "string", "description": "Key (Bezirksnummer)", "readOnly": true, "example": "1302" }, "name": { "minLength": 1, "type": "string", "description": "Name (Bezirksname)", "readOnly": true, "example": "Bezirk Laufen" }, "shortName": { "minLength": 1, "type": "string", "description": "Short name (Bezirksname, kurz)", "readOnly": true, "example": "Laufen" } }, "additionalProperties": false, "description": "Reduced representation of a Swiss district (Bezirk)", "readOnly": true }, "OpenPlzApi.CH.LocalityResponse": { "required": [ "canton", "commune", "district", "name", "postalCode" ], "type": "object", "properties": { "canton": { "$ref": "#/components/schemas/OpenPlzApi.CH.CantonSummary" }, "commune": { "$ref": "#/components/schemas/OpenPlzApi.CH.CommuneSummary" }, "district": { "$ref": "#/components/schemas/OpenPlzApi.CH.DistrictSummary" }, "name": { "minLength": 1, "type": "string", "description": "Name (Ortsname)", "readOnly": true, "example": "Grellingen" }, "postalCode": { "minLength": 1, "type": "string", "description": "Postal code (Postleitzahl)", "readOnly": true, "example": "4203" } }, "additionalProperties": false, "description": "Representation of a Swiss locality (Ort oder Stadt)", "readOnly": true }, "OpenPlzApi.CH.StreetResponse": { "required": [ "canton", "commune", "district", "key", "locality", "name", "postalCode", "status" ], "type": "object", "properties": { "canton": { "$ref": "#/components/schemas/OpenPlzApi.CH.CantonSummary" }, "commune": { "$ref": "#/components/schemas/OpenPlzApi.CH.CommuneSummary" }, "district": { "$ref": "#/components/schemas/OpenPlzApi.CH.DistrictSummary" }, "key": { "minLength": 1, "type": "string", "description": "Key (Straßenschlüssel)", "readOnly": true, "example": "10023770" }, "locality": { "minLength": 1, "type": "string", "description": "Locality (Ortsname)", "readOnly": true, "example": "Grellingen" }, "name": { "minLength": 1, "type": "string", "description": "Name (Straßenname)", "readOnly": true, "example": "Wiedenweg" }, "postalCode": { "minLength": 1, "type": "string", "description": "Postal code (Postleitzahl)", "readOnly": true, "example": "4203" }, "status": { "$ref": "#/components/schemas/OpenPlzApi.CH.StreetStatus" } }, "additionalProperties": false, "description": "Representation of a Swiss street (Straße)", "readOnly": true }, "OpenPlzApi.CH.StreetStatus": { "enum": [ "None", "Planned", "Real", "Outdated" ], "type": "string", "description": "Street status (Straßenstatus)", "readOnly": true }, "OpenPlzApi.DE.DistrictResponse": { "required": [ "administrativeHeadquarters", "federalState", "key", "name", "type" ], "type": "object", "properties": { "administrativeHeadquarters": { "minLength": 1, "type": "string", "description": "Administrative headquarters (Sitz der Kreisverwaltung)", "readOnly": true }, "federalState": { "$ref": "#/components/schemas/OpenPlzApi.DE.FederalStateSummary" }, "governmentRegion": { "$ref": "#/components/schemas/OpenPlzApi.DE.GovernmentRegionSummary" }, "key": { "minLength": 1, "type": "string", "description": "Regional key (Regionalschlüssel)", "readOnly": true, "example": "07137" }, "name": { "minLength": 1, "type": "string", "description": "Name (Kreisname)", "readOnly": true, "example": "Mayen-Koblenz" }, "type": { "minLength": 1, "type": "string", "description": "Type (Kennzeichen)", "readOnly": true, "example": "Landkreis" } }, "additionalProperties": false, "description": "Representation of a German district (Kreis)", "readOnly": true }, "OpenPlzApi.DE.DistrictSummary": { "required": [ "key", "name", "type" ], "type": "object", "properties": { "key": { "minLength": 1, "type": "string", "description": "Regional key (Regionalschlüssel)", "readOnly": true, "example": "07137" }, "name": { "minLength": 1, "type": "string", "description": "Name (Kreisname)", "readOnly": true, "example": "Mayen-Koblenz" }, "type": { "minLength": 1, "type": "string", "description": "Type (Kennzeichen)", "readOnly": true, "example": "Landkreis" } }, "additionalProperties": false, "description": "Reduced representation of a German district (Kreis)", "readOnly": true }, "OpenPlzApi.DE.FederalStateResponse": { "required": [ "key", "name", "seatOfGovernment" ], "type": "object", "properties": { "key": { "minLength": 1, "type": "string", "description": "Regional key (Regionalschlüssel)", "readOnly": true, "example": "0" }, "name": { "minLength": 1, "type": "string", "description": "Name (Bundeslandname)", "readOnly": true, "example": "Rheinland-Pfalz" }, "seatOfGovernment": { "minLength": 1, "type": "string", "description": "Seat of government (Sitz der Landesregierung)", "readOnly": true, "example": "Mainz" } }, "additionalProperties": false, "description": "Representation of a German federal state (Bundesland)", "readOnly": true }, "OpenPlzApi.DE.FederalStateSummary": { "required": [ "key", "name" ], "type": "object", "properties": { "key": { "minLength": 1, "type": "string", "description": "Regional key (Regionalschlüssel)", "readOnly": true, "example": "07" }, "name": { "minLength": 1, "type": "string", "description": "Name (Bundeslandname)", "readOnly": true, "example": "Rheinland-Pfalz" } }, "additionalProperties": false, "description": "Reduced representation of a German federal state (Bundesland)", "readOnly": true }, "OpenPlzApi.DE.GovernmentRegionResponse": { "required": [ "administrativeHeadquarters", "federalState", "key", "name" ], "type": "object", "properties": { "administrativeHeadquarters": { "minLength": 1, "type": "string", "description": "Administrative headquarters (Verwaltungssitz des Regierungsbezirks)", "readOnly": true }, "federalState": { "$ref": "#/components/schemas/OpenPlzApi.DE.FederalStateSummary" }, "key": { "minLength": 1, "type": "string", "description": "Regional key (Regionalschlüssel)", "readOnly": true, "example": "071" }, "name": { "minLength": 1, "type": "string", "description": "Name (Bezirksname)", "readOnly": true, "example": "früher: Reg.-Bez. Koblenz" } }, "additionalProperties": false, "description": "Representation of a German government region (Regierungsbezirk)", "readOnly": true }, "OpenPlzApi.DE.GovernmentRegionSummary": { "required": [ "key", "name" ], "type": "object", "properties": { "key": { "minLength": 1, "type": "string", "description": "Regional key (Regionalschlüssel)", "readOnly": true, "example": "071" }, "name": { "minLength": 1, "type": "string", "description": "Name (Bezirksname)", "readOnly": true, "example": "früher: Reg.-Bez. Koblenz" } }, "additionalProperties": false, "description": "Reduced representation of a German government region (Regierungsbezirk)", "readOnly": true }, "OpenPlzApi.DE.LocalityResponse": { "required": [ "federalState", "municipality", "name", "postalCode" ], "type": "object", "properties": { "district": { "$ref": "#/components/schemas/OpenPlzApi.DE.DistrictSummary" }, "federalState": { "$ref": "#/components/schemas/OpenPlzApi.DE.FederalStateSummary" }, "municipality": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalitySummary" }, "name": { "minLength": 1, "type": "string", "description": "Name (Ortsname)", "readOnly": true, "example": "Bendorf" }, "postalCode": { "minLength": 1, "type": "string", "description": "Postal code (Postleitzahl)", "readOnly": true, "example": "56170" } }, "additionalProperties": false, "description": "Representation of a German locality (Ort oder Stadt)", "readOnly": true }, "OpenPlzApi.DE.MunicipalAssociationResponse": { "required": [ "administrativeHeadquarters", "federalState", "key", "name", "type" ], "type": "object", "properties": { "administrativeHeadquarters": { "minLength": 1, "type": "string", "description": "Administrative headquarters (Verwaltungssitz des Gemeindeverbandes)", "readOnly": true }, "district": { "$ref": "#/components/schemas/OpenPlzApi.DE.DistrictSummary" }, "federalState": { "$ref": "#/components/schemas/OpenPlzApi.DE.FederalStateSummary" }, "key": { "minLength": 1, "type": "string", "description": "Regional key (Regionalschlüssel)", "readOnly": true, "example": "01051166" }, "name": { "minLength": 1, "type": "string", "description": "Name (Name des Gemeindeverbandes)", "readOnly": true, "example": "Marne-Nordsee" }, "type": { "minLength": 1, "type": "string", "description": "Type (Kennzeichen des Gemeindeverbandes)", "readOnly": true, "example": "Amt" } }, "additionalProperties": false, "description": "Representation of a German municipal association (Gemeindeverband)", "readOnly": true }, "OpenPlzApi.DE.MunicipalAssociationSummary": { "required": [ "key", "name", "type" ], "type": "object", "properties": { "key": { "minLength": 1, "type": "string", "description": "Regional key (Regionalschlüssel)", "readOnly": true, "example": "07137" }, "name": { "minLength": 1, "type": "string", "description": "Name (Name des Gemeindeverbandes)", "readOnly": true, "example": "Bendorf, Stadt" }, "type": { "minLength": 1, "type": "string", "description": "Type (Kennzeichen des Gemeindeverbandes)", "readOnly": true, "example": "Verbandsfreie_Gemeinde" } }, "additionalProperties": false, "description": "Reduced representation of a German municipal association (Gemeindeverband)", "readOnly": true }, "OpenPlzApi.DE.MunicipalityResponse": { "required": [ "federalState", "governmentRegion", "key", "multiplePostalCodes", "name", "postalCode", "type" ], "type": "object", "properties": { "association": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalAssociationSummary" }, "district": { "$ref": "#/components/schemas/OpenPlzApi.DE.DistrictSummary" }, "federalState": { "$ref": "#/components/schemas/OpenPlzApi.DE.FederalStateSummary" }, "governmentRegion": { "$ref": "#/components/schemas/OpenPlzApi.DE.GovernmentRegionSummary" }, "key": { "minLength": 1, "type": "string", "description": "Regional key (Regionalschlüssel)", "readOnly": true, "example": "07137203" }, "multiplePostalCodes": { "type": "boolean", "description": "Multiple postal codes available?", "readOnly": true }, "name": { "minLength": 1, "type": "string", "description": "Name (Gemeindename)", "readOnly": true, "example": "Bendorf, Stadt" }, "postalCode": { "minLength": 1, "type": "string", "description": "Postal code of the administrative headquarters (Verwaltungssitz), if there are multiple postal codes available", "readOnly": true }, "type": { "minLength": 1, "type": "string", "description": "Type (Kennzeichen)", "readOnly": true, "example": "Stadt" } }, "additionalProperties": false, "description": "Representation of a German municipality (Gemeinde)", "readOnly": true }, "OpenPlzApi.DE.MunicipalitySummary": { "required": [ "key", "name", "type" ], "type": "object", "properties": { "key": { "minLength": 1, "type": "string", "description": "Regional key (Regionalschlüssel)", "readOnly": true, "example": "07137203" }, "name": { "minLength": 1, "type": "string", "description": "Name (Gemeindename)", "readOnly": true, "example": "Bendorf, Stadt" }, "type": { "minLength": 1, "type": "string", "description": "Type (Kennzeichen)", "readOnly": true, "example": "Stadt" } }, "additionalProperties": false, "description": "Reduced representation of a German municipality (Gemeinde)", "readOnly": true }, "OpenPlzApi.DE.StreetResponse": { "required": [ "federalState", "locality", "municipality", "name", "postalCode" ], "type": "object", "properties": { "borough": { "type": "string", "description": "Borough (Stadtbezirk)", "nullable": true, "readOnly": true }, "district": { "$ref": "#/components/schemas/OpenPlzApi.DE.DistrictSummary" }, "federalState": { "$ref": "#/components/schemas/OpenPlzApi.DE.FederalStateSummary" }, "locality": { "minLength": 1, "type": "string", "description": "Locality (Ortsname)", "readOnly": true, "example": "Bendorf" }, "municipality": { "$ref": "#/components/schemas/OpenPlzApi.DE.MunicipalitySummary" }, "name": { "minLength": 1, "type": "string", "description": "Name (Straßenname)", "readOnly": true, "example": "Engerser Landstr." }, "postalCode": { "minLength": 1, "type": "string", "description": "Postal code (Postleitzahl)", "readOnly": true, "example": "56170" }, "suburb": { "type": "string", "description": "Suburb (Stadtteil)", "nullable": true, "readOnly": true } }, "additionalProperties": false, "description": "Representation of a German street (Straße)", "readOnly": true }, "OpenPlzApi.LI.CommuneResponse": { "required": [ "electoralDistrict", "key", "name" ], "type": "object", "properties": { "key": { "minLength": 1, "type": "string", "description": "Key (Gemeindenummer)", "readOnly": true, "example": "7005" }, "name": { "minLength": 1, "type": "string", "description": "Name (Amtlicher Gemeindename)", "readOnly": true, "example": "Schaan" }, "electoralDistrict": { "minLength": 1, "type": "string", "description": "Electoral district (Wahlkreis)", "readOnly": true, "example": "Oberland" } }, "additionalProperties": false, "description": "Representation of a Liechtenstein commune (Gemeinde)", "readOnly": true }, "OpenPlzApi.LI.CommuneSummary": { "required": [ "key", "name" ], "type": "object", "properties": { "key": { "minLength": 1, "type": "string", "description": "Key (Gemeindenummer)", "readOnly": true, "example": "7005" }, "name": { "minLength": 1, "type": "string", "description": "Name (Amtlicher Gemeindename)", "readOnly": true, "example": "Schaan" } }, "additionalProperties": false, "description": "Reduced representation of a Liechtenstein commune (Gemeinde)", "readOnly": true }, "OpenPlzApi.LI.LocalityResponse": { "required": [ "commune", "name", "postalCode" ], "type": "object", "properties": { "commune": { "$ref": "#/components/schemas/OpenPlzApi.LI.CommuneSummary" }, "name": { "minLength": 1, "type": "string", "description": "Name (Ortsname)", "readOnly": true, "example": "Grellingen" }, "postalCode": { "minLength": 1, "type": "string", "description": "Postal code (Postleitzahl)", "readOnly": true, "example": "4203" } }, "additionalProperties": false, "description": "Representation of a Swiss locality (Ort oder Stadt)", "readOnly": true }, "OpenPlzApi.LI.StreetResponse": { "required": [ "commune", "key", "locality", "name", "postalCode", "status" ], "type": "object", "properties": { "commune": { "$ref": "#/components/schemas/OpenPlzApi.LI.CommuneSummary" }, "key": { "minLength": 1, "type": "string", "description": "Key (Straßenschlüssel)", "readOnly": true, "example": "10023770" }, "locality": { "minLength": 1, "type": "string", "description": "Locality (Ortsname)", "readOnly": true, "example": "Grellingen" }, "name": { "minLength": 1, "type": "string", "description": "Name (Straßenname)", "readOnly": true, "example": "Wiedenweg" }, "postalCode": { "minLength": 1, "type": "string", "description": "Postal code (Postleitzahl)", "readOnly": true, "example": "4203" }, "status": { "$ref": "#/components/schemas/OpenPlzApi.LI.StreetStatus" } }, "additionalProperties": false, "description": "Representation of a Swiss street (Straße)", "readOnly": true }, "OpenPlzApi.LI.StreetStatus": { "enum": [ "None", "Planned", "Real", "Outdated" ], "type": "string", "description": "Street status (Straßenstatus)", "readOnly": true }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } } } }, "tags": [ { "name": "AT", "description": "Austrian federal provinces, districts, municipalities, localities and streets" }, { "name": "CH", "description": "Swiss cantons, districts, communes, localities and streets" }, { "name": "DE", "description": "German federal states, government regions, districts, municipalities, municipal associations, localities and streets" }, { "name": "LI", "description": "Liechtenstein communes, localities and streets" } ] }