Address API - Autovervollständigung aus einer Postleitzahl (Classic)

Trichter-Autovervollständigung - Standard-API

Dreistufige Adress-Autovervollständigung über die Classic-API. CP findet passende Orte anhand einer Postleitzahl oder eines Ortsnamens; ADR liefert die Straßen im ausgewählten Ort; COMPL ruft nach der Straßenauswahl die Gebäudezusatz-Optionen ab.

Dreistufiger Autovervollständigungs-Ablauf

Schritt 1/CP/Ortssuche → Schritt 2/ADR/Straßensuche → Schritt 3/COMPL/Gebäude- & Wohnungsdetails

Groß-/Kleinschreibung der Ausgabe - Die Schreibweise folgt der Postnorm des jeweiligen Landes.

Ortssuche (CP)

Erster Schritt des Trichter-Ansatzes. Liefert passende Orte und Postleitzahlen anhand einer unvollständigen Postleitzahl oder eines Ortsnamens. Die IDLocalite jedes Ergebnisses dient als Eingabe für den nächsten Schritt: ADR.

Springen zu Anfrage Parameter Antwort Beispiel Fehler ▶ API testen

Anfrage

CP unterstützt sowohl GET als auch POST.

{SERVER_ADDRESS} und {LICENCE_CODE} werden von DQE bei der Kontoeröffnung bereitgestellt. Wenden Sie sich an Ihren DQE-Ansprechpartner, um diese Zugangsdaten zu erhalten.

GET POST

GEThttps://{SERVER_ADDRESS}/CP/?CodePostal={POSTAL_CODE}&Alpha=True&Pays={COUNTRY_CODE}&Licence={LICENCE_CODE}

cURL-Beispiel

Frankreich - Suche nach Postleitzahl

curl "https://{SERVER_ADDRESS}/CP/?CodePostal=75008&Alpha=True&Pays=FRA&Licence={LICENCE_CODE}"

POSThttps://{SERVER_ADDRESS}/CP/

Senden Sie alle Parameter im Anfragetext mit Content-Type: application/x-www-form-urlencoded. Die Serveradresse bleibt in der URL.

cURL-Beispiel

curl -X POST "https://{SERVER_ADDRESS}/CP/" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "CodePostal=75008" \
  -d "Alpha=True" \
  -d "Pays=FRA" \
  -d "Licence={LICENCE_CODE}"

Parameter

Parameter	Wert	Beschreibung	Pflicht / Opt.
Licence	`{LICENCE_CODE}`	Ihr DQE-Lizenzschlüssel oder OAuth2-Token. Wenden Sie sich an den Support, falls Sie noch keinen haben.	Pflicht
CodePostal	`{POSTAL_CODE}`	Eingabe von Postleitzahl oder Ortsname.	Pflicht
Pays	`{COUNTRY_CODE}`	Ländercode nach ISO 3166-1 alpha-3 für den Suchbereich der Adresse. Beispiel: `FRA` oder `GBR`.	Pflicht
Alpha	`True`	Immer `True` senden. Pflichtparameter.	Pflicht
Instance	`{INSTANCE}`	Wird bei diesem Endpunkt nicht in den Ergebnissen zurückgegeben - kann weggelassen werden.	Optional
Etendue	`Y` oder `N`	Ermöglicht die Suche bereits ab 2 Zeichen der Postleitzahl. Standard: `N`.	Optional
NbMax	`{NB}`	Maximale Anzahl zurückgegebener Ortsvorschläge.	Optional
Filter	`{FILTER}`	Steuert die Art der zurückgegebenen Ergebnisse. Ohne Angabe enthält die Antwort Postleitzahlen, Straßen (sofern verfügbar) und CEDEX-Einträge. `1` = nur Postleitzahl & CEDEX · `2` = Postleitzahl & Straße (ohne CEDEX) · `3` = nur Postleitzahl · `4` = ein Vorschlag pro Postleitzahl & Ort (nur Malaysia)	Optional
Langue	`{LANGUAGE}`	Filtert die Ergebnisse nach Sprache/Schrift. JPN: `JP` = Kanji · `JK` = Katakana · `EN` = lateinische Umschrift. HKG: `EN` · `ZH`. THA: `EN` · `TH`. Siehe Sprachleitfaden.	Optional

