Partager via

OpenPLZ (Éditeur indépendant) (préversion)

API OpenPLZ : API de code postal et de rue publique pour l’Allemagne, le Liechtenstein, la Suisse et l’Autriche.

Documentation: https://www.openplzapi.org/de/germany/

Ce connecteur est disponible dans les produits et régions suivants :

Service classe Régions
Copilot Studio Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Applications logiques Norme Toutes les régions Logic Apps , à l’exception des suivantes :
     - Régions Azure Government
     - Régions Azure Chine
     - Us Department of Defense (DoD)
Power Apps Premium Toutes les régions Power Apps , à l’exception des suivantes :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Contact
Nom OpenPLZ API
URL https://www.openplzapi.org
Métadonnées du connecteur
Éditeur LowCodeInvestigator
Site internet https://www.openplzapi.org
Politique de confidentialité https://www.openplzapi.org/legal/privacy-policy
Catégories Data
Visibilité Important

Connecteur d’API OpenPLZ

OpenPLZ API Connector fournit un accès structuré aux codes postaux, aux rues, aux divisions administratives et aux données de localité pour l’Allemagne, la Suisse, l’Autriche et le Liechtenstein. Il permet aux solutions Microsoft Power Platform d’interroger des jeux de données d’emplacement fiables et normalisés dans un format REST.

Ce connecteur expose plusieurs opérations en lecture seule qui permettent la récupération d’informations hiérarchiques telles que les états fédéraux, les cantons, les districts, les municipalités, les localités, les codes postaux et les rues.

Éditeur

OpenPLZ API

Fonctionnalités prises en charge

Le connecteur d’API OpenPLZ prend en charge les fonctionnalités suivantes :

  • Récupérer des hiérarchies administratives (états fédéraux, canton, districts, municipalités, associations municipales, localités)
  • Effectuer des recherches de code postal
  • Interroger des répertoires de rue
  • Travailler avec la couverture inter-pays (Allemagne, Suisse, Autriche, Liechtenstein)
  • Utiliser des formats de réponse JSON cohérents adaptés à l’automatisation et à la validation

Prerequisites

Aucun prérequis n’est requis pour utiliser ce connecteur :

  • Aucune clé API
  • Aucun OAuth
  • Aucune authentification
  • Aucun abonnement

L’API est accessible publiquement.

Guide pratique pour utiliser le connecteur

  1. Ajoutez le connecteur d’API OpenPLZ à votre flux Power App ou Power Automate.
  2. Choisissez l’une des actions disponibles.
  3. Fournissez les paramètres requis.
  4. Utilisez les données JSON retournées dans votre flux de travail ou votre application (par exemple, pour remplir des listes déroulantes, valider des adresses ou stocker des données d’emplacement structuré).

Informations de connexion

Le connecteur utilise une connexion anonyme unique. Aucune information d’identification n’est requise.

Limites connues

  • API en lecture seule (seules les opérations GET sont disponibles)
  • Limitation de débit potentielle pour les demandes excessives ou à fréquence élevée
  • Aucune donnée de limite de géocoordinates ou de polygones
  • Les noms d’administration et de localité suivent les conventions d’affectation de noms en langue allemande

Documentation de l’API

Les sections suivantes décrivent une séquence recommandée d’appels d’API pour récupérer des structures administratives hiérarchiques dans un ordre logique pour chaque pays.

Allemagne (DE)

Allemagne – Données de base

  • GET /de/FederalStates (Lister tous les états fédéraux (Allemagne))

Allemagne – Niveau d’état fédéral (à l’aide de federalStateKey)

  • GET /de/FederalStates/{federalStateKey}/GovernmentRegions (Lister les régions gouvernementales d’un état fédéral (Allemagne))
  • GET /de/FederalStates/{federalStateKey}/Districts (Lister les districts d’un état fédéral (Allemagne))
  • GET /de/FederalStates/{federalStateKey}/Municipalités (Lister les municipalités d’un état fédéral (Allemagne))
  • GET /de/FederalStates/{federalStateKey}/MunicipalAssociations (Lister les associations municipales d’un état fédéral (Allemagne))
  • GET /de/FederalStates/{federalStateKey}/Localités (Répertorier les localités d’un état fédéral (Allemagne))

Allemagne – Niveau de région du gouvernement (à l’aide de governmentRegionKey)

  • GET /de/GovernmentRegions/{governmentRegionKey}/Districts (Lister les districts d’une région gouvernementale (Allemagne))
  • GET /de/GovernmentRegions/{governmentRegionKey}/Municipalités (Lister les municipalités d’une région gouvernementale (Allemagne))
  • GET /de/GovernmentRegions/{governmentRegionKey}/MunicipalAssociations (Lister les associations municipales d’une région gouvernementale (Allemagne))
  • GET /de/GovernmentRegions/{governmentRegionKey}/Localités (Répertorier les localités d’une région gouvernementale (Allemagne))

