Der klassische CheckAddress-Endpunkt validiert eine vollständige
Adresse in einem Aufruf, korrigiert sie bei Bedarf und liefert
ein DQECodeDetail-Zustellbarkeitsurteil (DQECodeDetail)
sowie eine optionale feldweise Aufschlüsselung der Änderungen.
Anfrage
Sowohl GET als auch POST werden unterstützt.
l'église
→ l%27%C3%A9glise.
Code-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.
Code-Beispiele
Frankreich - vollständige Adresse mit Modification-Flag
Parameter
| Parameter | Wert | Beschreibung | Pflicht / Optional |
|---|---|---|---|
| Licence |
{LICENCE_CODE}
|
Ihr DQE-Lizenzschlüssel oder OAuth2-Token. Wenden Sie sich an den Support, falls Sie noch keinen besitzen. | Pflicht |
| Adresse |
{INPUT}
|
Durch Pipe-Zeichen getrennte Adresszeichenkette.
Alle fünf
Pipes
sind auch bei leeren Feldern Pflicht.
Für
Frankreich kann ein sechstes Segment für
den
Zustellpunkt (Wohnung, Etage, Briefkasten) vorangestellt
werden.
zusätzliche Adresse|Adresse|Ortsteil oder Bundesland|Postleitzahl|Stadt
Beispiel:
|
Pflicht |
| Pays |
{COUNTRY_CODE}
|
ISO-3166-1-Alpha-3-Ländercode für den Adresssuchbereich.
Beispiel: FRA oder
GBR.
|
Pflicht |
| Taille |
{LENGTH}
|
Zeichenbegrenzung für das Antwortfeld Adresse.
Gilt nur für Adressen mit lateinischen
Zeichen.
Standard: 38. Empfohlenes
Minimum:
32.
|
Optional |
| Instance |
{INSTANCE}
|
Wird im Antwortfeld Instance zurückgegeben.
Hat keine Auswirkung auf das Verhalten der API
-
kann weggelassen werden.
|
Optional |
| Proposition |
{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. Fügt der Antwort
Code_Modification und
Status_Modification hinzu,
die angeben, welche Adressfelder angepasst wurden
(zusätzliche Adresse, Adresse, Ortsteil,
Postleitzahl oder Stadt). Siehe
Code_Modification.
|
Optional |
| Version |
{VERSION}
|
1.1 - Fügt der Antwort Geokodierungsqualitätsfelder
(LibelleQualiteGeo, CodeQualiteGeo)
hinzu (nur Frankreich, Freischaltung
erforderlich
- wenden Sie sich an Ihren DQE-Kundenbetreuer).2 - Liefert zusätzliche Adressdaten
in einem ListeComplement-Feld.
|
Optional |
| Segmentation |
O
|
Nur Frankreich. Finesis-Freischaltung erforderlich
-
wenden Sie sich an Ihren DQE-Kundenbetreuer.
Setzen Sie den Wert
auf O, um der Antwort Sprofil,
Sportrait, Ssegment
(Felder zur Bevölkerungssegmentierung) hinzuzufügen.
Standard: N.
|
Optional |
Antwortfelder
Die Antwort ist ein JSON-Objekt mit einem einzigen Schlüssel
"1",
dessen Wert ein Wörterbuch mit Adressfeldern ist. Bei
Proposition=O können mehrere nummerierte
Datensätze
zurückgegeben werden.
| Schlüssel | Beschreibung | Frankreich | International |
|---|---|---|---|
| DQECodeDetail | Validierungsergebniscode. Siehe DQECodeDetail-Codes unten. | String (2) | String (2) |
| DQELibErreur |
Validierungsergebnis als Klartext-Label (OK
oder eine Fehlerbeschreibung).
|
String (38) | String (38) |
| Adresse | Normalisierte Adresszeile (Hausnummer, Straßentyp und -name). | String (38) | String (50) |
| Voie |
Straßenname ohne Hausnummer oder Straßentyp. Ausnahme: Ist der Straßentyp als zusammengesetztes Wort im Straßennamen enthalten (z. B. Tannenburgweg), wird hier der vollständige Name zurückgegeben und TypeVoie ist leer.
|
String (38) | String (50) |
| TypeVoie |
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 Voie zurückgegeben).
|
String (20) | String (20) |
| Numero | Vollständige Hausnummer einschließlich etwaiger Zusätze (bis, ter usw.). | String (10) | String (10) |
| NumSeul | Nur die Hausnummer, ohne etwaige Zusätze (bis, ter usw.). | String (10) | String (10) |
| CompNum | Hausnummernzusatz (bis, ter usw.). | String (38) | String (50) |
|
NbNumero also: Nbnumero |
Wenn die angefragte Nummer nicht gefunden wird oder fehlt, wird die Gesamtzahl der gültigen Hausnummern dieser Straße zurückgegeben. Kann bei manchen internationalen Adressen ein leerer String sein, wenn diese Daten nicht verfügbar sind. | String | String |
| ListeNumero | Durch Semikolon getrennte Liste aller gültigen Hausnummern dieser Straße. Wird befüllt, wenn die übermittelte Nummer ungültig oder nicht vorhanden ist. | String (1024) | String (1024) |
| CodePostal | Postleitzahl. | String (5) | String (10) |
| Localite | Stadtname. | String (38) | String (50) |
| LieuDit | Benannte Ortschaft oder Weiler (Frankreich) oder entsprechendes Feld auf Ortsteilebene (international). Die Verfügbarkeit variiert je nach Land. | String (38) | String (50) |
| Cedex |
CEDEX-Kennzeichnung: 1 = CEDEX-Adresse,
0 = keine CEDEX-Adresse.
|
String (1) | String (1) |
| Ligne2 | Zusätzliche Information aus Adresszeile 2. | String (38) | String (38) |
| Complement | Zusätzliche Adressinformation (Gebäudename, Etage usw.). | String (1024) | String (150) |
| ListeComplement |
Durch Semikolon getrennte Liste der verfügbaren
Adresszusätze
(Gebäude, Wohnanlagen usw.)
für
die zugeordnete Straße. Wird bei Version=2
zurückgegeben.
|
String (1024) | String (1024) |
| IDLocalite | Eindeutige Stadtkennung (INSEE-Code für Frankreich). | String (20) | String (20) |
|
IDVoie or CodeVoie |
Eindeutige Straßenkennung. | String (20) | String (20) |
| Pays | ISO-3166-1-Alpha-3-Ländercode. | String (3) | String (3) |
| Province | ISO-Code für Bundesland oder Verwaltungsregion. |
Immer "*"
|
String (50) |
| Region1 | Bezeichnung von Bundesland oder Region. | Nicht verfügbar | String |
| Region2 | Landkreis oder entsprechende Verwaltungsebene. | Nicht verfügbar | String |
| Region3 | Landkreis oder entsprechend (alternative Ebene). | Nicht verfügbar | String |
| Region4 | Zusätzliche regionale oder administrative Information. | Nicht verfügbar | String |
| Thoroughfare | Nebenstraße. | Nicht verfügbar | Nur UK |
| Roudis | Roudis-Routingcode. Nur Frankreich. | String (5) | Not available |
| IDHexaposte | Postalische Stadtkennung (Hexaposte-Code für Frankreich). | String (6) | Not available |
| IDCle | Eindeutige Hausnummernkennung (Hexaclé für Frankreich). | String (10) | Not available |
| Latitude | Geokoordinaten der zugeordneten Adresse. Nicht für alle Länder verfügbar - siehe Abdeckung. | String | String |
| Longitude | Geokoordinaten der zugeordneten Adresse. Nicht für alle Länder verfügbar - siehe Abdeckung. | String | String |
| Status_IrisIlot | Herkunft der IRIS- und Ilot-Codes. Freischaltung erforderlich - wenden Sie sich an Ihren DQE-Kundenbetreuer. | String (5) | Not available |
| iris | IRIS-Statistikgebietscode. Nur Frankreich, Freischaltung erforderlich - wenden Sie sich an Ihren DQE-Kundenbetreuer. | String (9) | Not available |
| ilot | Ilot-Code. Freischaltung erforderlich - wenden Sie sich an Ihren DQE-Kundenbetreuer. | String | Not available |
| Instance | Internes Feld. | String (3) | String (3) |
| LibelleQualiteGeo |
Geokodierungsqualitäts-Label (z. B. ENTREE,
BATIMENT). Wird bei
Version=1.1 befüllt. Siehe
Geokodierungsqualität.
|
String | Not available |
| CodeQualiteGeo |
Numerischer Geokodierungsqualitätscode. Wird
befüllt,
wenn
Version=1.1.
|
String | Not available |
| Sprofil |
Bevölkerungsprofil (Finesis). Wird bei
Segmentation=O zurückgegeben.
|
String (10) | Not available |
| Sportrait |
Bevölkerungsportrait (Finesis). Wird bei
Segmentation=O zurückgegeben.
|
String (10) | Not available |
| Ssegment |
Bevölkerungssegment (Finesis). Wird bei
Segmentation=O zurückgegeben.
|
String (10) | Not available |
| Code_Modification |
5-stellige Binärzeichenkette, die angibt, welche
Adressfelder
angepasst wurden. Wird bei
Modification=O zurückgegeben. Siehe
Code_Modification.
|
String (5) | String (5) |
| Status_Modification |
O, wenn mindestens ein Feld angepasst
wurde,
sonst
N. Wird bei
Modification=O zurückgegeben.
|
String (1) | String (1) |
|
DQECompte DQECodeErreur DQEPourcentErreur |
Legacy-Felder, die aus Gründen der Abwärtskompatibilität mit alten Integrationen erhalten bleiben. Nicht in neuen Implementierungen verwenden. | String | Not available |
Wird
zurückgegeben
bei Version=1.1Wird
zurückgegeben
bei Segmentation=OWird
zurückgegeben
bei Modification=O
Antwortbeispiele
|1 Rue de la Louisiane||31200|Toulouse
DQECodeDetail-Codes
DQECodeDetail ist der primäre Validierungsergebnis-
Indikator. Nutzen Sie ihn, um zu bestimmen, welche Aktion
beim
Absenden
des Formulars erfolgen soll.
Empfohlene UI-Meldungen zu jedem 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 | Kleinstadt, Hausnummer außerhalb des gültigen Bereichs |
| 22 | Kleinstadt, Hausnummer fehlt (der Rest der Adresse ist korrekt) |
| 23 | Großstadt, Hausnummer außerhalb des gültigen Bereichs |
| 24 | Großstadt, Hausnummer fehlt (der Rest der Adresse ist korrekt) |
| 25 | CEDEX-Adresse bei CEDEXA unbekannt (sofern CEDEXA aktiv ist) |
| 30 | Kleinstadt, Straße nicht erkannt |
| 31 | Kleinstadt - Straße nicht erkannt oder fehlt; Ortsteilinformation 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 | Kleinstadt, Straße fehlt |
| 50 | Großstadt, Straße nicht erkannt |
| 51 | Großstadt, Straße nicht erkannt oder fehlt (Ortsteilinformation 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ßstadt, Straße fehlt |
| 70 | Postleitzahl/Stadt stimmen nicht überein - Straße vorhanden |
| 71 | In aktuellen Cloud-Bereitstellungen nicht zu erwarten. Aus Kompatibilitätsgründen definiert. |
| 80 | Postleitzahl/Stadt stimmen nicht überein - 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 | Fehlender oder falscher Ländercode |
31 und
51 zeigen an, dass ein Ortsteil erkannt
wurde:
eine von der Engine identifizierte geografische Zone (z.
B. ein Weiler
oder eine Siedlung), die keiner bestimmten Straße zugeordnet
werden kann.
Diese Codes gelten nur für Frankreich.
DQECodeDetail - Beispieleingaben
Beispieleingaben, die zu jedem Code führen. 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 |
Wird 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 |
Wird 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 | Wird für Frankreich nicht zurückgegeben | |||| |
| 90 |
|7C avenue Monbijou||4960|MalmedyPays: FRA - Adresse scheint nicht französisch zu sein |
- |
| 95 | - | - |
Code_Modification
Wird zurückgegeben, wenn der Anfrage Modification=O hinzugefügt wird. Status_Modification ist O, wenn ein Feld angepasst wurde, sonst N. Code_Modification ist eine 5-stellige Binärzeichenkette, eine Stelle pro Adressfeld. 1 = von DQE angepasst, 0 = unverändert.
| Code_Modification | Bedeutung |
|---|---|
00000 |
Keine Felder angepasst - Adresse wie übermittelt akzeptiert. |
11111 |
Alle fünf Felder angepasst. |
00011 |
Postleitzahl und Stadt angepasst; andere Felder unverändert. |
01111 |
Adresse, Ortsteil, Postleitzahl und Stadt angepasst; zusätzliche Adresse unverändert. |
10000 |
Nur zusätzliche Adresse angepasst. |
01000 |
Nur Adresszeile angepasst. |
00100 |
Nur Ortsteil angepasst. |
Status_Modification O ist, wurde mindestens ein Feld von DQE geändert. Zeigen Sie die Korrektur dem Nutzer als Popup an und lassen Sie ihm stets die Möglichkeit, seine ursprüngliche Eingabe beizubehalten.Geokodierungsqualität
Wenn Version=1.1 gesetzt ist und Geokodierung freigeschaltet ist, werden zwei Felder hinzugefügt: LibelleQualiteGeo (Label) und CodeQualiteGeo (numerischer Code). Nur Frankreich.
| Code | LibelleQualiteGeo | Beschreibung |
|---|---|---|
| 1 | ENTREE | Hauptzugangspunkt zu einem Grundstück, einer Gebäudegruppe oder Parzelle (Adressschild). |
| 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 | Position, abgeleitet aus dem verbindenden Straßenabschnitt. Kann außerhalb des Stadtpolygons liegen, aber auf derselben Straße. |
| 7 | POINT D ACCESS TECHNIQUE | Technischer Zugangspunkt (Wasser, Strom, Gasabsperrung usw.). |
| 8 | POINT DELIVRANCE POSTALE | Postalischer Zustellpunkt (Briefkasten). |
| 9 | ZONE D ADRESSAGE | Punkt innerhalb des Ortsteils platziert. |
| 10 | CENTRE VILLE | Stadtzentrum. |
| 0 | CENTRE DE LA VOIE | Punkt in der Straßenmitte. |
| 90 | A CONTROLER | Geokodierungsqualität unsicher - zu überprüfen. |
| 99 | NON PRESENTE | Geokodierung für diese Adresse nicht verfügbar. |
Fehler
Im Gegensatz zu den Vorschlags-APIs gibt RNVP bei fehlenden oder ungültigen Pflichtparametern standardmäßige HTTP-Fehlercodes zurück (keinen leeren Antworttext).
| HTTP | Fehlertyp | Antworttext |
|---|---|---|
| 400 | Fehlender oder leerer Licence
|
Bad Request Parameters empty fields |
| 401 | Falscher Licence
|
unauthorized_client |
| 400 | Fehlender oder leerer Adresse
|
Bad Request Parameters empty fields |
| 400 | Fehlender oder leerer Pays
|
Bad Request Parameters empty fields |
| 400 | Ungültiger Parameterwert | 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
Siehe auch
Verknüpfung mit