Frankreich & Belgien: Eine Postleitzahl kann mehreren Gemeinden zugeordnet sein (fragmentierte Gruppierung). CP liefert eine Ergebniszeile pro Gemeinde.

Antwort

Bei Erfolg gibt die API ein JSON-Objekt zurück. Die Schlüssel sind Rangnummern von "1" bis "n", die jeweils auf ein Wörterbuch mit Adressfeldern verweisen.

Variables Antwortschema - Wenn IDVoie befüllt ist, erscheint Voie im JSON. Wenn nur ein Ort zurückgegeben wird, fehlt Voie. Verwenden Sie eine nicht leere IDVoie, um festzustellen, welches Schema gilt.

Reihenfolge der Ergebnisse - Die Ergebnisse sind nach Relevanz sortiert, nicht aufsteigend nach Postleitzahl. Wird eine exakte Postleitzahl eingegeben, die einem einzigen Ort entspricht, wird ein Ergebnis zurückgegeben. Wird eine unvollständige Postleitzahl mit Etendue=Y eingegeben, sind die Ergebnisse nach Bevölkerungsdichte sortiert (größter Ort zuerst). Wird ein Ortsname eingegeben (exakt oder unvollständig), erscheinen exakte Übereinstimmungen zuerst, gefolgt von einer Sortierung nach Schlüsselwort-Relevanz.

Feld	Beschreibung	Frankreich	International
Province	ISO-Code des Bundesstaats bzw. der Verwaltungsregion (z. B. `17` für Japan).	String (50)	String (50)
IDLocalite	Eindeutige Ortskennung (INSEE-Code für Frankreich).	String (20)	String (20)
Pays	Ländercode nach ISO 3166-1 alpha-3.	String (3)	String (3)
Instance	Internes Feld.	String	String
CodePostal	Postleitzahl der Adresse.	String (10)	String (10)
SousLocalite	Ortsteil (Bezirk, Stadtteil, Vorort).	Leer	String (50)
LieuDit	Flurname oder Weiler (Frankreich) bzw. entsprechendes Feld auf Bezirksebene (international). Die Verfügbarkeit variiert je nach Land.	String (38)	String (50)
Localite	Ortsname.	String (38)	String (50)
Latitude	Geokoordinaten des gefundenen Ortes. Nicht für alle Länder verfügbar - siehe Abdeckung.	String	String
Longitude	Geokoordinaten des gefundenen Ortes. Nicht für alle Länder verfügbar - siehe Abdeckung.	String	String
IDVoie	Eindeutige Straßenkennung. Nur befüllt, wenn die Postleitzahl einer bestimmten Straße zugeordnet ist. In diesem Fall können Sie ADR überspringen und `IDVoie` direkt an COMPL übergeben.	String (20)	String (20)
Voie	Straßenname. Nur in der Antwort enthalten, wenn `IDVoie` befüllt ist.	String (38)	String (150)
NbNumero	Gesamtzahl der Hausnummern der gefundenen Straße. Nur befüllt, wenn `IDVoie` vorhanden ist; sonst leer.	String	String
ListeNumero	Durch Semikolons getrennte Liste gültiger Hausnummern der gefundenen Straße. Enthält, sofern vorhanden, immer alle Nummern; leer, wenn `IDVoie` fehlt.	String (1024)	String (1024)
Numero	Vollständige Hausnummer einschließlich Zusatz (bis, ter usw.).	String (38)	String (38)
TypeVoie	Straßentyp (z. B. `RUE`, `AVENUE`, `BOULEVARD`). Wird nicht für alle internationalen Datensätze zurückgegeben.	String (20)	String (20)
Complement	Zusätzliche Adressinformationen.	Leer	String (50)
Entreprise	Mit der Adresse verknüpfter Firmenname.	String (38)	String (38)
Cedex	CEDEX-Indikator: `1` = CEDEX-Adresse, `0` = kein CEDEX.	String (1)	String (1)
Region1	ISO-Bezeichnung des Bundesstaats bzw. der Verwaltungsregion (z. B. `ISHIKAWA` für Japan).	Nicht verfügbar	String (50)
Region2	Landkreis oder gleichwertige Verwaltungsebene.	Nicht verfügbar	String (50)
Region3	Landkreis oder Gleichwertiges (alternative Ebene).	Nicht verfügbar	String (50)
Region4	Zusätzliche regionale oder administrative Informationen.	Nicht verfügbar	String (50)