Allemagne – Niveau de district (à l’aide de districtKey)

  • GET /de/Districts/{districtKey}/Municipalités (Lister les municipalités d’un district (Allemagne))
  • GET /de/Districts/{districtKey}/MunicipalAssociations (Lister les associations municipales d’un district (Allemagne))
  • GET /de/Districts/{districtKey}/Localités (Lister les localités d’un district (Allemagne))

Allemagne – Points de terminaison de recherche

  • GET /de/Localités (localités de recherche et codes postaux (Allemagne))
  • GET /de/Streets (Rues de recherche (Allemagne))
  • GET /de/FullTextSearch (recherche en texte intégral pour les rues, les codes postaux et les localités (Allemagne))

Liechtenstein (LI)

Liechtenstein – Données de base

  • GET /li/Communes (Lister toutes les communes (Liechtenstein))

Liechtenstein – Points de terminaison de recherche

  • GET /li/Localités (localités de recherche et codes postaux (Liechtenstein))
  • GET /li/Streets (Search streets (Liechtenstein))
  • GET /li/FullTextSearch (recherche en texte intégral pour les rues (Liechtenstein))

Suisse (CH)

Suisse – Données de base

  • GET /ch/Canton (Lister tous les cantons (Suisse))

Suisse – Niveau du canton (à l’aide de cantonKey)

  • GET /ch/Canton/{cantonKey}/Districts (Lister les districts d’un canton (Suisse))
  • GET /ch/Canton/{cantonKey}/Communes (Liste des communes d’un canton (Suisse))
  • GET /ch/Canton/{cantonKey}/Localités (Lister les localités d’un canton (Suisse))

Suisse – Niveau de district (à l’aide de districtKey)

  • GET /ch/Districts/{districtKey}/Communes (Liste des communes d’un district (Suisse))
  • GET /ch/Districts/{districtKey}/Localités (Lister les localités d’un district (Suisse))

Suisse – Points de terminaison de recherche

  • GET /ch/Localités (localités de recherche et codes postaux (Suisse))
  • GET /ch/Streets (Rues de recherche (Suisse))
  • GET /ch/FullTextSearch (recherche en texte intégral pour les rues (Suisse))

Autriche (AT)

Autriche – Données de base

  • GET /at/FederalProvinces (Lister toutes les provinces fédérales (Autriche))

Autriche – Niveau de la province fédérale (à l’aide de federalProvinceKey)

  • GET /at/FederalProvinces/{federalProvinceKey}/Districts (Lister les districts d’une province fédérale (Autriche))
  • GET /at/FederalProvinces/{federalProvinceKey}/Municipalités (Lister les municipalités d’une province fédérale (Autriche))
  • GET /at/FederalProvinces/{federalProvinceKey}/Localités (Lister les localités d’une province fédérale (Autriche))

Autriche – Niveau de district (à l’aide de districtKey)

  • GET /at/Districts/{districtKey}/Municipalités (Lister les municipalités d’un district (Autriche))
  • GET /at/Districts/{districtKey}/Localités (Lister les localités d’un district (Autriche))

Autriche – Points de terminaison de recherche

  • GET /at/Localities (Localités de recherche et codes postaux (Autriche))
  • GET /at/Streets (Rues de recherche (Autriche))
  • GET /at/FullTextSearch (recherche en texte intégral pour les rues (Autriche))

Limites de limitation

Nom Appels Période de renouvellement
Appels d’API par connexion 100 60 secondes

Actions

Lister les communes d’un canton (Suisse)

Retourne toutes les communes d’un canton suisse.
Lister les municipalités d’un district (Allemagne)

Retourne toutes les municipalités dans un district allemand.
Lister les municipalités d’un district (Autriche)

Retourne toutes les municipalités dans un district autrichien.
Localités de recherche et codes postaux (Autriche)

Recherche des localités en Autriche par code postal et/ou nom de localité. Les deux paramètres prennent en charge les expressions régulières.
Recherche dans les rues (Allemagne)

Recherche des rues en Allemagne par nom de rue et/ou code postal et/ou nom de localité. Tous les paramètres prennent en charge les expressions régulières.
Recherche en texte intégral dans les rues (Liechtenstein)

Recherche en texte intégral sur le nom de la rue, le code postal et le nom de localité au Liechtenstein.
Recherche en texte intégral pour les rues, les codes postaux et les localités (Allemagne)

Recherche en texte intégral sur les noms de rues, les codes postaux et les noms de localité en Allemagne.
Recherche en texte intégral pour les rues (Autriche)

Recherche en texte intégral sur le nom de la rue, le code postal et le nom de localité pour le répertoire de données autrichien.
Recherche en texte intégral pour les rues (Suisse)

Recherche en texte intégral sur les noms de rues, les codes postaux et les noms de localité en Suisse.
Rechercher des localités et des codes postaux (Allemagne)

