OpenPLZ (Editora Independente) (Pré-visualização)
OpenPLZ API – API pública de ruas e códigos postais para Alemanha, Liechtenstein, Suíça e Áustria.
Documentação: https://www.openplzapi.org/de/germany/
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | OpenPLZ API |
| URL | https://www.openplzapi.org |
| Metadados do conector | |
|---|---|
| Editora | LowCodeInvestigator |
| Sítio Web | https://www.openplzapi.org |
| Política de privacidade | https://www.openplzapi.org/legal/privacy-policy |
| Categorias | Data |
| Visibilidade | Importante |
Conector API OpenPLZ
O OpenPLZ API Connector fornece acesso estruturado a códigos postais, ruas, divisões administrativas e dados de localidade para a Alemanha, Suíça, Áustria e Liechtenstein. Permite que as soluções Microsoft Power Platform consultem conjuntos de dados de localização fiáveis e normalizados num formato baseado em REST.
Este conector expõe múltiplas operações de leitura somente que permitem a recuperação de informações hierárquicas, como estados federais, cantões, distritos, municípios, localidades, códigos postais e ruas.
Editora
Funcionalidades Suportadas
O Conector API OpenPLZ suporta as seguintes capacidades:
- Recuperar hierarquias administrativas (estados federais, cantões, distritos, municípios, associações municipais, localidades)
- Realizar consultas por código postal
- Consultar diretórios de ruas
- Trabalho com cobertura internacional (Alemanha, Suíça, Áustria, Liechtenstein)
- Consumir formatos de resposta JSON consistentes adequados para automação e validação
Pré-requisitos
Não são necessários pré-requisitos para usar este conector:
- Sem chave API
- Sem OAuth
- Sem autenticação
- Sem subscrição
A API é acessível publicamente.
Como Usar o Conector
- Adicione o Conector da API OpenPLZ ao seu fluxo Power App ou Power Automate.
- Escolha uma das ações disponíveis.
- Forneça os parâmetros necessários.
- Use os dados JSON devolvidos no seu fluxo de trabalho ou aplicação (por exemplo, para preencher listas suspensas, validar endereços ou armazenar dados estruturados de localização).
Informação de Ligação
O conector utiliza uma única ligação anónima. Não são necessárias credenciais.
Limitações conhecidas
- API apenas de leitura (apenas operações GET estão disponíveis)
- Limitação potencial de taxa para pedidos de frequência excessiva ou alta
- Sem geocoordenadas ou dados de fronteira de polígonos
- Os nomes administrativos e de localidades seguem as convenções de nomenclatura em língua alemã
Documentação da API
- Documentação geral
- Documentação da Alemanha
- Documentação da Suíça
- Documentação da Áustria
- Liechtenstein está incluído na documentação suíça
Ordem Recomendada de Chamadas API por País
As secções seguintes descrevem uma sequência recomendada de chamadas de API para recuperar estruturas administrativas hierárquicas numa ordem lógica para cada país.
Alemanha (DE)
Alemanha – Dados Base
- GET /de/FederalStates (Listar todos os estados federais (Alemanha))
Alemanha – Nível de Estado Federal (usando federalStateKey)
- OBTER /de/FederalStates/{federalStateKey}/GovernmentRegions (Listar regiões governamentais de um estado federal (Alemanha))
- GET /de/FederalStates/{federalStateKey}/Districts (Listar distritos de um estado federal (Alemanha))
- GET /de/FederalStates/{federalStateKey}/Municípios (Listar municípios de um estado federal (Alemanha))
- GET /de/FederalStates/{federalStateKey}/MunicipalAssociations (Listar associações municipais de um estado federal (Alemanha))
- GET /de/FederalStates/{federalStateKey}/Localidades (Listar localidades de um estado federal (Alemanha))
Alemanha – Nível de Região Governamental (usando governmentRegionKey)
- GET /de/GovernmentRegions/{governmentRegionKey}/Districts (Listar distritos de uma região governamental (Alemanha))
- GET /de/GovernmentRegions/{governmentRegionKey}/Municípios (Listar municípios de uma região governamental (Alemanha))
- GET /de/GovernmentRegions/{governmentRegionKey}/MunicipalAssociations (Listar associações municipais de uma região governamental (Alemanha))
- GET /de/GovernmentRegions/{governmentRegionKey}/Localidades (Listar localidades de uma região governamental (Alemanha))
Alemanha – Nível Distrital (usando districtKey)
- GET /de/Districts/{districtKey}/Municípios (Listar municípios de um distrito (Alemanha))
- GET /de/Districts/{districtKey}/MunicipalAssociations (Listar associações municipais de um distrito (Alemanha))
- GET /de/Districts/{districtKey}/Localidades (Listar localidades de um distrito (Alemanha))
Alemanha – Endpoints de Pesquisa
- GET /de/Localidades (Pesquisar localidades e códigos postais (Alemanha))
- GET /de/Streets (Pesquisar ruas (Alemanha))
- GET /de/FullTextSearch (Pesquisa em texto completo para ruas, códigos postais e localidades (Alemanha))
Liechtenstein (LI)
Liechtenstein – Dados Base
- GET /li/Communes (Listar todas as comunas (Liechtenstein))
Liechtenstein – Endpoints de Pesquisa
- GET /li/Localidades (Pesquisar localidades e códigos postais (Liechtenstein))
- GET /li/Streets (Pesquisar ruas (Liechtenstein))
- GET /li/FullTextSearch (Pesquisa em texto completo para ruas (Liechtenstein))
Suíça (CH)
Suíça – Dados Base
- GET /ch/Cantões (Listar todos os cantões (Suíça))
Suíça – Nível de Cantão (usando cantonKey)
- GET /ch/Cantões/{cantonChave}/Distritos (Listar distritos de um cantão (Suíça))
- GET /ch/Cantões/{cantonKey}/Comunas (Lista de comunas de um cantão (Suíça))
- GET /ch/Cantões/{cantonChave}/Localidades (Listar localidades de um cantão (Suíça))
Suíça – Nível de Distrito (usando District Key)
- GET /ch/Districts/{districtKey}/Communes (Listar comunas de um distrito (Suíça))
- GET /ch/Districts/{districtKey}/Localidades (Listar localidades de um distrito (Suíça))
Suíça – Endpoints de Pesquisa
- GET /ch/Localidades (Pesquise localidades e códigos postais (Suíça))
- GET /ch/Ruas (Pesquisar ruas (Suíça))
- GET /ch/FullTextSearch (Pesquisa em texto completo para ruas (Suíça))
Áustria (AT)
Áustria – Dados Base
- GET /at/FederalProvinces (Listar todas as províncias federais (Áustria))
Áustria – Nível de Província Federal (usando federalProvinceKey)
- GET /at/FederalProvinces/{federalProvinceKey}/Districts (Listar distritos de uma província federal (Áustria))
- GET /at/FederalProvinces/{federalProvinceKey}/Municípios (Listar municípios de uma província federal (Áustria))
- GET /at/FederalProvinces/{federalProvinceKey}/Localidades (Listar localidades de uma província federal (Áustria))
Áustria – Nível de Distrito (usando Chave de Distrito)
- GET /at/Districts/{districtKey}/Municípios (Listar municípios de um distrito (Áustria))
- GET /at/Districts/{districtKey}/Localidades (Listar localidades de um distrito (Áustria))
Áustria – Pontos de Pesquisa
- GET /at/Localidades (Pesquisar localidades e códigos postais (Áustria))
- GET /at/Streets (Pesquisar ruas (Áustria))
- GET /at/FullTextSearch (Pesquisa em texto completo para ruas (Áustria))
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Lista de associações municipais de um distrito (Alemanha) |
Devolve todas as associações municipais dentro de um distrito alemão. |
| Lista de associações municipais de um estado federal (Alemanha) |
Retorna todas as associações municipais dentro de um estado federal alemão. |
| Lista de associações municipais de uma região governamental (Alemanha) |
Retorna todas as associações municipais dentro de uma região governamental alemã. |
| Lista de comunas de um cantão (Suíça) |
Retorna todas as comunas dentro de um cantão suíço. |
| Lista de comunas de um distrito (Suíça) |
Devolve todas as comunas dentro de um distrito suíço. |
| Lista de distritos de um cantão (Suíça) |
Devolve todos os distritos dentro de um cantão suíço. |
| Lista de distritos de um estado federal (Alemanha) |
Devolve todos os distritos dentro de um estado federal alemão. |
| Lista de distritos de uma província federal (Áustria) |
Devolve todos os distritos dentro de uma província federal austríaca. |
| Lista de distritos de uma região governamental (Alemanha) |
Devolve todos os distritos dentro de uma região governamental alemã. |
| Lista de localidades de um cantão (Suíça) |
Retorna todas as localidades dentro de um cantão suíço. |
| Lista de localidades de um distrito (Alemanha) |
Devolve todas as localidades dentro de um distrito alemão. |
| Lista de localidades de um distrito (Suíça) |
Devolve todas as localidades dentro de um distrito suíço. |
| Lista de localidades de um distrito (Áustria) |
Retorna todas as localidades dentro de um distrito austríaco. |
| Lista de localidades de um estado federal (Alemanha) |
Retorna todas as localidades dentro de um estado federal alemão. |
| Lista de localidades de uma província federal (Áustria) |
Retorna todas as localidades dentro de uma província federal austríaca. |
| Lista de localidades de uma região governamental (Alemanha) |
Devolve todas as localidades dentro de uma região governamental alemã. |
| Lista de municípios de um distrito (Alemanha) |
Retorna todos os municípios dentro de um distrito alemão. |
| Lista de municípios de um distrito (Áustria) |
Retorna todos os municípios dentro de um distrito austríaco. |
| Lista de municípios de um estado federal (Alemanha) |
Devolve todos os municípios dentro de um estado federal alemão. |
| Lista de municípios de uma província federal (Áustria) |
Retorna todos os municípios dentro de uma província federal austríaca. |
| Lista de municípios de uma região governamental (Alemanha) |
Retorna todos os municípios dentro de uma região governamental alemã. |
| Lista de todas as comunas (Liechtenstein) |
Retorna todas as 11 comunas do Principado do Liechtenstein. |
| Lista de todas as províncias federais (Áustria) |
Retorna todas as 9 províncias federais na Áustria. |
| Lista de todos os cantões (Suíça) |
Devolve todos os 26 cantões da Suíça. |
| Listar regiões governamentais de um estado federal (Alemanha) |
Devolve todas as regiões governamentais dentro de um estado federal alemão. |
| Listar todos os estados federados (Alemanha) |
Devolve todos os estados federais alemães. |
| Pesquisa em texto completo para ruas (Liechtenstein) |
Pesquisa em texto completo através do nome da rua, código postal e nome da localidade no Liechtenstein. |
| Pesquisa em texto completo para ruas (Suíça) |
Pesquisa em texto completo por nomes de ruas, códigos postais e localidades na Suíça. |
| Pesquisa em texto completo por ruas, códigos postais e localidades (Alemanha) |
Pesquisa em texto completo por nomes de ruas, códigos postais e nomes de localidades na Alemanha. |
| Pesquisa em texto completo por ruas (Áustria) |
Pesquisa em texto completo através do nome da rua, código postal e nome da localidade para o diretório de dados austríaco. |
| Pesquisar ruas (Liechtenstein) |
Pesquisa de ruas no Liechtenstein por nome da rua e/ou código postal e/ou localidade. São suportadas expressões regulares. |
| Pesquisar ruas (Áustria) |
Pesquisas por ruas na Áustria por nome da rua e/ou código postal e/ou nome da localidade. Todos os parâmetros suportam expressões regulares. |
| Pesquise localidades e códigos postais (Alemanha) |
Pesquisas por localidades na Alemanha por código postal e/ou nome da localidade. Ambos os parâmetros suportam expressões regulares. |
| Pesquise localidades e códigos postais (Liechtenstein) |
Pesquisas por localidades no Liechtenstein por código postal e/ou nome da localidade. São suportadas expressões regulares. |
| Pesquise localidades e códigos postais (Suíça) |
Pesquisas por localidades na Suíça por código postal e/ou nome da localidade. Ambos os parâmetros suportam expressões regulares. |
| Pesquise localidades e códigos postais (Áustria) |
Pesquisas por localidades na Áustria por código postal e/ou nome da localidade. Ambos os parâmetros suportam expressões regulares. |
| Procurar ruas (Suíça) |
Pesquisas por ruas na Suíça por nome da rua e/ou código postal e/ou nome da localidade. Todos os parâmetros suportam expressões regulares. |
| Ruas de pesquisa (Alemanha) |
Pesquisas por ruas na Alemanha por nome da rua e/ou código postal e/ou nome da localidade. Todos os parâmetros suportam expressões regulares. |
Lista de associações municipais de um distrito (Alemanha)
Devolve todas as associações municipais dentro de um distrito alemão.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave do distrito
|
districtKey | True | string |
Chave regional do distrito (5 dígitos). |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of MunicipalAssociation
Lista de associações municipais de um estado federal (Alemanha)
Retorna todas as associações municipais dentro de um estado federal alemão.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave estadual federal
|
federalStateKey | True | string |
Chave regional do estado federal (2 dígitos). |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of MunicipalAssociation
Lista de associações municipais de uma região governamental (Alemanha)
Retorna todas as associações municipais dentro de uma região governamental alemã.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave da região governamental
|
governmentRegionKey | True | string |
Chave regional da região governamental (3 dígitos). |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of MunicipalAssociation
Lista de comunas de um cantão (Suíça)
Retorna todas as comunas dentro de um cantão suíço.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave de cantão
|
cantonKey | True | string |
Número BFS do cantão (máximo 2 dígitos). |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of CommuneCH
Lista de comunas de um distrito (Suíça)
Devolve todas as comunas dentro de um distrito suíço.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave do distrito
|
districtKey | True | string |
Número BFS do distrito (máximo 4 dígitos). |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of CommuneCH
Lista de distritos de um cantão (Suíça)
Devolve todos os distritos dentro de um cantão suíço.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave de cantão
|
cantonKey | True | string |
Número BFS do cantão (máximo 2 dígitos), por exemplo, '10' para Friburgo. |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of DistrictCH
Lista de distritos de um estado federal (Alemanha)
Devolve todos os distritos dentro de um estado federal alemão.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave estadual federal
|
federalStateKey | True | string |
Chave regional do estado federal (2 dígitos). |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of District
Lista de distritos de uma província federal (Áustria)
Devolve todos os distritos dentro de uma província federal austríaca.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave da província federal
|
federalProvinceKey | True | string |
Identificador federal da província (1 dígito). |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of DistrictAT
Lista de distritos de uma região governamental (Alemanha)
Devolve todos os distritos dentro de uma região governamental alemã.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave da região governamental
|
governmentRegionKey | True | string |
Chave regional da região governamental (3 dígitos). |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of District
Lista de localidades de um cantão (Suíça)
Retorna todas as localidades dentro de um cantão suíço.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave de cantão
|
cantonKey | True | string |
Número BFS do cantão (máximo 2 dígitos). |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of LocalityCH
Lista de localidades de um distrito (Alemanha)
Devolve todas as localidades dentro de um distrito alemão.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave do distrito
|
districtKey | True | string |
Chave regional do distrito (5 dígitos). |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of Locality
Lista de localidades de um distrito (Suíça)
Devolve todas as localidades dentro de um distrito suíço.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave do distrito
|
districtKey | True | string |
Número BFS do distrito (máximo 4 dígitos). |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of LocalityCH
Lista de localidades de um distrito (Áustria)
Retorna todas as localidades dentro de um distrito austríaco.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave do distrito
|
districtKey | True | string |
Identificador do distrito ou código do distrito (3 dígitos). |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of LocalityAT
Lista de localidades de um estado federal (Alemanha)
Retorna todas as localidades dentro de um estado federal alemão.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave estadual federal
|
federalStateKey | True | string |
Chave regional do estado federal (2 dígitos). |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of Locality
Lista de localidades de uma província federal (Áustria)
Retorna todas as localidades dentro de uma província federal austríaca.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave da província federal
|
federalProvinceKey | True | string |
Identificador federal da província (1 dígito). |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of LocalityAT
Lista de localidades de uma região governamental (Alemanha)
Devolve todas as localidades dentro de uma região governamental alemã.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave da região governamental
|
governmentRegionKey | True | string |
Chave regional da região governamental (3 dígitos). |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of Locality
Lista de municípios de um distrito (Alemanha)
Retorna todos os municípios dentro de um distrito alemão.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave do distrito
|
districtKey | True | string |
Chave regional do distrito (5 dígitos). |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of Municipality
Lista de municípios de um distrito (Áustria)
Retorna todos os municípios dentro de um distrito austríaco.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave do distrito
|
districtKey | True | string |
Identificador do distrito ou código do distrito (3 dígitos). |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of MunicipalityAT
Lista de municípios de um estado federal (Alemanha)
Devolve todos os municípios dentro de um estado federal alemão.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave estadual federal
|
federalStateKey | True | string |
Chave regional do estado federal (2 dígitos). |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of Municipality
Lista de municípios de uma província federal (Áustria)
Retorna todos os municípios dentro de uma província federal austríaca.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave da província federal
|
federalProvinceKey | True | string |
Identificador federal da província (1 dígito). |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of MunicipalityAT
Lista de municípios de uma região governamental (Alemanha)
Retorna todos os municípios dentro de uma região governamental alemã.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave da região governamental
|
governmentRegionKey | True | string |
Chave regional da região governamental (3 dígitos). |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of Municipality
Lista de todas as comunas (Liechtenstein)
Lista de todas as províncias federais (Áustria)
Lista de todos os cantões (Suíça)
Listar regiões governamentais de um estado federal (Alemanha)
Devolve todas as regiões governamentais dentro de um estado federal alemão.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Chave estadual federal
|
federalStateKey | True | string |
Chave regional do estado federal (2 dígitos), por exemplo, '09' para a Baviera. |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of GovernmentRegion
Listar todos os estados federados (Alemanha)
Pesquisa em texto completo para ruas (Liechtenstein)
Pesquisa em texto completo através do nome da rua, código postal e nome da localidade no Liechtenstein.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Termo de pesquisa
|
searchTerm | True | string |
Termo de pesquisa, por exemplo, '9490 Alte Landstrasse'. |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of StreetLI
Pesquisa em texto completo para ruas (Suíça)
Pesquisa em texto completo por nomes de ruas, códigos postais e localidades na Suíça.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Termo de pesquisa
|
searchTerm | True | string |
Termo de pesquisa, por exemplo, 'Zürich Bederstrasse'. |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of StreetCH
Pesquisa em texto completo por ruas, códigos postais e localidades (Alemanha)
Pesquisa em texto completo por nomes de ruas, códigos postais e nomes de localidades na Alemanha.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Termo de pesquisa
|
searchTerm | True | string |
Termo de pesquisa, por exemplo, 'Berlin Pariser Platz'. |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of Street
Pesquisa em texto completo por ruas (Áustria)
Pesquisa em texto completo através do nome da rua, código postal e nome da localidade para o diretório de dados austríaco.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Termo de pesquisa
|
searchTerm | True | string |
Termo de pesquisa, por exemplo, 'Wien Alfred Dallinger Platz'. |
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of StreetAT
Pesquisar ruas (Liechtenstein)
Pesquisa de ruas no Liechtenstein por nome da rua e/ou código postal e/ou localidade. São suportadas expressões regulares.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome da rua
|
name | string |
Nome da rua ou expressão regular. |
|
|
Código postal
|
postalCode | string |
Código postal ou expressão regular. |
|
|
Nome da localidade
|
locality | string |
Nome da localidade ou expressão regular. |
|
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of StreetLI
Pesquisar ruas (Áustria)
Pesquisas por ruas na Áustria por nome da rua e/ou código postal e/ou nome da localidade. Todos os parâmetros suportam expressões regulares.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome da rua
|
name | string |
Nome da rua ou expressão regular. |
|
|
Código postal
|
postalCode | string |
Código postal ou expressão regular. |
|
|
Nome da localidade
|
locality | string |
Nome da localidade ou expressão regular. |
|
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of StreetAT
Pesquise localidades e códigos postais (Alemanha)
Pesquisas por localidades na Alemanha por código postal e/ou nome da localidade. Ambos os parâmetros suportam expressões regulares.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Código postal
|
postalCode | string |
Código postal ou expressão regular (por exemplo, '^13'). |
|
|
Nome da localidade
|
name | string |
Nome da localidade ou expressão regular. |
|
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of Locality
Pesquise localidades e códigos postais (Liechtenstein)
Pesquisas por localidades no Liechtenstein por código postal e/ou nome da localidade. São suportadas expressões regulares.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Código postal
|
postalCode | string |
Código postal ou expressão regular, por exemplo, '^94'. |
|
|
Nome da localidade
|
name | string |
Nome da localidade ou expressão regular. |
|
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of LocalityLI
Pesquise localidades e códigos postais (Suíça)
Pesquisas por localidades na Suíça por código postal e/ou nome da localidade. Ambos os parâmetros suportam expressões regulares.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Código postal
|
postalCode | string |
Código postal ou expressão regular (por exemplo, '^80'). |
|
|
Nome da localidade
|
name | string |
Nome da localidade ou expressão regular. |
|
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of LocalityCH
Pesquise localidades e códigos postais (Áustria)
Pesquisas por localidades na Áustria por código postal e/ou nome da localidade. Ambos os parâmetros suportam expressões regulares.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Código postal
|
postalCode | string |
Código postal ou expressão regular (por exemplo, '^10'). |
|
|
Nome da localidade
|
name | string |
Nome da localidade ou expressão regular. |
|
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of LocalityAT
Procurar ruas (Suíça)
Pesquisas por ruas na Suíça por nome da rua e/ou código postal e/ou nome da localidade. Todos os parâmetros suportam expressões regulares.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome da rua
|
name | string |
Nome da rua ou expressão regular. |
|
|
Código postal
|
postalCode | string |
Código postal ou expressão regular. |
|
|
Nome da localidade
|
locality | string |
Nome da localidade ou expressão regular. |
|
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of StreetCH
Ruas de pesquisa (Alemanha)
Pesquisas por ruas na Alemanha por nome da rua e/ou código postal e/ou nome da localidade. Todos os parâmetros suportam expressões regulares.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Nome da rua
|
name | string |
Nome da rua ou expressão regular. |
|
|
Código postal
|
postalCode | string |
Código postal ou expressão regular. |
|
|
Nome da localidade
|
locality | string |
Nome da localidade ou expressão regular. |
|
|
Índice da página
|
page | integer |
Índice da página (padrão: 1). |
|
|
Tamanho da página
|
pageSize | integer |
Número de itens por página (padrão: 50, máximo: 50). |
Devoluções
- response
- array of Street
Definições
FederalState
Estado federal alemão
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Chave regional (2 dígitos). |
|
nome
|
name | string |
Nome do estado federal. |
|
SedeGoverno
|
seatOfGovernment | string |
Sede do governo do estado federal. |
Região do Governo
Região governamental
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Chave regional (3 dígitos). |
|
nome
|
name | string |
Nome da região governamental. |
|
Sede administrativa
|
administrativeHeadquarters | string |
Sede administrativa da região governamental. |
|
federalEstado
|
federalState | FederalStateSummary |
Resumo de um estado federal |
ResumoRegião do Governo
Resumo de uma região governamental
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Chave regional (3 dígitos). |
|
nome
|
name | string |
Nome da região governamental. |
FederalEstadoResumo
Resumo de um estado federal
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Chave regional (2 dígitos). |
|
nome
|
name | string |
Nome do estado federal. |
Distrito
Distrito
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Chave regional do distrito (5 dígitos). |
|
nome
|
name | string |
Nome do distrito. |
|
tipo
|
type | string |
Tipo de distrito (por exemplo, 'Landkreis', 'Kreisfreie Stadt'). |
|
Sede administrativa
|
administrativeHeadquarters | string |
Sede administrativa do distrito. |
|
governo Região
|
governmentRegion | GovernmentRegionSummary |
Resumo de uma região governamental |
|
federalEstado
|
federalState | FederalStateSummary |
Resumo de um estado federal |
Resumo do Distrito
Resumo de um distrito
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Chave regional do distrito (5 dígitos). |
|
nome
|
name | string |
Nome do distrito. |
Associação Municipal
Associação municipal
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Chave da associação municipal (9 dígitos). |
|
nome
|
name | string |
Nome da associação municipal. |
|
tipo
|
type | string |
Código da associação municipal (por exemplo, 'Amt', 'Verbandsgemeinde'). |
|
Sede administrativa
|
administrativeHeadquarters | string |
Sede administrativa da associação municipal. |
|
Distrito
|
district | DistrictSummary |
Resumo de um distrito |
|
governo Região
|
governmentRegion | GovernmentRegionSummary |
Resumo de uma região governamental |
|
federalEstado
|
federalState | FederalStateSummary |
Resumo de um estado federal |
Resumo da MunicipalAssociação
Resumo de uma associação municipal
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string | |
|
nome
|
name | string | |
|
tipo
|
type | string |
Municipality
Municipality
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Chave regional do município (8 dígitos). |
|
nome
|
name | string |
Nome do município. |
|
tipo
|
type | string |
Código do município (por exemplo, cidade, vila mercantil, cidade livre de distrito, etc.). |
|
postalCode
|
postalCode | string |
Código postal da administração municipal. |
|
múltiplosCódigos Postais
|
multiplePostalCodes | boolean |
O município cobre mais do que um código postal? |
|
associação
|
association | MunicipalAssociationSummary |
Resumo de uma associação municipal |
|
Distrito
|
district | DistrictSummary |
Resumo de um distrito |
|
governo Região
|
governmentRegion | GovernmentRegionSummary |
Resumo de uma região governamental |
|
federalEstado
|
federalState | FederalStateSummary |
Resumo de um estado federal |
Resumo do Município
Resumo de um município
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string | |
|
nome
|
name | string | |
|
tipo
|
type | string |
Localidade
Localidade
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Nome da localidade. |
|
postalCode
|
postalCode | string |
Código postal da localidade. |
|
município
|
municipality | MunicipalitySummary |
Resumo de um município |
|
Distrito
|
district | DistrictSummary |
Resumo de um distrito |
|
governo Região
|
governmentRegion | GovernmentRegionSummary |
Resumo de uma região governamental |
|
federalEstado
|
federalState | FederalStateSummary |
Resumo de um estado federal |
Rua
Rua
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Nome da rua. |
|
postalCode
|
postalCode | string |
Código postal. |
|
Localidade
|
locality | string |
Nome da localidade. |
|
Bairro
|
borough | string |
Município municipal (se disponível). |
|
subúrbio
|
suburb | string |
Subúrbio ou bairro (se disponível). |
|
município
|
municipality | MunicipalitySummary |
Resumo de um município |
|
Distrito
|
district | DistrictSummary |
Resumo de um distrito |
|
governo Região
|
governmentRegion | GovernmentRegionSummary |
Resumo de uma região governamental |
|
federalEstado
|
federalState | FederalStateSummary |
Resumo de um estado federal |
CommuneLI
Comuna no Liechtenstein
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Número da comuna (4 dígitos). |
|
nome
|
name | string |
Nome oficial da comuna. |
|
Distrito eleitoral
|
electoralDistrict | string |
Círculo eleitoral – Oberland ou Unterland. |
LocalidadeLI
Localidade no Liechtenstein
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
nome
|
name | string |
Nome da localidade. |
|
postalCode
|
postalCode | string |
Código postal da localidade. |
|
chave
|
commune.key | string |
Número da comuna (4 dígitos). |
|
nome
|
commune.name | string |
Nome oficial da comuna. |
StreetLI
Rua no Liechtenstein
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Chave de rua. |
|
nome
|
name | string |
Nome da rua. |
|
estado
|
status | string |
Estado de rua (Planeado, Real, Desatualizado). |
|
postalCode
|
postalCode | string |
Código postal. |
|
Localidade
|
locality | string |
Nome da localidade. |
|
chave
|
commune.key | string |
Número da comuna (4 dígitos). |
|
nome
|
commune.name | string |
Nome oficial da comuna. |
CantonCH
Cantão da Suíça
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Número BFS do cantão (máximo 2 dígitos). |
|
historicalCode
|
historicalCode | string |
Código histórico do cantão. |
|
nome
|
name | string |
Nome do cantão. |
|
shortNome
|
shortName | string |
Abreviatura do cantão (2 letras). |
CantonCHSummary
Resumo de um cantão suíço
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Número BFS do cantão (máximo 2 dígitos). |
|
nome
|
name | string |
Nome do cantão. |
|
shortNome
|
shortName | string |
Abreviatura do cantão (2 letras). |
DistritoCH
Distrito na Suíça
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Número BFS do distrito (máximo 4 dígitos). |
|
historicalCode
|
historicalCode | string |
Código histórico do distrito. |
|
nome
|
name | string |
Nome do distrito. |
|
shortNome
|
shortName | string |
Nome abreviado do distrito. |
|
Cantão
|
canton | CantonCHSummary |
Resumo de um cantão suíço |
DistritoCHSummary
Resumo de um distrito suíço
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Número BFS do distrito (máximo 4 dígitos). |
|
nome
|
name | string |
Nome do distrito. |
|
shortNome
|
shortName | string |
Nome abreviado do distrito. |
ComuneCH
Comuna na Suíça
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Número BFS da comuna (máximo 4 dígitos). |
|
historicalCode
|
historicalCode | string |
Código histórico da comuna. |
|
nome
|
name | string |
Nome oficial da comuna. |
|
shortNome
|
shortName | string |
Nome abreviado da comuna. |
|
Distrito
|
district | DistrictCHSummary |
Resumo de um distrito suíço |
|
Cantão
|
canton | CantonCHSummary |
Resumo de um cantão suíço |
Município de Câmara
Resumo de uma comuna suíça
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Número BFS da comuna (máximo 4 dígitos). |
|
nome
|
name | string |
Nome da comuna. |
|
shortNome
|
shortName | string |
Nome abreviado da comuna. |
LocalidadeCH
Localidade na Suíça
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Identificador de localidade. |
|
nome
|
name | string |
Nome da localidade. |
|
código postal
|
postalcode | string |
Código postal da localidade. |
|
Comuna
|
commune | CommuneCHSummary |
Resumo de uma comuna suíça |
|
Distrito
|
district | DistrictCHSummary |
Resumo de um distrito suíço |
|
Cantão
|
canton | CantonCHSummary |
Resumo de um cantão suíço |
StreetCH
Rua na Suíça
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Chave de rua. |
|
nome
|
name | string |
Nome da rua. |
|
estado
|
status | string |
Estado de rua. Valores possíveis: Planeados, Reais, Desatualizados. |
|
código postal
|
postalcode | string |
Código postal da localidade. |
|
Localidade
|
locality | string |
Nome da localidade. |
|
Comuna
|
commune | CommuneCHSummary |
Resumo de uma comuna suíça |
|
Distrito
|
district | DistrictCHSummary |
Resumo de um distrito suíço |
|
Cantão
|
canton | CantonCHSummary |
Resumo de um cantão suíço |
FederalProvinceAT
Província federal na Áustria
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Identificador federal da província (1 dígito). |
|
nome
|
name | string |
Nome da província federal. |
Província FederalATSumaria
Resumo de uma província federal austríaca
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Identificador federal da província (1 dígito). |
|
nome
|
name | string |
Nome da província federal. |
DistrictAT
Distrito na Áustria
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Identificador do distrito (3 dígitos). |
|
código
|
code | string |
Código do distrito (3 dígitos). |
|
nome
|
name | string |
Nome do distrito. |
|
Província federal
|
federalProvince | FederalProvinceATSummary |
Resumo de uma província federal austríaca |
DistritoATSummary
Resumo de um distrito austríaco
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Identificador do distrito (3 dígitos). |
|
código
|
code | string |
Código do distrito (3 dígitos). |
|
nome
|
name | string |
Nome do distrito. |
Município AT
Município na Áustria
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Identificador municipal (5 dígitos). |
|
código
|
code | string |
Código municipal (5 dígitos). |
|
nome
|
name | string |
Nome do município. |
|
estado
|
status | string |
Estatuto do município (por exemplo, cidade, vila mercantil, etc.). |
|
postalCode
|
postalCode | string |
Código postal da câmara municipal. |
|
múltiplosCódigos Postais
|
multiplePostalCodes | boolean |
O município cobre mais do que um código postal? |
|
Distrito
|
district | DistrictATSummary |
Resumo de um distrito austríaco |
|
Província federal
|
federalProvince | FederalProvinceATSummary |
Resumo de uma província federal austríaca |
MunicípioATSummary
Resumo de um município austríaco
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Identificador municipal (5 dígitos). |
|
código
|
code | string |
Código municipal (5 dígitos). |
|
nome
|
name | string |
Nome do município. |
LocalidadeAT
Localidade na Áustria
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Identificador de localidade. |
|
nome
|
name | string |
Nome da localidade. |
|
código postal
|
postalcode | string |
Código postal da localidade. |
|
município
|
municipality | MunicipalityATSummary |
Resumo de um município austríaco |
|
Distrito
|
district | DistrictATSummary |
Resumo de um distrito austríaco |
|
Província federal
|
federalProvince | FederalProvinceATSummary |
Resumo de uma província federal austríaca |
StreetAT
Rua na Áustria
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
chave
|
key | string |
Identificador de rua. |
|
nome
|
name | string |
Nome da rua. |
|
código postal
|
postalcode | string |
Código postal da localidade. |
|
Localidade
|
locality | string |
Nome da localidade. |
|
município
|
municipality | MunicipalityATSummary |
Resumo de um município austríaco |
|
Distrito
|
district | DistrictATSummary |
Resumo de um distrito austríaco |
|
Província federal
|
federalProvince | FederalProvinceATSummary |
Resumo de uma província federal austríaca |