Antwortbeispiel

Antwortbeispiel - Frankreich (75008 Paris)

{
  "1": {
    "Province":     "*",
    "IDLocalite":   "75108",
    "NbNumero":     "",
    "Pays":         "FRA",
    "IDVoie":       "",
    "Cedex":        "0",
    "Numero":       "",
    "TypeVoie":     "",
    "Instance":     "",
    "ListeNumero":  "",
    "CodePostal":   "75008",
    "SousLocalite": "",
    "LieuDit":      "",
    "Latitude":     "48.8775112171854",
    "Localite":     "PARIS",
    "Longitude":    "2.31760169076841",
    "Complement":   "",
    "Entreprise":   ""
  }
}

Antwortbeispiel - Japan (108-6390)

{
  "1": {
    "Cedex":        "0",
    "CodePostal":   "108-6390",
    "Complement":   "",
    "Entreprise":   "",
    "IDLocalite":   "402574_1086390",
    "IDVoie":       "",
    "Instance":     "0",
    "Latitude":     "",
    "LieuDit":      "",
    "ListeNumero":  "",
    "Localite":     "ﾐﾅﾄｸ",
    "Longitude":    "",
    "NbNumero":     "",
    "Numero":       "",
    "Pays":         "JPN",
    "Province":     "13",
    "SousLocalite": "",
    "TypeVoie":     "",
    "Region1":      "ﾄｳｷｮｳﾄ"
  }
}

Fehler

HTTP	Fehlertyp	Antworttext
200	`Licence` fehlt oder ist leer	`{}` - leeres Ergebnis, kein Fehler ausgelöst
401	Falsche oder abgelaufene `Licence`	`unauthorized_client`
400	Parameter `CodePostal` fehlt	`Bad Request Parameters * not allowed`
400	Tippfehler im Parameternamen (z. B. `codepostal` statt `CodePostal`)	`Bad Request Parameters * not allowed`
200	Unbekannter ISO-Code in `Pays` (z. B. `AAA`)	`{}` - leeres Ergebnis, kein Fehler ausgelöst
401	Ungültiges Länderformat (z. B. `FRAN` statt `FRA`)	`unauthorized_country`

API testen

Klicken Sie auf die Schaltfläche unten, um diesen Endpunkt live in Ihrem Browser zu testen.

Konsole öffnen

Straßensuche (ADR)

Zweiter Schritt des Trichter-Ansatzes. Anhand einer IDLocalite aus CP und eines unvollständigen Straßennamens werden passende Straßen zurückgegeben. Die IDVoie jedes Ergebnisses dient als Eingabe für den letzten Schritt: COMPL.

Springen zu Anfrage Parameter Antwort Beispiel Fehler ▶ API testen

Anfrage

ADR unterstützt sowohl GET als auch POST.

{SERVER_ADDRESS} und {LICENCE_CODE} werden von DQE bei der Kontoeröffnung bereitgestellt. {CITY_ID} stammt aus dem Feld IDLocalite der CP-Antwort, wenn der Nutzer einen Ort auswählt. Wenden Sie sich an Ihren DQE-Ansprechpartner, um diese Zugangsdaten zu erhalten.

Der Wert von Adresse muss URL-kodiert sein - z. B. l'église → l%27%C3%A9glise.

GET POST

GEThttps://{SERVER_ADDRESS}/ADR/?IDLocalite={CITY_ID}&Adresse={INPUT}&Pays={COUNTRY_CODE}&Licence={LICENCE_CODE}

cURL-Beispiel

Frankreich - IDLocalite aus dem vorherigen CP-Schritt

curl "https://{SERVER_ADDRESS}/ADR/?IDLocalite=75108&Adresse=bienfaisance&Pays=FRA&Licence={LICENCE_CODE}&Taille=38&Version=1.1"