Recherche des localités en Allemagne par code postal et/ou nom de localité. Les deux paramètres prennent en charge les expressions régulières.
Rechercher des localités et des codes postaux (Liechtenstein)

Recherche des localités au Liechtenstein par code postal et/ou nom de localité. Les expressions régulières sont prises en charge.
Rechercher des localités et des codes postaux (Suisse)

Recherche des localités en Suisse par code postal et/ou nom de localité. Les deux paramètres prennent en charge les expressions régulières.
Rues de recherche (Autriche)

Recherche des rues en Autriche par nom de rue et/ou code postal et/ou nom de localité. Tous les paramètres prennent en charge les expressions régulières.
Rues de recherche (Liechtenstein)

Recherche des rues au Liechtenstein par nom de rue et/ou code postal et/ou localité. Les expressions régulières sont prises en charge.
Rues de recherche (Suisse)

Recherche des rues en Suisse par nom de rue et/ou code postal et/ou nom de localité. Tous les paramètres prennent en charge les expressions régulières.
Répertorier les associations municipales d’un district (Allemagne)

Retourne toutes les associations municipales au sein d’un district allemand.
Répertorier les associations municipales d’un état fédéral (Allemagne)

Retourne toutes les associations municipales au sein d’un État fédéral allemand.
Répertorier les associations municipales d’une région gouvernementale (Allemagne)

Retourne toutes les associations municipales au sein d’une région gouvernementale allemande.
Répertorier les communes d’un district (Suisse)

Retourne toutes les communes d’un district suisse.
Répertorier les districts d’un canton (Suisse)

Retourne tous les districts d’un canton suisse.
Répertorier les districts d’un état fédéral (Allemagne)

Retourne tous les districts au sein d’un État fédéral allemand.
Répertorier les districts d’une province fédérale (Autriche)

Retourne tous les districts dans une province fédérale autrichienne.
Répertorier les districts d’une région gouvernementale (Allemagne)

Retourne tous les districts d’une région gouvernementale allemande.
Répertorier les localités d’un canton (Suisse)

Retourne toutes les localités d’un canton suisse.
Répertorier les localités d’un district (Allemagne)

Retourne toutes les localités d’un district allemand.
Répertorier les localités d’un district (Autriche)

Retourne toutes les localités dans un district autrichien.
Répertorier les localités d’un district (Suisse)

Retourne toutes les localités d’un district suisse.
Répertorier les localités d’un état fédéral (Allemagne)

Retourne toutes les localités au sein d’un État fédéral allemand.
Répertorier les localités d’une province fédérale (Autriche)

Retourne toutes les localités dans une province fédérale autrichienne.
Répertorier les localités d’une région gouvernementale (Allemagne)

Retourne toutes les localités au sein d’une région gouvernementale allemande.
Répertorier les municipalités d’un état fédéral (Allemagne)

Retourne toutes les municipalités au sein d’un État fédéral allemand.
Répertorier les municipalités d’une province fédérale (Autriche)

Retourne toutes les municipalités dans une province fédérale autrichienne.
Répertorier les municipalités d’une région gouvernementale (Allemagne)

Retourne toutes les municipalités au sein d’une région gouvernementale allemande.
Répertorier les régions gouvernementales d’un état fédéral (Allemagne)

Retourne toutes les régions gouvernementales au sein d’un État fédéral allemand.
Répertorier tous les cantons (Suisse)

Retourne les 26 cantons de Suisse.
Répertorier tous les États fédéraux (Allemagne)

Retourne tous les États fédéraux allemands.
Répertorier toutes les communes (Liechtenstein)

Retourne toutes les 11 communes de la Principale du Liechtenstein.
Répertorier toutes les provinces fédérales (Autriche)

Retourne toutes les 9 provinces fédérales en Autriche.

Lister les communes d’un canton (Suisse)

ID de l’opération :
GetCommunesByCantonCH

Retourne toutes les communes d’un canton suisse.

Paramètres

Nom Clé Obligatoire Type Description
Clé de canton
 cantonKey True string

Nombre BFS du canton (max. 2 chiffres).
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of CommuneCH

Lister les municipalités d’un district (Allemagne)

ID de l’opération :
GetMunicipalitiesByDistrictDE

Retourne toutes les municipalités dans un district allemand.

Paramètres

Nom Clé Obligatoire Type Description
Clé de district
 districtKey True string

Clé régionale du district (5 chiffres).
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of Municipality

Lister les municipalités d’un district (Autriche)

ID de l’opération :
GetMunicipalitiesByDistrictAT

Retourne toutes les municipalités dans un district autrichien.

Paramètres

Nom Clé Obligatoire Type Description
Clé de district
 districtKey True string

Identificateur de district ou code de district (3 chiffres).
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of MunicipalityAT

Localités de recherche et codes postaux (Autriche)

ID de l’opération :
SearchLocalitiesAT

Recherche des localités en Autriche par code postal et/ou nom de localité. Les deux paramètres prennent en charge les expressions régulières.

