Validiert und normalisiert eine vollständige Adresse. Liefert eine korrigierte Adresse, ein Zustellbarkeitsurteil (DQEDetailCode) und optional eine Aufstellung, welche Felder angepasst wurden.
Anfrage
Sowohl GET als auch POST werden unterstützt.
l'église → l%27%C3%A9glise.cURL-Beispiele
Frankreich - mit Modification=O und Version=1.1
International - Italien
Senden Sie alle Parameter im Anfragetext mit Content-Type: application/x-www-form-urlencoded. Die Serveradresse bleibt in der URL.
cURL-Beispiel
Frankreich - vollständige Adresse mit Modification-Flag
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 |
| Address | {INPUT} |
Durch Pipes getrennte Adresszeichenkette. Alle fünf Pipes sind Pflicht, auch wenn Felder leer sind. Für Frankreich kann ein sechstes Segment für die Zustellstelle (Wohnung, Stockwerk, Briefkasten) vorangestellt werden.
Adresszusatz|Adresse|Ortsteil oder Bundesstaat|Postleitzahl|Ort
Beispiel: |
Pflicht |
| Country | {COUNTRY_CODE} |
Ländercode nach ISO 3166-1 alpha-3 für den Suchbereich der Adresse. Beispiel: FRA oder GBR. |
Pflicht |
| Length | {LENGTH} |
Zeichenlimit für das Antwortfeld Address. Gilt nur für Adressen in lateinischer Schrift. Standard: 38. Empfohlenes Minimum: 32. |
Optional |
| Suggestion | {PROP} |
Nur Frankreich. Steuert, wie Korrekturergebnisse zurückgegeben werden.O - Datensatz "1" enthält das Standard-Korrekturergebnis. Kann die Adresse nicht eindeutig zugeordnet werden, werden weitere Vorschläge als Datensätze "2" bis "n" zurückgegeben.S - Datensatz "1" gibt die Eingabeadresse unverändert mit ihrem Validierungsstatus zurück (nicht korrigiert). Wird eine eindeutige Korrektur gefunden, wird sie als Datensatz "2" zurückgegeben. Aktiviert automatisch Modification=O. |
Optional |
| Modification | O |
Fester Wert O. Befüllt ChangedAddressTag und IsAddressChanged in der Antwort, die angeben, welche Adressfelder angepasst wurden (Adresszusatz, Adresse, Ortsteil, Postleitzahl oder Ort). Siehe ChangedAddressTag. |
Optional |
| Version | {VERSION} |
1.1 - Befüllt die Felder zur Geokodierungsqualität (LatLonLabel, LatLonCode) in der Antwort (nur Frankreich, Abonnement erforderlich - wenden Sie sich zur Aktivierung an Ihren DQE-Ansprechpartner). |
Optional |
Antwortfelder
Die Antwort ist ein JSON-Objekt mit zwei Schlüsseln auf oberster Ebene: Found (Integer) und Addresses (Array von Adressobjekten). Bei Suggestion=O können mehrere Adressobjekte zurückgegeben werden.
Oberste Ebene
| Schlüssel | Beschreibung | Typ |
|---|---|---|
| Found | Anzahl der zurückgegebenen Adressobjekte. | Integer |
| Addresses | Array von Adressobjekten. | Array |
Adressobjekt - Addresses[0]
| Schlüssel | Beschreibung | Frankreich | International |
|---|---|---|---|
| Address | Normalisierte Adresszeile (Hausnummer, Straßentyp und -name). | String (38) | String (50) |
| PostalCode | Postleitzahl. | String (5) | 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) |
| StateCode | ISO-Code des Bundesstaats bzw. der Verwaltungsregion. | Immer "*"
|
String (50) |
| SubLocality | Ortsteil. | Leer | String (50) |
| CityId | Eindeutige Ortskennung (INSEE-Code für Frankreich). | String (20) | String (20) |
| Input | Bei diesem Endpunkt nicht befüllt. Gibt immer eine leere Zeichenkette zurück. | String | String |
| Label | Formatierte Anzeigebezeichnung der Adresse. Wird nicht für alle internationalen Datensätze zurückgegeben. | String | String |
| AdditionalAddress | Zusätzliche Adressinformationen (Gebäudename, Stockwerk usw.). | String (1024) | String (150) |
| StreetNumber | Vollständige Hausnummer einschließlich Zusatz (bis, ter usw.). | String (10) | String (10) |
| StreetType | Straßentyp (z. B. RUE, AVENUE, BOULEVARD).Leer, wenn der Straßentyp als zusammengesetztes Wort im Straßennamen enthalten ist (in diesem Fall wird der vollständige Name in Street zurückgegeben).
|
String (20) | String (20) |
| Street | Straßenname ohne Nummer und Typ. Ausnahme: Ist der Straßentyp als zusammengesetztes Wort im Straßennamen enthalten (z. B. Tannenburgweg), wird hier der vollständige Name zurückgegeben und StreetType ist leer.
|
String (38) | String (50) |
| StreetId | Eindeutige Straßenkennung. | String (20) | String (20) |
| 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. |
Integer | Integer |
| StreetNumberListCount | Wenn die abgefragte Nummer nicht gefunden wurde oder fehlt, wird die Gesamtzahl der gültigen Hausnummern dieser Straße zurückgegeben. Kann bei manchen internationalen Adressen, für die diese Daten nicht verfügbar sind, eine leere Zeichenkette sein. | String | String |
| StreetNumberList | Durch Semikolons getrennte Liste aller gültigen Nummern dieser Straße. Befüllt, wenn die übermittelte Nummer ungültig ist oder fehlt. | String (1024) | String (1024) |
| StreetNumberOnly | Nur die Hausnummer, ohne Zusatz (bis, ter usw.). | String (10) | String (10) |
| StateLabel | Bezeichnung des Bundesstaats bzw. der Region. | Nicht verfügbar | String |
| AdministrativeArea | Landkreis oder gleichwertige Verwaltungsebene. | Leer | String |
| Suburb | Vorort. | Leer | String |
| 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 |
| Informations | Objekt mit DQE-Validierungsmetadaten. Siehe unten. | Object | Object |
Objekt Informations - Addresses[0].Informations
| Schlüssel | Beschreibung | Frankreich | International |
|---|---|---|---|
| DQEDetailCode | Code des Validierungsergebnisses. Siehe DQEDetailCode weiter unten. | String (2) | String (2) |
| DQEErrorAddressLabel | Klartext-Bezeichnung des Validierungsergebnisses (OK oder eine Fehlerbeschreibung). |
String (38) | String (38) |
| AdditionalAddressComp | Zusätzliche Informationen aus Adresszeile 2. | String (38) | String (38) |
| StreetNumberComp | Hausnummernzusatz (bis, ter usw.). | String (38) | String (50) |
| StreetNumberId | Eindeutige Hausnummernkennung (Hexaclé für Frankreich). | String (10) | Nicht verfügbar |
| PostalCityId | Postalische Ortskennung (Hexaposte-Code für Frankreich). | String (6) | Nicht verfügbar |
| IrisCode | Code der statistischen Einheit IRIS. Nur Frankreich, Abonnement erforderlich - wenden Sie sich zur Aktivierung an Ihren DQE-Ansprechpartner. | String (9) | Nicht verfügbar |
| RoudisCode | Roudis-Leitcode. Nur Frankreich. | String (5) | Nicht verfügbar |
| LatLonLabel | Bezeichnung der Geokodierungsqualität (z. B. ENTREE, BATIMENT). Befüllt bei Version=1.1. Siehe Geokodierungsqualität. |
String | Nicht verfügbar |
| LatLonCode | Numerischer Code der Geokodierungsqualität. Befüllt bei Version=1.1. |
String | Nicht verfügbar |
| IsAddressChanged |
1, wenn mindestens ein Feld angepasst wurde, sonst 0. Immer in der Antwort enthalten. |
String (1) | String (1) |
| ChangedAddressTag | 5-stellige Binärzeichenkette, die angibt, welche Adressfelder angepasst wurden. Siehe ChangedAddressTag. Immer vorhanden; befüllt, wenn Modification=O gesetzt ist. |
String (5) | String (5) |
Befüllt bei Version=1.1 Befüllt bei Modification=O
Antwortbeispiel
1 Rue de la Louisiane 31200 Toulouse
DQEDetailCode
Addresses[0].Informations.DQEDetailCode ist der primäre Indikator für das Validierungsergebnis. Verwenden Sie ihn, um die nach dem Absenden des Formulars auszuführende Aktion zu bestimmen.
Empfohlene UI-Meldungen für jeden Code finden Sie im Integrationsleitfaden.
| Code | Beschreibung |
|---|---|
| 10 | Korrekte Adresse |
| 20 | Korrekte Adresse (Straße nicht erkannt, aber es handelt sich um eine CEDEX-Adresse oder ein Postfach) |
| 21 | Kleiner Ort, Hausnummer außerhalb des gültigen Bereichs |
| 22 | Kleiner Ort, Hausnummer fehlt (der Rest der Adresse ist korrekt) |
| 23 | Große Stadt, Hausnummer außerhalb des gültigen Bereichs |
| 24 | Große Stadt, Hausnummer fehlt (der Rest der Adresse ist korrekt) |
| 25 | CEDEX-Adresse in CEDEXA unbekannt (falls CEDEXA aktiv ist) |
| 30 | Kleiner Ort, Straße nicht erkannt |
| 31 | Kleiner Ort - Straße nicht erkannt oder fehlend; Ortsteil-Information erkannt, reicht aber nicht aus, um die Straße zu bestimmen. Nur Frankreich. |
| 40 | In aktuellen Cloud-Bereitstellungen nicht zu erwarten. Aus Kompatibilitätsgründen definiert. |
| 41 | Kleiner Ort, Straße fehlt |
| 50 | Große Stadt, Straße nicht erkannt |
| 51 | Große Stadt, Straße nicht erkannt oder fehlend (Ortsteil-Information erkannt, reicht aber nicht aus, um die Straße zu bestimmen). Nur Frankreich. |
| 60 | In aktuellen Cloud-Bereitstellungen nicht zu erwarten. Aus Kompatibilitätsgründen definiert. |
| 61 | Große Stadt, Straße fehlt |
| 70 | Postleitzahl und Ort passen nicht zusammen - Straße vorhanden |
| 71 | In aktuellen Cloud-Bereitstellungen nicht zu erwarten. Aus Kompatibilitätsgründen definiert. |
| 80 | Postleitzahl und Ort passen nicht zusammen - Straße fehlt |
| 81 | Eingabeadressblock leer. Wird für Frankreich nicht zurückgegeben. |
| 90 | Internationale Adresse erkannt - der eingegebene Ländercode scheint nicht zur eingegebenen Adresse zu passen. |
| 95 | Ländercode fehlt oder ist falsch |
31 und 51 zeigen an, dass ein Ortsteil erkannt wurde: ein von der Engine identifiziertes geografisches Gebiet (z. B. ein Weiler oder eine Wohnsiedlung), das keiner bestimmten Straße zugeordnet werden kann. Diese Codes gelten nur für Frankreich.DQEDetailCode - Eingabebeispiele
Beispieleingaben, die den jeweiligen Code erzeugen. Nicht aufgeführte Felder bleiben leer.
| Code | Frankreich | International |
|---|---|---|
| 10 | |20 rue Jean-Baptiste Pigalle||75009|Paris |
Albert Buildings|3 Scott Drive||WA15 8AB|ALTRINCHAMGBR |
| 20 | |RUE DES FRERES LUMIERE|BP 30036|33564|CARBON BLANC |
- |
| 21 | |26 route du chardonnay||24130|Ginestet |
|Seulestraat 200||8950|HeuvellandBEL |
| 22 | |route du chardonnay||24130|Ginestet |
|Seulestraat||8950|HeuvellandBEL |
| 23 | |13 rue Jean-Baptiste Pigalle||75009|Paris |
|Rue Victor Hugo 235||7012|MonsBEL |
| 24 | |rue Jean-Baptiste Pigalle||75009|Paris |
|Rue Victor Hugo||7012|MonsBEL |
| 25 | |||82016|Montauban CEDEX |
- |
| 30 | |rue Jean-Baptiste Pigalle||24130|Ginestet |
|Via del lungo||70011|AlberobelloITA |
| 31 | |SAINT SYMPHORIEN||12490|VIALA DU TARN |
Außerhalb Frankreichs nicht zurückgegeben |
| 40 | In aktuellen Cloud-Bereitstellungen nicht zu erwarten. Aus Kompatibilitätsgründen definiert. | In aktuellen Cloud-Bereitstellungen nicht zu erwarten. Aus Kompatibilitätsgründen definiert. |
| 41 | |||24130|Ginestet |
|||70011|AlberobelloITA |
| 50 | |route du chardonnay||75009|Paris |
|STREET ABCD||60607|CHICAGOUSA |
| 51 | |Lotissement Casella||20243|PRUNELLI DI FIUMORBO |
Außerhalb Frankreichs nicht zurückgegeben |
| 60 | In aktuellen Cloud-Bereitstellungen nicht zu erwarten. Aus Kompatibilitätsgründen definiert. | In aktuellen Cloud-Bereitstellungen nicht zu erwarten. Aus Kompatibilitätsgründen definiert. |
| 61 | |||75009|Paris |
|||60607|CHICAGOUSA |
| 70 | |rue de la mairie||75009|Bordeaux |
|FRANKLIN GTWY SE||00067|MARIETTAUSA |
| 71 | In aktuellen Cloud-Bereitstellungen nicht zu erwarten. Aus Kompatibilitätsgründen definiert. | In aktuellen Cloud-Bereitstellungen nicht zu erwarten. Aus Kompatibilitätsgründen definiert. |
| 80 | |||75009|Bordeaux |
|||00067|MARIETTAUSA |
| 81 | Für Frankreich nicht zurückgegeben | |||| |
| 90 |
|7C avenue Monbijou||4960|MalmedyCountry: FRA - Adresse scheint nicht französisch zu sein |
- |
| 95 | - | - |
ChangedAddressTag
Befüllt, wenn der Anfrage Modification=O hinzugefügt wird. IsAddressChanged ist 1, wenn ein Feld angepasst wurde, sonst 0. ChangedAddressTag ist eine 5-stellige Binärzeichenkette mit einer Position pro Adressfeld. 1 = von DQE angepasst, 0 = unverändert.
| ChangedAddressTag | Bedeutung |
|---|---|
00000 |
Keine Felder angepasst - Adresse wie übermittelt akzeptiert. |
11111 |
Alle fünf Felder angepasst. |
00011 |
Postleitzahl und Ort angepasst; übrige Felder unverändert. |
01111 |
Adresse, Ortsteil, Postleitzahl und Ort angepasst; Adresszusatz unverändert. |
10000 |
Nur Adresszusatz angepasst. |
01000 |
Nur Adresszeile angepasst. |
00100 |
Nur Ortsteil angepasst. |
IsAddressChanged gleich 1, wurde mindestens ein Feld von DQE geändert. Zeigen Sie dem Nutzer die Korrektur in einem Popup an und lassen Sie ihm stets die Möglichkeit, seine ursprüngliche Eingabe beizubehalten.Geokodierungsqualität
Wenn Version=1.1 gesetzt und die Geokodierung abonniert ist, werden im Objekt Informations zwei Felder befüllt: LatLonLabel (Bezeichnung) und LatLonCode (numerischer Code). Nur Frankreich.
| Code | LatLonLabel | Beschreibung |
|---|---|---|
| 1 | ENTREE | Hauptzugang zu einem Grundstück, einer Gebäudegruppe oder einer Parzelle (Hausnummernschild). |
| 2 | BATIMENT | Gebäude oder Gebäudeteil. |
| 3 | ESCALIERS | Treppenhaus, normalerweise innerhalb eines Gebäudes. |
| 4 | LOGEMENT | Wohnung oder Raum innerhalb eines Gebäudes. |
| 5 | PARCELLE CADASTRALE | Katasterparzelle. |
| 6 | SEGMENT DE VOIE | Aus dem angrenzenden Straßenabschnitt abgeleitete Position. Kann außerhalb des Ortspolygons, aber auf derselben Straße liegen. |
| 7 | POINT D ACCESS TECHNIQUE | Technischer Zugangspunkt (Absperrung für Wasser, Strom, Gas usw.). |
| 8 | POINT DELIVRANCE POSTALE | Postalische Zustellstelle (Briefkasten). |
| 9 | ZONE D ADRESSAGE | Im Ortsteil platzierter Punkt. |
| 10 | CENTRE VILLE | Ortsmitte. |
| 0 | CENTRE DE LA VOIE | Punkt in der Mitte der Straße. |
| 90 | A CONTROLER | Geokodierungsqualität unsicher - zu prüfen. |
| 99 | NON PRESENTE | Für diese Adresse ist keine Geokodierung verfügbar. |
Fehler
Der RESTful-Endpunkt gibt einen strukturierten JSON-Fehlertext mit HTTP-Statuscode, Meldung und Fehlerkennung zurück.
| HTTP | Fehlertyp | Antworttext |
|---|---|---|
| 400 | Parameter Licence fehlt |
{"status":400,"message":"Missing parameters","details":"Licence","error":"bad request"} |
| 400 | Parameter Licence leer |
{"status":400,"message":"Licence must be filled","details":"Empty","error":"bad request"} |
| 401 | Falsche Lizenznummer | {"status":401,"message":"Your licence is not allowed to cover this functionnality","details":"{WRONG}","error":"unauthorized_client"} |
| 400 | Parameter Address fehlt |
{"status":400,"message":"Missing parameters","details":"Address","error":"bad request"} |
| 400 | Parameter Country fehlt |
{"status":400,"message":"Missing parameters","details":"Country","error":"bad request"} |
| 400 | Parameter Country leer |
{"status":400,"message":"Country must be filled","details":"Empty","error":"bad request"} |
| 400 | Tippfehler im Parameternamen | {"status":400,"message":"Missing parameters","details":"Address","error":"bad request"} |
API testen
Klicken Sie auf die Schaltfläche unten, um diesen Endpunkt live in Ihrem Browser zu testen.
Konsole öffnen
Siehe auch
Verknüpfung mit