POSThttps://{SERVER_ADDRESS}/ADR/

Senden Sie alle Parameter im Anfragetext mit Content-Type: application/x-www-form-urlencoded. Die Serveradresse bleibt in der URL.

cURL-Beispiel

curl -X POST "https://{SERVER_ADDRESS}/ADR/" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "IDLocalite=75108" \
  -d "Adresse=bienfaisance" \
  -d "Pays=FRA" \
  -d "Licence={LICENCE_CODE}"

Parameter

Parameter	Wert	Beschreibung	Pflicht / Opt.
Licence	`{LICENCE_CODE}`	Ihr DQE-Lizenzschlüssel oder OAuth2-Token. Wenden Sie sich an den Support, falls Sie noch keinen haben.	Pflicht
IDLocalite	`{CITY_ID}`	Ortskennung, die von CP im Feld `IDLocalite` zurückgegeben wird. Beschränkt die Straßensuche auf den ausgewählten Ort.	Pflicht
Adresse	`{INPUT}`	Vom Nutzer eingegebener unvollständiger Straßenname.	Pflicht
Pays	`{COUNTRY_CODE}`	Ländercode nach ISO 3166-1 alpha-3 für den Suchbereich der Adresse. Beispiel: `FRA` oder `GBR`.	Pflicht
Taille	`{LENGTH}`	Maximale Zeichenlänge der zurückgegebenen Adressfelder. Gilt nur für Adressen in lateinischer Schrift. Standard: `38`. Empfohlenes Minimum: `32`.	Optional
Instance	`{INSTANCE}`	Wird bei diesem Endpunkt nicht in den Ergebnissen zurückgegeben - kann weggelassen werden.	Optional
Version=1.1	`1.1`	Bei `1.1` wird das Feld `LieuDit` für kleine Ortschaften befüllt. Ohne diesen Parameter erscheinen die Namen kleiner Ortschaften stattdessen in Klammern im Feld `Localite`.	Optional
Langue	`{LANGUAGE}`	Filtert die Ergebnisse nach Sprache/Schrift. JPN: `JP` = Kanji · `JK` = Katakana · `EN` = lateinische Umschrift. HKG: `EN` · `ZH`. THA: `EN` · `TH`. Siehe Sprachleitfaden.	Optional

Antwort

Bei Erfolg gibt die API ein JSON-Objekt zurück. Die Schlüssel sind Rangnummern von "1" bis "n", die jeweils auf ein Wörterbuch mit Straßenfeldern verweisen.

Feld	Beschreibung	Frankreich	International
label	Anzeigefertige Zeichenkette für eine Autovervollständigungsliste. Nummern in `[eckigen Klammern]` bedeuten, dass die Nummer in den Referenzdaten nicht gefunden wurde. Hinweise zur Verwendung siehe Feld label - nur zur Anzeige. Verwenden Sie `label` nur zum Befüllen der Vorschlagsliste - niemals zum Speichern der Adresse. Siehe Integrationsleitfaden →	Nicht verfügbar	String (255)
IDVoie auch: CodeVoie	Eindeutige Straßenkennung. Wird als Eingabe für COMPL verwendet.	String (20)	String (20)
Voie	Straßenname.	String (38)	String (150)
Saisie	Normalisierte Form der übermittelten Straßeneingabe. Kann in Schreibweise oder Formatierung von der ursprünglichen Eingabe abweichen.	String (255)	String (255)
TypeVoie	Straßentyp (z. B. `RUE`, `AVENUE`, `BOULEVARD`). Wird nicht für alle internationalen Datensätze zurückgegeben.	String (20)	String (20)
Numero auch: Num	Vollständige Hausnummer einschließlich Zusatz (bis, ter usw.).	String (38)	String (38)
NumSeul	Nur die Hausnummer, ohne Zusatz (bis, ter usw.).	Nicht verfügbar	String (4)
NbNumero auch: Nbnumero	Wenn die abgefragte Nummer nicht gefunden wurde oder fehlt, wird die Gesamtzahl der gültigen Hausnummern dieser Straße zurückgegeben. Beide Schlüssel (`NbNumero` / `Nbnumero`) enthalten denselben Wert. Kann eine leere Zeichenkette sein, wenn nicht zutreffend.	String	String
ListeNumero	Durch Semikolons getrennte Liste gültiger Hausnummern. Enthält alle Nummern, wenn keine Nummer eingegeben wurde oder die eingegebene Nummer nicht gefunden wurde; andernfalls nur die gefundene Nummer.	String (1024)	String (1024)
valid_num	Gültigkeitsindikator der Hausnummer. `1`, wenn die Nummer in den Referenzdaten existiert, sonst `0`. Gibt bei manchen internationalen Adressen, für die keine Validierung auf Hausnummernebene verfügbar ist, eine leere Zeichenkette zurück.	Nicht verfügbar	Integer
CodePostal	Postleitzahl der Adresse.	String (10)	String (10)
Localite	Ortsname.	String (38)	String (50)
IDLocalite	Eindeutige Ortskennung (INSEE-Code für Frankreich).	String (20)	String (20)
SousLocalite	Ortsteil (Bezirk, Stadtteil, Vorort).	Nicht verfügbar	String (50)
LieuDit	Flurname. Befüllt, wenn in der Anfrage `Version=1.1` gesetzt ist. Kann bei internationalen Adressen befüllt sein.	String (38)	String (50)
Province	ISO-Code des Bundesstaats bzw. der Verwaltungsregion (z. B. `17` für Japan).	Nicht verfügbar	String (50)
Region1	ISO-Bezeichnung des Bundesstaats bzw. der Verwaltungsregion (z. B. `ISHIKAWA` für Japan).	Nicht verfügbar	String (50)
Region2	Landkreis oder gleichwertige Verwaltungsebene.	Nicht verfügbar	String (50)
Region3	Landkreis oder Gleichwertiges (alternative Ebene).	Nicht verfügbar	String (50)
Region4	Zusätzliche regionale oder administrative Informationen.	Nicht verfügbar	String (50)
Suburb	Vorort oder Bezirk.	Nicht verfügbar	String (50)
Thoroughfare	Abhängige Straße.	Nicht verfügbar	Nur UK
Complement	Zusätzliche Adressinformationen (Gebäudename, Stockwerk usw.). Die Verfügbarkeit variiert je nach Land - siehe Integrationsleitfaden.	Leer	String (50)
Complement2	Zweite Gebäudezusatzzeile. Befüllt bei bestimmten internationalen Adressen, wenn sowohl eine Gebäudekennung als auch eine Untereinheitskennung (Stockwerk, Wohnung, Suite) als separate Einträge verfügbar sind, sowie bei bestimmten CEDEX-Adressen von Organisationen.	Nicht verfügbar	String (50)
Entreprise	Mit der Adresse verknüpfter Firmenname.	String (38)	String (38)
Cedex	CEDEX-Indikator: `1` = CEDEX-Adresse, `0` = kein CEDEX.	String (1)	String (1)
Latitude	Geokoordinaten der gefundenen Adresse. Nicht für alle Länder verfügbar - siehe Abdeckung.	String	String
Longitude	Geokoordinaten der gefundenen Adresse. Nicht für alle Länder verfügbar - siehe Abdeckung.	String	String
Roudis	Roudis-Code.	String	Nicht verfügbar
Pays	Ländercode nach ISO 3166-1 alpha-3.	String (3)	String (3)
Instance	Internes Feld.	String	String

Zurückgegeben mit Version=1.1

Straße ohne Hausnummer ausgewählt? Siehe Integrationsleitfaden →

Antwortbeispiel

Antwortbeispiel - Frankreich (Rue de la Bienfaisance, 75008 Paris)

{
  "1": {
    "IDLocalite":  "75108",
    "Saisie":      "bienfaisance",
    "Pays":        "FRA",
    "IDVoie":      "1454259",
    "Voie":        "RUE DE LA BIENFAISANCE",
    "Roudis":      "",
    "ListeNumero": "1;2;3;3B;4;6;7;7B;8;9;10;12;12B;15;16;17;19;20;21;23;25;26;27;28;29;30;32;33;34;35;36;37;39;40;41;42;43;44;45;46;47;48;50;51;52;52B;54",
    "Numero":      "",
    "TypeVoie":    "RUE",
    "Instance":    "",
    "Cedex":       "0",
    "Num":         "",
    "CodePostal":  "75008",
    "NbNumero":    "47",
    "Longitude":   "2.316451",
    "LieuDit":     "",
    "Latitude":    "48.876526",
    "Localite":    "PARIS",
    "CodeVoie":    "1454259",
    "Complement":  "",
    "Entreprise":  ""
  }
}

Antwortbeispiel - Japan (三田, 108-6390)

{
  "1": {
    "label":       "〒108-6390 東京都港区三田",
    "valid_num":   1,
    "Num":         "",
    "Numero":      "",
    "ListeNumero": "",
    "Nbnumero":    0,
    "NbNumero":    0,
    "NumSeul":     "",
    "Saisie":      "三田",
    "Pays":        "JPN",
    "Complement":  "",
    "Voie":        "三田",
    "CodeVoie":    "558203",
    "IDVoie":      "558203",
    "IDLocalite":  "402573",
    "Instance":    1,
    "CodePostal":  "108-6390",
    "Localite":    "港区",
    "Province":    "13",
    "LieuDit":     "",
    "Longitude":   "",
    "Latitude":    "",
    "Region1":     "東京都",
    "Region2":     "港区",
    "Region3":     "",
    "Suburb":      "",
    "TypeVoie":    ""
  }
}

Fehler

HTTP	Fehlertyp	Antworttext
200	`Licence` fehlt oder ist leer	`{}` - leeres Ergebnis, kein Fehler ausgelöst
401	Falsche oder abgelaufene `Licence`	`unauthorized_client`
400	`IDLocalite` fehlt	`Bad Request Parameters * not allowed`
400	`Adresse` fehlt	`Bad Request Parameters * not allowed`
400	`Pays` fehlt	`Bad Request Parameters * not allowed`
400	Tippfehler im Parameternamen (z. B. falsch geschriebenes `Adresse` oder `IDLocalite`)	`Bad Request Parameters * not allowed`

API testen

Klicken Sie auf die Schaltfläche unten, um diesen Endpunkt live in Ihrem Browser zu testen.

Konsole öffnen

Gebäude (COMPL)

Letzter Schritt des Trichter-Ansatzes. Anhand einer IDVoie und einer Numero aus ADR wird eine Liste von Gebäudezusatz-Vorschlägen zurückgegeben: Gebäudenamen, Stockwerke, Firmennamen, Wohnungsnummern.

Springen zu Anfrage Parameter Antwort Beispiel Fehler ▶ API testen

Anfrage

COMPL unterstützt sowohl GET als auch POST.

{SERVER_ADDRESS} und {LICENCE_CODE} werden von DQE bei der Kontoeröffnung bereitgestellt. {STREET_ID} stammt aus dem Feld IDVoie der ADR-Antwort, wenn der Nutzer eine Straße auswählt. Wenden Sie sich an Ihren DQE-Ansprechpartner, um diese Zugangsdaten zu erhalten.

GET POST

GEThttps://{SERVER_ADDRESS}/COMPL/?IDVoie={STREET_ID}&IDNum={NUM}&Pays={COUNTRY_CODE}&Licence={LICENCE_CODE}

cURL-Beispiel

Frankreich - IDVoie aus dem vorherigen ADR-Schritt

curl "https://{SERVER_ADDRESS}/COMPL/?IDVoie=2408474&IDNum=1&Pays=FRA&Licence={LICENCE_CODE}"

Wenn der Nutzer keine Hausnummer eingegeben hat, übergeben Sie einen leeren Parameter IDNum: &IDNum=

POSThttps://{SERVER_ADDRESS}/COMPL/

Senden Sie alle Parameter im Anfragetext mit Content-Type: application/x-www-form-urlencoded. Die Serveradresse bleibt in der URL.

cURL-Beispiel

curl -X POST "https://{SERVER_ADDRESS}/COMPL/" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "IDVoie=2408474" \
  -d "IDNum=1" \
  -d "Pays=FRA" \
  -d "Licence={LICENCE_CODE}"

Parameter