Paramètres

Nom Clé Obligatoire Type Description
Code postal
 postalCode string

Code postal ou expression régulière (par exemple, '^10').
Nom de la localité
 name string

Nom de localité ou expression régulière.
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of LocalityAT

Recherche dans les rues (Allemagne)

ID de l’opération :
SearchStreetsDE

Recherche des rues en Allemagne par nom de rue et/ou code postal et/ou nom de localité. Tous les paramètres prennent en charge les expressions régulières.

Paramètres

Nom Clé Obligatoire Type Description
Nom de rue
 name string

Nom de rue ou expression régulière.
Code postal
 postalCode string

Code postal ou expression régulière.
Nom de la localité
 locality string

Nom de localité ou expression régulière.
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of Street

Recherche en texte intégral dans les rues (Liechtenstein)

ID de l’opération :
FullTextSearchLI

Recherche en texte intégral sur le nom de la rue, le code postal et le nom de localité au Liechtenstein.

Paramètres

Nom Clé Obligatoire Type Description
Terme recherché
 searchTerm True string

Terme de recherche, par exemple « 9490 Alte Landß ».
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of StreetLI

Recherche en texte intégral pour les rues, les codes postaux et les localités (Allemagne)

ID de l’opération :
FullTextSearchDE

Recherche en texte intégral sur les noms de rues, les codes postaux et les noms de localité en Allemagne.

Paramètres

Nom Clé Obligatoire Type Description
Terme recherché
 searchTerm True string

Terme de recherche, par exemple « Berlin Pariser Platz ».
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of Street

Recherche en texte intégral pour les rues (Autriche)

ID de l’opération :
FullTextSearchAT

Recherche en texte intégral sur le nom de la rue, le code postal et le nom de localité pour le répertoire de données autrichien.

Paramètres

Nom Clé Obligatoire Type Description
Terme recherché
 searchTerm True string

Terme de recherche, par exemple « Wien Alfred Dallinger Linger ».
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of StreetAT

Recherche en texte intégral pour les rues (Suisse)

ID de l’opération :
FullTextSearchCH

Recherche en texte intégral sur les noms de rues, les codes postaux et les noms de localité en Suisse.

Paramètres

Nom Clé Obligatoire Type Description
Terme recherché
 searchTerm True string

Terme de recherche, par exemple « Zürich Bederß ».
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of StreetCH

Rechercher des localités et des codes postaux (Allemagne)

ID de l’opération :
SearchLocalitiesDE

Recherche des localités en Allemagne par code postal et/ou nom de localité. Les deux paramètres prennent en charge les expressions régulières.

Paramètres

Nom Clé Obligatoire Type Description
Code postal
 postalCode string

Code postal ou expression régulière (par exemple, '^13').
Nom de la localité
 name string

Nom de localité ou expression régulière.
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of Locality

Rechercher des localités et des codes postaux (Liechtenstein)

ID de l’opération :
SearchLocalitiesLI

Recherche des localités au Liechtenstein par code postal et/ou nom de localité. Les expressions régulières sont prises en charge.

Paramètres

Nom Clé Obligatoire Type Description
Code postal
 postalCode string

Code postal ou expression régulière, par exemple « ^94 ».
Nom de la localité
 name string

Nom de localité ou expression régulière.
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of LocalityLI

Rechercher des localités et des codes postaux (Suisse)

ID de l’opération :
SearchLocalitiesCH

Recherche des localités en Suisse par code postal et/ou nom de localité. Les deux paramètres prennent en charge les expressions régulières.

Paramètres

Nom Clé Obligatoire Type Description
Code postal
 postalCode string

Code postal ou expression régulière (par exemple, '^80').
Nom de la localité
 name string

Nom de localité ou expression régulière.
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of LocalityCH

Rues de recherche (Autriche)

ID de l’opération :
SearchStreetsAT

Recherche des rues en Autriche par nom de rue et/ou code postal et/ou nom de localité. Tous les paramètres prennent en charge les expressions régulières.

Paramètres

Nom Clé Obligatoire Type Description
Nom de rue
 name string

Nom de rue ou expression régulière.
Code postal
 postalCode string

Code postal ou expression régulière.
Nom de la localité
 locality string

Nom de localité ou expression régulière.
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of StreetAT

Rues de recherche (Liechtenstein)

ID de l’opération :
SearchStreetsLI

Recherche des rues au Liechtenstein par nom de rue et/ou code postal et/ou localité. Les expressions régulières sont prises en charge.

Paramètres

Nom Clé Obligatoire Type Description
Nom de rue
 name string

Nom de rue ou expression régulière.
Code postal
 postalCode string

Code postal ou expression régulière.
Nom de la localité
 locality string

Nom de localité ou expression régulière.
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of StreetLI

Rues de recherche (Suisse)

ID de l’opération :
SearchStreetsCH

Recherche des rues en Suisse par nom de rue et/ou code postal et/ou nom de localité. Tous les paramètres prennent en charge les expressions régulières.

