Dokumentation API v1

Autovervollständigung Belgienbeta

Mit diesem API-Aufruf können belgische Adressen ergänzt werden. Die Dokumentation für niederländische Adressen finden Sie unter Autovervollständigen die Niederlande.


Um eine belgische Adresse vollständig zu validieren, sind die folgenden Angaben erforderlich:

  • Postleitzahl (auch vor Ort erhältlich)
  • Straße
  • Hausnummer (mit evtl. Subadressenangabe wie Appartement- oder Busnummer)

Es stehen mehrere API-Aufrufe zur Verfügung, um eine benutzerfreundliche Anwendung zu erstellen, in der Postleitzahl, Ort und Straße durch Eingabe der ersten Ziffern/Buchstaben ergänzt werden können.

Obligatorische Parameter

Verwenden Sie einen der beiden obligatorischen Parameter:

  • be_fourpp: Geben Sie die belgische Postleitzahl (teilweise oder vollständig 4-stellig) für Provinz, Gemeinde und Wohnort ein.
  • be_city: Geben Sie einen (teilweisen) belgischen Städtenamen für Provinz, Gemeinde und Postleitzahl ein.

Optionale Parameter

  • Straße: Geben Sie eine (Teil-)Straße ein, um eine Liste von Straßen zurückzubekommen, die dem angegebenen (Teil-)Straßennamen entsprechen. Um eine Straße zu validieren, ist auch der Parameter be_fourpp erforderlich.
  • streetnumber: Geben Sie eine Hausnummer ein. Um eine Hausnummer zu validieren, werden die vollständigen be_fourpp und street benötigt.
  • subaddress: Geben Sie eine Subadresse ein (z.B. Busnummer oder Wohnungsnummer). Um eine subadresse zu überprüfen, sind die vollständigen be_fourpp, street und streetnumber erforderlich.
  • Sprache: Geben Sie die Sprache ein, in der die Orts- und Straßeninformationen gesucht werden sollen. Die Möglichkeiten sind nl und fr. Standardmäßig werden beide Sprachen durchsucht.
  • per_page: die maximale Anzahl der Ergebnisse, die zurückgegeben werden sollen. Standardmäßig ist dies 10.
Vorsicht: Die Felder "Provinz","Gemeinde","Stadt" und"Straße" werden seit kurzem in die Ergebnisse einbezogen. Seit Anfang Juli 2015 ist die Ausgabe mehrspr: achig geworden, die Felder "Provinz_nl", "Provinz_fr", "Gemeinde_nl", "Gemeinde_fr", "Stadt_nl", "Stadt_fr", "Stadt_fr", "Straße_nl" und "Straße_fr" müssen verwendet werden.

Beispiele

Postleitzahlenanfrage

undefined/v1/autocomplete?auth_key=YOUR_AUTH_KEY&be_fourpp=1200

Diese Anwendung liefert das folgende Ergebnis:

{
  "status": "ok",
  "results": [
    {
      "province_nl": "Brussel",
      "province_fr": "Bruxelles",
      "municipality_nl": "Sint-lambrechts-woluwe",
      "municipality_fr": "Woluwe-saint-lambert",
      "city_nl": "Sint-lambrechts-woluwe",
      "city_fr": "Woluwe-saint-lambert",
      "fourpp": 1200,
      "lat": null,
      "lng": null
    }
  ]
}

Straßenanfrage

In diesem Beispiel wird neben der Anforderung eines Teilstraßennamens auch das XML-Ausgabeformat verwendet.

undefined/v1/autocomplete?auth_key=YOUR_AUTH_KEY&be_fourpp=1200&street=a&format=xml

Diese Anwendung liefert das folgende Ergebnis:

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <results>
    <result>
      <street_nl>A. Marinusgaarde</street_nl>
    </result>
    <result>
      <street_nl>A.en M.L. Servais-Kinetstraat</street_nl>
    </result>
    <result>
      <street_nl>A.J. Slegersgaarde</street_nl>
    </result>
    <result>
      <street_fr>Avenue Lambeau</street_fr>
    </result>
  </results>
</response>

Fehlermeldungen

  • Invalid be_fourpp format
    Het formaat dient te bestaan uit 4 cijfers. Extra spatiëring en gebruik van hoofd- of kleine letters worden automatisch gecorrigeerd.
  • Street number not found
    De ‘street number’ parameter is meegegeven maar het opgegeven huisnummer bestaat niet volgens onze database.

Beispielcode


Die Methode autocomplete wird in diesen gebrauchsfertigen Beispielen demonstriert: