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

Trichter-Autovervollständigung - RESTful

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

Dreistufiger Autovervollständigungs-Ablauf

Schritt 1/funnelpostcode/Ortssuche → Schritt 2/funneladdress/Straßensuche → Schritt 3/funnelcompl/Gebäude- & Wohnungsdetails

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

Ortsauswahl (funnelpostcode)

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

Springen zu Anfrage Parameter Antwort Beispiel Fehler ▶ API testen

Anfrage

funnelpostcode unterstützt sowohl GET als auch POST.

{SERVER_ADDRESS}, {VERSION} 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}/{VERSION}/funnelpostcode/?PostalCode={POSTAL_CODE}&Country={COUNTRY_CODE}&Licence={LICENCE_CODE}

cURL-Beispiel

Frankreich - Suche nach Postleitzahl

curl "https://{SERVER_ADDRESS}/v1/funnelpostcode/?PostalCode=75008&Country=FRA&Licence={LICENCE_CODE}"

POSThttps://{SERVER_ADDRESS}/{VERSION}/funnelpostcode/

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}/v1/funnelpostcode/" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "PostalCode=75008" \
  -d "Country=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
PostalCode	`{POSTAL_CODE}`	Eingabe von Postleitzahl oder Ortsname.	Pflicht
Country	`{COUNTRY_CODE}`	Ländercode nach ISO 3166-1 alpha-3 für den Suchbereich der Adresse. Beispiel: `FRA` oder `GBR`.	Pflicht
Extended	`Y` oder `N`	Ermöglicht die Suche bereits ab 2 Zeichen der Postleitzahl. Standard: `N`.	Optional
Limit	`{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). funnelpostcode liefert eine Ergebniszeile pro Gemeinde.

Antwort

Bei Erfolg gibt die API ein JSON-Objekt mit einem Zähler Found und einem Array PostalCodes zurück.

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 Extended=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.

Oberste Ebene

Schlüssel	Beschreibung	Typ
Found	Anzahl der zurückgegebenen Ortsvorschlags-Objekte.	Integer
PostalCodes	Array von Ortsvorschlags-Objekten.	Array

Ortsvorschlags-Objekt - `PostalCodes[n]`

Schlüssel	Beschreibung	Frankreich	International
PostalCode	Postleitzahl der Adresse.	String (10)	String (10)
City	Ortsname.	String (38)	String (50)
Hamlet	Flurname oder Weiler (Frankreich) bzw. entsprechendes Feld auf Bezirksebene (international). Die Verfügbarkeit variiert je nach Land.	String (38)	String (50)
SpecialDistribution	CEDEX-Indikator: `1` = CEDEX-Adresse, `0` = kein CEDEX.	String (1)	String (1)
Country	Ländercode nach ISO 3166-1 alpha-3.	String (3)	String (3)
AdministrativeArea	Landkreis oder gleichwertige Verwaltungsebene.	Leer	String (50)
StateLabel	ISO-Bezeichnung des Bundesstaats bzw. der Verwaltungsregion (z. B. `ISHIKAWA` für Japan).	Nicht verfügbar	String (50)
StateCode	ISO-Code des Bundesstaats bzw. der Verwaltungsregion (z. B. `17` für Japan).	String (50)	String (50)
SubLocality	Ortsteil (Bezirk, Stadtteil, Vorort).	Leer	String (50)
CityId	Eindeutige Ortskennung (INSEE-Code für Frankreich).	String (20)	String (20)
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

Objekt Informations - `PostalCodes[n].Informations`

Nur befüllt, wenn die Postleitzahl direkt einer bestimmten Adresse zugeordnet ist (z. B. CEDEX-Codes in Frankreich). Andernfalls sind alle Felder leer.

Schlüssel	Beschreibung	Frankreich	International
AdditionalAddress	Adresszusatzzeile.	Leer	String (50)
AdditionalAddress_2	Zweite Adresszusatzzeile.	Leer	String (50)
StreetNumberList	Durch Semikolons getrennte Liste gültiger Hausnummern der gefundenen Straße. Enthält, sofern vorhanden, immer alle Nummern; leer, wenn `StreetId` fehlt.	String (1024)	String (1024)
StreetType	Straßentyp (z. B. `RUE`, `AVENUE`, `BOULEVARD`). Wird nicht für alle internationalen Datensätze zurückgegeben.	String (20)	String (20)
Street	Straßenname.	String (38)	String (150)
Suburb	Vorort oder Bezirk.	Leer	String (50)
StreetId	Eindeutige Straßenkennung. Nur befüllt, wenn die Postleitzahl einer bestimmten Straße zugeordnet ist. In diesem Fall können Sie funneladdress überspringen und `StreetId` direkt an funnelcompl übergeben.	String (20)	String (20)
Company	Firmenname.	String (38)	String (38)

Antwortbeispiel

Antwortbeispiel - Frankreich (75008 Paris)

{
  "Found": 1,
  "PostalCodes": [
    {
      "PostalCode":           "75008",
      "City":                 "PARIS",
      "Hamlet":               "",
      "SpecialDistribution":  "0",
      "Country":              "FRA",
      "AdministrativeArea":   "",
      "StateLabel":           "",
      "StateCode":            "*",
      "SubLocality":          "",
      "CityId":               "75108",
      "Latitude":             "48.8775112171854",
      "Longitude":            "2.31760169076841",
      "Informations": {
        "AdditionalAddress":    "",
        "AdditionalAddress_2":  "",
        "StreetNumberList":     "",
        "StreetType":           "",
        "Street":               "",
        "Suburb":               "",
        "StreetId":             "",
        "Company":              ""
      }
    }
  ]
}

Antwortbeispiel - Japan (108-6390)

{
  "Found": 3,
  "PostalCodes": [
    {
      "PostalCode":           "108-6390",
      "City":                 "ﾐﾅﾄｸ",
      "Hamlet":               "",
      "SpecialDistribution":  "0",
      "Country":              "JPN",
      "AdministrativeArea":   "ﾐﾅﾄｸ",
      "StateLabel":           "ﾄｳｷﾖｳﾄ",
      "StateCode":            "13",
      "SubLocality":          "",
      "CityId":               "402574_1086390",
      "Latitude":             "",
      "Longitude":            "",
      "Informations": {
        "AdditionalAddress":    "",
        "AdditionalAddress_2":  "",
        "StreetNumberList":     "",
        "StreetType":           "",
        "Street":               "",
        "Suburb":               "",
        "StreetId":             "",
        "Company":              ""
      }
    }
  ]
}

Fehler

Der RESTful-Endpunkt gibt einen strukturierten JSON-Fehlertext mit HTTP-Statuscode, Meldung und Fehlerkennung zurück.

HTTP	Fehlertyp	Antworttext
400	Ein Pflichtparameter fehlt	{"status":400,"message":"Missing parameters","details":"PostalCode,Licence","error":"bad request"}
400	Ländercode ist kein gültiger ISO 3166-1 alpha-3-Code	{"status":400,"message":"Country doesn't exist","details":"INVALID","error":"bad request"}
401	Falsche oder nicht autorisierte Lizenznummer	{"status":401,"message":"Your licence is not allowed to cover this functionnality","details":"WRONG","error":"unauthorized_client"}

API testen

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

Konsole öffnen

Adresssuche (funneladdress)

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

Springen zu Anfrage Parameter Antwort Beispiel Fehler ▶ API testen

Anfrage

funneladdress unterstützt sowohl GET als auch POST.

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

Die Adresseingabe muss URL-kodiert sein - z. B. l'église → l%27%C3%A9glise.

GET POST

GEThttps://{SERVER_ADDRESS}/{VERSION}/funneladdress/?CityId={CITY_ID}&Country={COUNTRY_CODE}&Street={INPUT}&Licence={LICENCE_CODE}

cURL-Beispiel

Frankreich - CityId aus dem vorherigen funnelpostcode-Schritt

curl "https://{SERVER_ADDRESS}/v1/funneladdress/?CityId=75108&Country=FRA&Street=bienfaisance&Licence={LICENCE_CODE}"

POSThttps://{SERVER_ADDRESS}/{VERSION}/funneladdress/

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}/v1/funneladdress/" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "CityId=75108" \
  -d "Country=FRA" \
  -d "Street=bienfaisance" \
  -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
CityId	`{CITY_ID}`	Ortskennung, die von funnelpostcode im Feld `CityId` zurückgegeben wird. Beschränkt die Straßensuche auf den ausgewählten Ort.	Pflicht
Country	`{COUNTRY_CODE}`	Ländercode nach ISO 3166-1 alpha-3 für den Suchbereich der Adresse. Beispiel: `FRA` oder `GBR`.	Pflicht
Street	`{INPUT}`	Vom Nutzer eingegebener unvollständiger Straßenname.	Pflicht
Limit	`{NB}`	Maximale Anzahl zurückgegebener Adressvorschläge.	Optional
Length	`{LENGTH}`	Maximale Zeichenlänge der zurückgegebenen Adressfelder. Gilt nur für Adressen in lateinischer Schrift. Standard: `38`. Empfohlenes Minimum: `32`.	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
Version	`1.1`	Bei `1.1` wird das Feld `Hamlet` für kleine Ortschaften befüllt. Ohne diesen Parameter erscheinen die Namen kleiner Ortschaften stattdessen in Klammern im Feld `City`.	Optional

Antwort

Bei Erfolg ist die Antwort ein JSON-Objekt mit zwei Schlüsseln auf oberster Ebene: Found (Integer) und Addresses (Array von Adressvorschlags-Objekten).

Oberste Ebene

Schlüssel	Beschreibung	Typ
Found	Anzahl der zurückgegebenen Adressvorschlags-Objekte.	Integer
Addresses	Array von Adressvorschlags-Objekten.	Array

Adressvorschlags-Objekt - `Addresses[n]`

Schlüssel	Beschreibung	Frankreich	International
PostalCode	Postleitzahl der Adresse.	String (10)	String (10)
City	Ortsname.	String (38)	String (50)
Hamlet	Flurname oder Weiler (Frankreich) bzw. entsprechendes Feld auf Bezirksebene (international). Befüllt, wenn `Version=1.1` gesetzt ist. Die Verfügbarkeit variiert je nach Land.	String (38)	String (50)
SpecialDistribution	CEDEX-Indikator: `1` = CEDEX-Adresse, `0` = kein CEDEX.	String (1)	String (1)
Country	Ländercode nach ISO 3166-1 alpha-3.	String (3)	String (3)
StateCode	ISO-Code des Bundesstaats bzw. der Verwaltungsregion (z. B. `17` für Japan).	Leer	String (50)
StateLabel	ISO-Bezeichnung des Bundesstaats bzw. der Verwaltungsregion (z. B. `ISHIKAWA` für Japan).	Nicht verfügbar	String (50)
AdministrativeArea	Landkreis oder gleichwertige Verwaltungsebene.	Leer	String (50)
SubLocality	Ortsteil (Bezirk, Stadtteil, Vorort).	Leer	String (50)
Suburb	Vorort oder Bezirk.	Leer	String (50)
CityId	Eindeutige Ortskennung (INSEE-Code für Frankreich).	String (20)	String (20)
Input	Normalisierte Form der übermittelten Straßeneingabe. Kann in Schreibweise oder Formatierung von der ursprünglichen Eingabe abweichen.	String (255)	String (255)
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 →	Leer	String (255)
Street	Straßenname.	String (38)	String (150)
StreetId	Eindeutige Straßenkennung. Wird als Eingabe für funnelcompl verwendet.	String (20)	String (20)
StreetType	Straßentyp (z. B. `RUE`, `AVENUE`, `BOULEVARD`). Wird nicht für alle internationalen Datensätze zurückgegeben.	String (20)	String (20)
StreetNumber	Vollständige Hausnummer einschließlich Zusatz (bis, ter usw.).	String (38)	String (38)
StreetNumberOnly	Nur die Hausnummer, ohne Zusatz (bis, ter usw.).	Leer	String (4)
StreetNumberList	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)
StreetNumberListCount	Wenn die abgefragte Nummer nicht gefunden wurde oder fehlt, wird die Gesamtzahl der gültigen Hausnummern dieser Straße zurückgegeben.	Leer	String
IsValidStreetNumber	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
AdditionalAddress	Zusätzliche Adressinformationen (Gebäudename, Stockwerk usw.). Die Verfügbarkeit variiert je nach Land - siehe Integrationsleitfaden.	Leer	String (50)
Company	Mit der Adresse verknüpfter Firmenname.	String (38)	String (38)
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

Befüllt mit Version=1.1

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

Antwortbeispiel

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

{
  "Found": 1,
  "Addresses": [
    {
      "PostalCode":           "75008",
      "City":                 "PARIS",
      "Hamlet":               "",
      "SpecialDistribution":  "0",
      "Country":              "FRA",
      "StateCode":            "",
      "SubLocality":          "",
      "CityId":               "75108",
      "Input":                "bienfaisance",
      "Label":                "",
      "AdditionalAddress":    "",
      "StreetNumber":         "",
      "StreetType":           "RUE",
      "Street":               "RUE DE LA BIENFAISANCE",
      "StreetId":             "1454259",
      "IsValidStreetNumber":  "",
      "StreetNumberListCount":"",
      "StreetNumberList":     "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",
      "StreetNumberOnly":     "",
      "StateLabel":           "",
      "AdministrativeArea":   "",
      "Suburb":               "",
      "Company":              "",
      "Latitude":             "48.876526",
      "Longitude":            "2.316451" }
  ]
}

Antwortbeispiel - Japan (三田, 108-6390)

Japan - CityId 402573_1086390, Langue=JP (Kanji)

{
  "Found": 1,
  "Addresses": [
    {
      "PostalCode":           "108-6390",
      "City":                 "港区",
      "Hamlet":               "",
      "SpecialDistribution":  "",
      "Country":              "JPN",
      "StateCode":            "13",
      "SubLocality":          "",
      "CityId":               "402573",
      "Input":                "三田",
      "Label":                "〒108-6390 東京都港区三田",
      "AdditionalAddress":    "",
      "StreetNumber":         "",
      "StreetType":           "",
      "Street":               "三田",
      "StreetId":             "558203",
      "IsValidStreetNumber":  1,
      "StreetNumberListCount":0,
      "StreetNumberList":     "",
      "StreetNumberOnly":     "",
      "StateLabel":           "東京都",
      "AdministrativeArea":   "港区",
      "Suburb":               "",
      "Company":              "",
      "Latitude":             "",
      "Longitude":            "" }
  ]
}

Fehler

Der RESTful-Endpunkt gibt einen strukturierten JSON-Fehlertext mit HTTP-Statuscode, Meldung und Fehlerkennung zurück.

HTTP	Fehlertyp	Antworttext
400	Ein Pflichtparameter fehlt	{"status":400,"message":"Missing parameters","details":"CityID","error":"bad request"}
400	Ländercode ist kein gültiger ISO 3166-1 alpha-3-Code	{"status":400,"message":"Country doesn't exist","details":"JPNde","error":"bad request"}
401	Falsche oder nicht autorisierte Lizenznummer	{"status":401,"message":"Your licence is not allowed to cover this functionnality","details":"WRONG LICENSE","error":"unauthorized_client"}

API testen

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

Konsole öffnen

Gebäude (funnelcompl)

Letzter Schritt des Trichter-Ansatzes. Anhand einer StreetId und einer StreetNumber aus funneladdress 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

funnelcompl unterstützt sowohl GET als auch POST.

{SERVER_ADDRESS}, {VERSION} und {LICENCE_CODE} werden von DQE bei der Kontoeröffnung bereitgestellt. {STREET_ID} stammt aus dem Feld StreetId der funneladdress-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}/{VERSION}/funnelcompl/?StreetId={STREET_ID}&Country={COUNTRY_CODE}&StreetNumber={NUMBER}&Licence={LICENCE_CODE}

cURL-Beispiel

Frankreich - StreetId aus dem vorherigen funneladdress-Schritt

curl "https://{SERVER_ADDRESS}/v1/funnelcompl/?StreetId=2408474&Country=FRA&StreetNumber=1&Licence={LICENCE_CODE}"

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

POSThttps://{SERVER_ADDRESS}/{VERSION}/funnelcompl/

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}/v1/funnelcompl/" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "StreetId=0751080070" \
  -d "Country=FRA" \
  -d "StreetNumber=17" \
  -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
StreetId	`{STREET_ID}`	Eindeutige Straßenkennung, die von funneladdress im Feld `StreetId` zurückgegeben wird.	Pflicht
Country	`{COUNTRY_CODE}`	Ländercode nach ISO 3166-1 alpha-3 für den Suchbereich der Adresse. Beispiel: `FRA` oder `GBR`.	Pflicht
StreetNumber	`{NUMBER}`	Vom Nutzer ausgewählte Hausnummer - entspricht dem Feld `StreetNumber` aus der funneladdress-Antwort.	Pflicht
Length	`{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

Antwort

Bei Erfolg ist die Antwort ein JSON-Objekt mit drei Schlüsseln auf oberster Ebene: Found, AdditionalAddresses (Array) und einem Geokoordinaten-Objekt Geolocalisation.

Fehlende Gebäudezusatzdaten sind kein Fehler. Siehe Integrationsleitfaden →

Oberste Ebene

Schlüssel	Beschreibung	Typ
Found	Anzahl der zurückgegebenen Adresszusatz-Objekte.	Integer
AdditionalAddresses	Array von Adresszusatz-Objekten.	Array
Geolocalisation	Geokoordinaten der gefundenen Adresse. Leer, wenn für diesen Adresstyp nicht verfügbar.	Object

Objekt AdditionalAddress - `AdditionalAddresses[n]`

Schlüssel	Beschreibung	Frankreich	International
AdditionalAddress	Bezeichnung des Gebäude- oder Wohnungszusatzes.	String (38)	String (150)
PostalCode	Dem Zusatz zugeordnete Postleitzahl.	String	String

Geokoordinaten - `Geolocalisation`

Schlüssel	Beschreibung	Frankreich	International
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

Antwortbeispiel

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

{
  "Found": 4,
  "AdditionalAddresses": [
    { "AdditionalAddress": "BATIMENT A RESIDENCE ALLEE DES CEDRES", "PostalCode": "" },
    { "AdditionalAddress": "BATIMENT B RESIDENCE ALLEE DES CEDRES", "PostalCode": "" },
    { "AdditionalAddress": "BATIMENT C RESIDENCE ALLEE DES CEDRES", "PostalCode": "" },
    { "AdditionalAddress": "BATIMENT D RESIDENCE ALLEE DES CEDRES", "PostalCode": "" }
  ],
  "Geolocalisation": {
      "Latitude":  "",
      "Longitude": "" }
}

Fehler

Der RESTful-Endpunkt gibt einen strukturierten JSON-Fehlertext mit HTTP-Statuscode, Meldung und Fehlerkennung zurück.

HTTP	Fehlertyp	Antworttext
400	Ein Pflichtparameter fehlt	{"status":400,"message":"Missing parameters","details":"StreetId","error":"bad request"}
400	Ländercode ist kein gültiger ISO 3166-1 alpha-3-Code	{"status":400,"message":"Country doesn't exist","details":"JPNde","error":"bad request"}
401	Falsche oder nicht autorisierte Lizenznummer	{"status":401,"message":"Your licence is not allowed to cover this functionnality","details":"WRONG LICENSE","error":"unauthorized_client"}

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 (RESTful)

Ortsauswahl (funnelpostcode)

Anfrage

cURL-Beispiel

cURL-Beispiel

Parameter

Antwort

Oberste Ebene

Ortsvorschlags-Objekt - `PostalCodes[n]`

Objekt Informations - `PostalCodes[n].Informations`

Antwortbeispiel

Fehler

API testen

Adresssuche (funneladdress)

Anfrage

cURL-Beispiel

cURL-Beispiel

Parameter

Antwort

Oberste Ebene

Adressvorschlags-Objekt - `Addresses[n]`

Antwortbeispiel

Fehler

API testen

Gebäude (funnelcompl)

Anfrage

cURL-Beispiel

cURL-Beispiel

Parameter

Antwort

Oberste Ebene

Objekt AdditionalAddress - `AdditionalAddresses[n]`

Geokoordinaten - `Geolocalisation`

Antwortbeispiel

Fehler

API testen

Siehe auch

War dieser Beitrag hilfreich?

Vorheriger Artikel

Nächster Artikel

Ortsauswahl (funnelpostcode)

Anfrage

cURL-Beispiel

cURL-Beispiel

Parameter

Antwort

Oberste Ebene

Ortsvorschlags-Objekt - PostalCodes[n]

Objekt Informations - PostalCodes[n].Informations

Antwortbeispiel

Fehler

API testen

Adresssuche (funneladdress)

Anfrage

cURL-Beispiel

cURL-Beispiel

Parameter

Antwort

Oberste Ebene

Adressvorschlags-Objekt - Addresses[n]

Antwortbeispiel

Fehler

API testen

Gebäude (funnelcompl)

Anfrage

cURL-Beispiel

cURL-Beispiel

Parameter

Antwort

Oberste Ebene

Objekt AdditionalAddress - AdditionalAddresses[n]

Geokoordinaten - Geolocalisation

Antwortbeispiel

Fehler

API testen

Siehe auch

War dieser Beitrag hilfreich?

Vorheriger Artikel

Nächster Artikel

Ortsvorschlags-Objekt - `PostalCodes[n]`

Objekt Informations - `PostalCodes[n].Informations`

Adressvorschlags-Objekt - `Addresses[n]`

Objekt AdditionalAddress - `AdditionalAddresses[n]`

Geokoordinaten - `Geolocalisation`