Paramètres

Nom Clé Obligatoire Type Description
Nom de rue
 name string

Nom de rue ou expression régulière.
Code postal
 postalCode string

Code postal ou expression régulière.
Nom de la localité
 locality string

Nom de localité ou expression régulière.
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of StreetCH

Répertorier les associations municipales d’un district (Allemagne)

ID de l’opération :
GetMunicipalAssociationsByDistrictDE

Retourne toutes les associations municipales au sein d’un district allemand.

Paramètres

Nom Clé Obligatoire Type Description
Clé de district
 districtKey True string

Clé régionale du district (5 chiffres).
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of MunicipalAssociation

Répertorier les associations municipales d’un état fédéral (Allemagne)

ID de l’opération :
GetMunicipalAssociationsByFederalStateDE

Retourne toutes les associations municipales au sein d’un État fédéral allemand.

Paramètres

Nom Clé Obligatoire Type Description
Clé d’état fédéral
 federalStateKey True string

Clé régionale de l’État fédéral (2 chiffres).
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of MunicipalAssociation

Répertorier les associations municipales d’une région gouvernementale (Allemagne)

ID de l’opération :
GetMunicipalAssociationsByGovernmentRegionDE

Retourne toutes les associations municipales au sein d’une région gouvernementale allemande.

Paramètres

Nom Clé Obligatoire Type Description
Clé de région du gouvernement
 governmentRegionKey True string

Clé régionale de la région gouvernementale (3 chiffres).
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of MunicipalAssociation

Répertorier les communes d’un district (Suisse)

ID de l’opération :
GetCommunesByDistrictCH

Retourne toutes les communes d’un district suisse.

Paramètres

Nom Clé Obligatoire Type Description
Clé de district
 districtKey True string

Nombre BFS du district (max. 4 chiffres).
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of CommuneCH

Répertorier les districts d’un canton (Suisse)

ID de l’opération :
GetDistrictsByCantonCH

Retourne tous les districts d’un canton suisse.

Paramètres

Nom Clé Obligatoire Type Description
Clé de canton
 cantonKey True string

Nombre BFS du canton (max. 2 chiffres), par exemple « 10 » pour Le Canton.
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of DistrictCH

Répertorier les districts d’un état fédéral (Allemagne)

ID de l’opération :
GetDistrictsByFederalStateDE

Retourne tous les districts au sein d’un État fédéral allemand.

Paramètres

Nom Clé Obligatoire Type Description
Clé d’état fédéral
 federalStateKey True string

Clé régionale de l’État fédéral (2 chiffres).
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of District

Répertorier les districts d’une province fédérale (Autriche)

ID de l’opération :
GetDistrictsByFederalProvinceAT

Retourne tous les districts dans une province fédérale autrichienne.

Paramètres

Nom Clé Obligatoire Type Description
Clé de la province fédérale
 federalProvinceKey True string

Identificateur de la province fédérale (1 chiffre).
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of DistrictAT

Répertorier les districts d’une région gouvernementale (Allemagne)

ID de l’opération :
GetDistrictsByGovernmentRegionDE

Retourne tous les districts d’une région gouvernementale allemande.

Paramètres

Nom Clé Obligatoire Type Description
Clé de région du gouvernement
 governmentRegionKey True string

Clé régionale de la région gouvernementale (3 chiffres).
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of District

Répertorier les localités d’un canton (Suisse)

ID de l’opération :
GetLocalitiesByCantonCH

Retourne toutes les localités d’un canton suisse.

Paramètres

Nom Clé Obligatoire Type Description
Clé de canton
 cantonKey True string

Nombre BFS du canton (max. 2 chiffres).
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of LocalityCH

Répertorier les localités d’un district (Allemagne)

ID de l’opération :
GetLocalitiesByDistrictDE

Retourne toutes les localités d’un district allemand.

Paramètres

Nom Clé Obligatoire Type Description
Clé de district
 districtKey True string

Clé régionale du district (5 chiffres).
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of Locality

Répertorier les localités d’un district (Autriche)

ID de l’opération :
GetLocalitiesByDistrictAT

Retourne toutes les localités dans un district autrichien.

Paramètres

Nom Clé Obligatoire Type Description
Clé de district
 districtKey True string

Identificateur de district ou code de district (3 chiffres).
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of LocalityAT

Répertorier les localités d’un district (Suisse)

ID de l’opération :
GetLocalitiesByDistrictCH

Retourne toutes les localités d’un district suisse.

Paramètres

Nom Clé Obligatoire Type Description
Clé de district
 districtKey True string

Nombre BFS du district (max. 4 chiffres).
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of LocalityCH

Répertorier les localités d’un état fédéral (Allemagne)

ID de l’opération :
GetLocalitiesByFederalStateDE

Retourne toutes les localités au sein d’un État fédéral allemand.

Paramètres