Parameter	Wert	Beschreibung	Pflicht / Opt.
Licence	`{LICENCE_CODE}`	Ihr DQE-Lizenzschlüssel oder OAuth2-Token. Wenden Sie sich an den Support, falls Sie noch keinen haben.	Pflicht
IDVoie	`{STREETID}`	Eindeutige Straßenkennung, die von ADR im Feld `IDVoie` zurückgegeben wird.	Pflicht
IDNum	`{STREETNUMBER}`	Vom Nutzer ausgewählte Hausnummer - entspricht dem Feld `Numero` aus der ADR-Antwort.	Pflicht
Pays	`{COUNTRY_CODE}`	Ländercode nach ISO 3166-1 alpha-3 für den Suchbereich der Adresse. Beispiel: `FRA` oder `GBR`.	Pflicht
Taille	`{LENGTH}`	Maximale Zeichenlänge der zurückgegebenen Adressfelder. Gilt nur für Adressen in lateinischer Schrift. Ein zu niedriger Wert kann die Ergebnisse abschneiden. Standard: `38`. Empfohlenes Minimum: `32`.	Optional
Instance	`{INSTANCE}`	Wird bei diesem Endpunkt nicht in den Ergebnissen zurückgegeben - kann weggelassen werden.	Optional

Antwort

Die JSON-Antwort ist ein Wörterbuch, dessen Schlüssel von "1" bis "n" nummeriert sind. Jeder Eintrag enthält einen Adresszusatz.

Fehlende Gebäudezusatzdaten sind kein Fehler. Siehe Integrationsleitfaden →

Feld	Beschreibung	Frankreich	International
Batiment	Bezeichnung des Gebäude- oder Wohnungszusatzes.	String (38)	String (150)
CodePostal	Dem Zusatz zugeordnete Postleitzahl.	Nicht verfügbar	String (10)

Antwortbeispiel

Antwortbeispiel - Frankreich (1 Rue de la Louisiane, 31200 Toulouse)

{
  "1": {
    "Batiment":   "BATIMENT D RESIDENCE ALLEE DES CEDRES"
  },
  "2": {
    "Batiment":   "BATIMENT A RESIDENCE ALLEE DES CEDRES"
  },
  "3": {
    "Batiment":   "BATIMENT B RESIDENCE ALLEE DES CEDRES"
  },
  "4": {
    "Batiment":   "BATIMENT C RESIDENCE ALLEE DES CEDRES"
  }
}

Antwortbeispiel - International (GBR)

{
  "1": {
    "Batiment":   "Town Hall, Tameside Metropolitan Borough Council",
    "CodePostal": "M34 2AP"
  },
  "2": {
    "Batiment":   "Victoria Park Community Association",
    "CodePostal": "M34 2AP"
  }
}

Fehler

HTTP	Fehlertyp	Antworttext
401	Parameter `Licence` fehlt oder ist leer	`unauthorized_client`
401	Falscher oder abgelaufener Lizenzschlüssel	`unauthorized_client`
400	Parameter `IDVoie` fehlt	`Bad Request Parameters empty fields`
400	Parameter `IDNum` fehlt	`Bad Request Parameters empty fields`
400	Parameter `Pays` fehlt	`Bad Request Parameters empty fields`
400	Tippfehler im Parameternamen (z. B. `IdVoie` statt `IDVoie`)	`Bad Request Parameters empty fields`

API testen

Klicken Sie auf die Schaltfläche unten, um diesen Endpunkt live in Ihrem Browser zu testen.

Konsole öffnen

Address API - Autovervollständigung aus einer Postleitzahl (Classic)

Ortssuche (CP)

Anfrage

cURL-Beispiel

cURL-Beispiel

Parameter

Antwort

Antwortbeispiel

Fehler

API testen

Straßensuche (ADR)

Anfrage

cURL-Beispiel

cURL-Beispiel

Parameter

Antwort

Antwortbeispiel

Fehler

API testen

Gebäude (COMPL)

Anfrage

cURL-Beispiel

cURL-Beispiel

Parameter

Antwort

Antwortbeispiel

Fehler

API testen

Siehe auch

War dieser Beitrag hilfreich?

Vorheriger Artikel

Nächster Artikel