Nom Clé Obligatoire Type Description
Clé d’état fédéral
 federalStateKey True string

Clé régionale de l’État fédéral (2 chiffres).
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of Locality

Répertorier les localités d’une province fédérale (Autriche)

ID de l’opération :
GetLocalitiesByFederalProvinceAT

Retourne toutes les localités dans une province fédérale autrichienne.

Paramètres

Nom Clé Obligatoire Type Description
Clé de la province fédérale
 federalProvinceKey True string

Identificateur de la province fédérale (1 chiffre).
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of LocalityAT

Répertorier les localités d’une région gouvernementale (Allemagne)

ID de l’opération :
GetLocalitiesByGovernmentRegionDE

Retourne toutes les localités au sein d’une région gouvernementale allemande.

Paramètres

Nom Clé Obligatoire Type Description
Clé de région du gouvernement
 governmentRegionKey True string

Clé régionale de la région gouvernementale (3 chiffres).
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of Locality

Répertorier les municipalités d’un état fédéral (Allemagne)

ID de l’opération :
GetMunicipalitiesByFederalStateDE

Retourne toutes les municipalités au sein d’un État fédéral allemand.

Paramètres

Nom Clé Obligatoire Type Description
Clé d’état fédéral
 federalStateKey True string

Clé régionale de l’État fédéral (2 chiffres).
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of Municipality

Répertorier les municipalités d’une province fédérale (Autriche)

ID de l’opération :
GetMunicipalitiesByFederalProvinceAT

Retourne toutes les municipalités dans une province fédérale autrichienne.

Paramètres

Nom Clé Obligatoire Type Description
Clé de la province fédérale
 federalProvinceKey True string

Identificateur de la province fédérale (1 chiffre).
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of MunicipalityAT

Répertorier les municipalités d’une région gouvernementale (Allemagne)

ID de l’opération :
GetMunicipalitiesByGovernmentRegionDE

Retourne toutes les municipalités au sein d’une région gouvernementale allemande.

Paramètres

Nom Clé Obligatoire Type Description
Clé de région du gouvernement
 governmentRegionKey True string

Clé régionale de la région gouvernementale (3 chiffres).
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of Municipality

Répertorier les régions gouvernementales d’un état fédéral (Allemagne)

ID de l’opération :
GetGovernmentRegionsByFederalStateDE

Retourne toutes les régions gouvernementales au sein d’un État fédéral allemand.

Paramètres

Nom Clé Obligatoire Type Description
Clé d’état fédéral
 federalStateKey True string

Clé régionale de l’État fédéral (2 chiffres), par exemple « 09 » pour la Bavière.
Index de page
 page integer

Index de page (valeur par défaut : 1).
Taille de la page
 pageSize integer

Nombre d’éléments par page (valeur par défaut : 50, max : 50).

Retourne

response
array of GovernmentRegion

Répertorier tous les cantons (Suisse)

ID de l’opération :
GetCantonsCH

Retourne les 26 cantons de Suisse.

Retourne

response
array of CantonCH

Répertorier tous les États fédéraux (Allemagne)

ID de l’opération :
GetFederalStatesDE

Retourne tous les États fédéraux allemands.

Retourne

response
array of FederalState

Répertorier toutes les communes (Liechtenstein)

ID de l’opération :
GetCommunesLI

Retourne toutes les 11 communes de la Principale du Liechtenstein.

Retourne

response
array of CommuneLI

Répertorier toutes les provinces fédérales (Autriche)

ID de l’opération :
GetFederalProvincesAT

Retourne toutes les 9 provinces fédérales en Autriche.

Retourne

response
array of FederalProvinceAT

Définitions

FederalState

État fédéral allemand

Nom Chemin Type Description
key
 key string

Clé régionale (2 chiffres).
nom
 name string

Nom de l’état fédéral.
seatOfGovernment
 seatOfGovernment string

Siège du gouvernement de l’État fédéral.

GovernmentRegion

Région gouvernementale

Nom Chemin Type Description
key
 key string

Clé régionale (3 chiffres).
nom
 name string

Nom de la région gouvernementale.
administrativeHeadquarters
 administrativeHeadquarters string

Siège administratif de la région gouvernementale.
federalState
 federalState FederalStateSummary

Résumé d’un état fédéral

GovernmentRegionSummary

Résumé d’une région gouvernementale

Nom Chemin Type Description
key
 key string

Clé régionale (3 chiffres).
nom
 name string

Nom de la région gouvernementale.

FederalStateSummary

Résumé d’un état fédéral

Nom Chemin Type Description
key
 key string

Clé régionale (2 chiffres).
nom
 name string

Nom de l’état fédéral.

District

District

Nom Chemin Type Description
key
 key string

Clé régionale du district (5 chiffres).
nom
 name string

Nom du district.
type
 type string

Type du district (par exemple, « Landkreis », « Kreisfreie Stadt »).
administrativeHeadquarters
 administrativeHeadquarters string

Siège administratif du district.
governmentRegion
 governmentRegion GovernmentRegionSummary

Résumé d’une région gouvernementale
federalState
 federalState FederalStateSummary

Résumé d’un état fédéral

DistrictSummary

Résumé d’un district

Nom Chemin Type Description
key
 key string

Clé régionale du district (5 chiffres).
nom
 name string

Nom du district.

MunicipalAssociation

Association municipale

Nom Chemin Type Description
key
 key string

Clé de l’association municipale (9 chiffres).
nom
 name string

Nom de l’association municipale.
type
 type string

Code de l’association municipale (par exemple, 'Amt', 'Verbandsgemeinde').
administrativeHeadquarters
 administrativeHeadquarters string

Siège administratif de l’association municipale.
quartier
 district DistrictSummary

Résumé d’un district
governmentRegion
 governmentRegion GovernmentRegionSummary

Résumé d’une région gouvernementale
federalState
 federalState FederalStateSummary

Résumé d’un état fédéral

MunicipalAssociationSummary

Résumé d’une association municipale

Nom Chemin Type Description
key
 key string
nom
 name string
type
 type string

Municipality

Municipality

Nom Chemin Type Description
key
 key string

Clé régionale de la municipalité (8 chiffres).
nom
 name string

Nom de la municipalité.
type
 type string

Code de la municipalité (par exemple, ville, ville de marché, ville sans quartier, etc.).
postalCode
 postalCode string

Code postal de l’administration municipale.
multiplePostalCodes
 multiplePostalCodes boolean

La municipalité couvre-t-elle plusieurs codes postaux ?
association
 association MunicipalAssociationSummary

Résumé d’une association municipale
quartier
 district DistrictSummary

Résumé d’un district
governmentRegion
 governmentRegion GovernmentRegionSummary

Résumé d’une région gouvernementale
federalState
 federalState FederalStateSummary

Résumé d’un état fédéral

MunicipalitéSummary

Résumé d’une municipalité

Nom Chemin Type Description
key
 key string
nom
 name string
type
 type string

Localité

Localité

Nom Chemin Type Description
nom
 name string

Nom de la localité.
postalCode
 postalCode string

Code postal de la localité.
municipalité
 municipality MunicipalitySummary

Résumé d’une municipalité
quartier
 district DistrictSummary

Résumé d’un district
governmentRegion
 governmentRegion GovernmentRegionSummary

Résumé d’une région gouvernementale
federalState
 federalState FederalStateSummary

Résumé d’un état fédéral

Rue

Rue

Nom Chemin Type Description
nom
 name string

Nom de rue.
postalCode
 postalCode string

Code postal.
localité
 locality string

Nom de la localité.
arrondissement
 borough string

Arrondissement de la ville (le cas échéant).
banlieue
 suburb string

Banlieue ou trimestre (le cas échéant).
municipalité
 municipality MunicipalitySummary

Résumé d’une municipalité
quartier
 district DistrictSummary

Résumé d’un district
governmentRegion
 governmentRegion GovernmentRegionSummary

Résumé d’une région gouvernementale
federalState
 federalState FederalStateSummary

Résumé d’un état fédéral

CommuneLI

Commune au Liechtenstein

Nom Chemin Type Description
key
 key string

Numéro de commune (4 chiffres).
nom
 name string

Nom officiel de la commune.
electoralDistrict
 electoralDistrict string

Circonscription électorale – Oberland ou Unterland.

LocalitéLI

Localité au Liechtenstein

Nom Chemin Type Description
nom
 name string

Nom de la localité.
postalCode
 postalCode string

Code postal de la localité.
key
 commune.key string

Numéro de commune (4 chiffres).
nom
 commune.name string

Nom officiel de la commune.

StreetLI

Rue au Liechtenstein

Nom Chemin Type Description
key
 key string

Clé de rue.
nom
 name string

Nom de rue.
status
 status string

État de la rue (Planifié, Réel, Obsolète).
postalCode
 postalCode string

Code postal.
localité
 locality string

Nom de la localité.
key
 commune.key string

Numéro de commune (4 chiffres).
nom
 commune.name string

Nom officiel de la commune.

CantonCH

Canton de Suisse

Nom Chemin Type Description
key
 key string

Nombre BFS du canton (max. 2 chiffres).
historicalCode
 historicalCode string

Code historique du canton.
nom
 name string

Nom du canton.
shortName
 shortName string

Abréviation du canton (2 lettres).

CantonCHSummary

Résumé d’un canton suisse

Nom Chemin Type Description
key
 key string

Nombre BFS du canton (max. 2 chiffres).
nom
 name string

Nom du canton.
shortName
 shortName string

Abréviation du canton (2 lettres).

DistrictCH

District en Suisse

Nom Chemin Type Description
key
 key string

Nombre BFS du district (max. 4 chiffres).
historicalCode
 historicalCode string

Code historique du district.
nom
 name string

Nom du district.
shortName
 shortName string

Nom court du district.
Canton
 canton CantonCHSummary

Résumé d’un canton suisse

DistrictCHSummary

Résumé d’un district suisse

Nom Chemin Type Description
key
 key string

Nombre BFS du district (max. 4 chiffres).
nom
 name string

Nom du district.
shortName
 shortName string

Nom court du district.

CommuneCH

Commune en Suisse

Nom Chemin Type Description
key
 key string

Nombre BFS de la commune (max. 4 chiffres).
historicalCode
 historicalCode string

Code historique de la commune.
nom
 name string

Nom officiel de la commune.
shortName
 shortName string

Nom court de la commune.
quartier
 district DistrictCHSummary

Résumé d’un district suisse
Canton
 canton CantonCHSummary

Résumé d’un canton suisse

CommuneCHSummary

Résumé d’une commune suisse

Nom Chemin Type Description
key
 key string

Nombre BFS de la commune (max. 4 chiffres).
nom
 name string

Nom de la commune.
shortName
 shortName string

Nom court de la commune.

LocalityCH

Localité en Suisse

Nom Chemin Type Description
key
 key string

Identificateur de localité.
nom
 name string

Nom de la localité.
code postal
 postalcode string

Code postal de la localité.
commune
 commune CommuneCHSummary

Résumé d’une commune suisse
quartier
 district DistrictCHSummary

Résumé d’un district suisse
Canton
 canton CantonCHSummary

Résumé d’un canton suisse

StreetCH

Rue en Suisse

Nom Chemin Type Description
key
 key string

Clé de rue.
nom
 name string

Nom de rue.
status
 status string

État de la rue. Valeurs possibles : Planifié, Réel, Obsolète.
code postal
 postalcode string

Code postal de la localité.
localité
 locality string

Nom de la localité.
commune
 commune CommuneCHSummary

Résumé d’une commune suisse
quartier
 district DistrictCHSummary

Résumé d’un district suisse
Canton
 canton CantonCHSummary

Résumé d’un canton suisse

FederalProvinceAT

Province fédérale en Autriche

Nom Chemin Type Description
key
 key string

Identificateur de la province fédérale (1 chiffre).
nom
 name string

Nom de la province fédérale.

FederalProvinceATSummary

Résumé d’une province fédérale autrichienne

Nom Chemin Type Description
key
 key string

Identificateur de la province fédérale (1 chiffre).
nom
 name string

Nom de la province fédérale.

DistrictAT

District en Autriche

Nom Chemin Type Description
key
 key string

Identificateur de district (3 chiffres).
code
 code string

Code de district (3 chiffres).
nom
 name string

Nom du district.
federalProvince
 federalProvince FederalProvinceATSummary

Résumé d’une province fédérale autrichienne

DistrictATSummary

Résumé d’un district autrichien

Nom Chemin Type Description
key
 key string

Identificateur de district (3 chiffres).
code
 code string

Code de district (3 chiffres).
nom
 name string

Nom du district.

MunicipalitéAT

Municipalité en Autriche

Nom Chemin Type Description
key
 key string

Identificateur de la municipalité (5 chiffres).
code
 code string

Code de la municipalité (5 chiffres).
nom
 name string

Nom de la municipalité.
status
 status string

État de la municipalité (par exemple, ville, ville de marché, etc.).
postalCode
 postalCode string

Code postal du bureau municipal.
multiplePostalCodes
 multiplePostalCodes boolean

La municipalité couvre-t-elle plusieurs codes postaux ?
quartier
 district DistrictATSummary

Résumé d’un district autrichien
federalProvince
 federalProvince FederalProvinceATSummary

Résumé d’une province fédérale autrichienne

MunicipalitéATSummary

Résumé d’une municipalité autrichienne

Nom Chemin Type Description
key
 key string

Identificateur de la municipalité (5 chiffres).
code
 code string

Code de la municipalité (5 chiffres).
nom
 name string

Nom de la municipalité.

LocalityAT

Localité en Autriche

Nom Chemin Type Description
key
 key string

Identificateur de localité.
nom
 name string

Nom de la localité.
code postal
 postalcode string

Code postal de la localité.
municipalité
 municipality MunicipalityATSummary

Résumé d’une municipalité autrichienne
quartier
 district DistrictATSummary

Résumé d’un district autrichien
federalProvince
 federalProvince FederalProvinceATSummary

Résumé d’une province fédérale autrichienne

StreetAT

Rue en Autriche

Nom Chemin Type Description
key
 key string

Identificateur de rue.
nom
 name string

Nom de la rue.
code postal
 postalcode string

Code postal de la localité.
localité
 locality string

Nom de la localité.
municipalité
 municipality MunicipalityATSummary

Résumé d’une municipalité autrichienne
quartier
 district DistrictATSummary

Résumé d’un district autrichien
federalProvince
 federalProvince FederalProvinceATSummary

Résumé d’une province fédérale autrichienne