Senden Sie eine vollständige Adresse an den RESTful-Endpunkt
checkaddress,
um sie in einem Aufruf validieren und normalisieren zu lassen,
mit
einem DQEDetailCode-Zustellbarkeitsurteil (DQEDetailCode)
und einer optionalen Aufschlüsselung etwaiger korrigierter
Felder.
Anfrage
Sowohl GET als auch POST werden unterstützt.
v1 oder v2. Es handelt sich nicht
um
kontospezifische Zugangsdaten, Sie wählen die Version selbst
in
der URL.
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 |
| Address |
{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 |
| Country |
{COUNTRY_CODE}
|
ISO-3166-1-Alpha-3-Ländercode für den Adresssuchbereich.
Beispiel: FRA oder
GBR.
|
Pflicht |
| Length |
{LENGTH}
|
Zeichenbegrenzung für das Antwortfeld Address.
Gilt nur für Adressen mit lateinischen
Zeichen.
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. Fügt der Antwort
ChangedAddressTag und
IsAddressChanged hinzu,
die angeben, welche Adressfelder angepasst wurden
(zusätzliche Adresse, Adresse, Ortsteil,
Postleitzahl oder Stadt). Siehe
ChangedAddressTag.
|
Optional |
| Version |
{VERSION}
|
1.1 - Fügt der Antwort Geokodierungsqualitätsfelder
(LatLonLabel, LatLonCode)
hinzu (nur Frankreich, Freischaltung
erforderlich
- wenden Sie sich an Ihren DQE-Kundenbetreuer).
|
Optional |
Antwortfelder
Die Antwort ist ein JSON-Objekt mit zwei Schlüsseln auf oberster
Ebene:
Found (Ganzzahl) 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 | Stadtname. | String (38) | String (50) |
| Hamlet | Benannte Ortschaft oder Weiler (Frankreich) oder entsprechendes Feld auf Ortsteilebene (international). Die Verfügbarkeit variiert je nach Land. | String (38) | String (50) |
| SpecialDistribution |
CEDEX-Kennzeichnung: 1 = CEDEX-Adresse,
0 = keine CEDEX-Adresse.
|
String (1) | String (1) |
| Country | ISO-3166-1-Alpha-3-Ländercode. | String (3) | String (3) |
| StateCode | ISO-Code für Bundesland oder Verwaltungsregion. |
Immer "*"
|
String (50) |
| SubLocality | Ortsteil. | Leer | String (50) |
| CityId | Eindeutige Stadtkennung (INSEE-Code für Frankreich). | String (20) | String (20) |
| Input | Wird für diesen Endpunkt nicht befüllt. Gibt immer einen leeren String zurück. | String | String |
| Label | Formatiertes Anzeige-Label für die Adresse. Wird nicht für alle internationalen Datensätze zurückgegeben. | String | String |
| AdditionalAddress | Zusätzliche Adressinformation (Gebäudename, Etage usw.). | String (1024) | String (150) |
| StreetNumber | Vollständige Hausnummer einschließlich etwaiger Zusätze (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 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 StreetType ist leer.
|
String (38) | String (50) |
| StreetId | Eindeutige Straßenkennung. | String (20) | String (20) |
| IsValidStreetNumber |
Gültigkeitsanzeige der Hausnummer. 1,
wenn die Nummer in den Referenzdaten vorhanden
ist,
sonst
0. Gibt bei manchen
internationalen
Adressen einen leeren String zurück, wenn eine
Validierung auf Nummernebene
nicht
verfügbar ist.
|
Integer | Integer |
| StreetNumberListCount | 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 |
| StreetNumberList | 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) |
| StreetNumberOnly | Nur die Hausnummer, ohne etwaige Zusätze (bis, ter usw.). | String (10) | String (10) |
| StateLabel | Bezeichnung von Bundesland oder Region. | Nicht verfügbar | String |
| AdministrativeArea | Landkreis oder entsprechende Verwaltungsebene. | Leer | String |
| Suburb | Vorort. | Leer | String |
| Company | Firmenname im Zusammenhang mit der Adresse. | String (38) | String (38) |
| 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 |
| Informations | DQE-Validierungsmetadaten-Objekt. Siehe unten. | Object | Object |
Informations-Objekt - Addresses[0].Informations
| Schlüssel | Beschreibung | Frankreich | International |
|---|---|---|---|
| DQEDetailCode | Validierungsergebniscode. Siehe DQEDetailCode unten. | String (2) | String (2) |
| DQEErrorAddressLabel |
Validierungsergebnis als Klartext-Label (OK
oder eine Fehlerbeschreibung).
|
String (38) | String (38) |
| AdditionalAddressComp | Zusätzliche Information 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 Stadtkennung (Hexaposte-Code für Frankreich). | String (6) | Nicht verfügbar |
| IrisCode | IRIS-Statistikgebietscode. Nur Frankreich, Freischaltung erforderlich - wenden Sie sich an Ihren DQE-Kundenbetreuer. | String (9) | Nicht verfügbar |
| RoudisCode | Roudis-Routingcode. Nur Frankreich. | String (5) | Nicht verfügbar |
| LatLonLabel |
Geokodierungsqualitäts-Label (z. B. ENTREE,
BATIMENT). Wird bei
Version=1.1 befüllt. Siehe
Geokodierungsqualität.
|
String | Nicht verfügbar |
| LatLonCode |
Numerischer Geokodierungsqualitätscode. Wird
befüllt,
wenn
Version=1.1.
|
String | Nicht verfügbar |
| IsAddressChanged |
1, wenn mindestens ein Feld angepasst
wurde,
sonst
0. Immer in der
Antwort
vorhanden.
|
String (1) | String (1) |
| ChangedAddressTag |
5-stellige Binärzeichenkette, die angibt, welche
Adressfelder
angepasst wurden. Siehe
ChangedAddressTag.
Immer vorhanden; wird befüllt, wenn
Modification=O
gesetzt ist.
|
String (5) | String (5) |
Wird
befüllt,
wenn Version=1.1Wird
befüllt,
wenn Modification=O
Antwortbeispiel
1 Rue de la Louisiane 31200 Toulouse
DQEDetailCode
Addresses[0].Informations.DQEDetailCode
ist der
primäre Validierungsergebnis-Indikator. Nutzen Sie ihn, um
die
nach dem Absenden des Formulars auszuführende Aktion zu bestimmen.
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.
DQEDetailCode - 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|MalmedyCountry: FRA - Adresse scheint nicht französisch zu sein |
- |
| 95 | - | - |
ChangedAddressTag
Wird zurückgegeben, 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, eine Stelle 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 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. |
IsAddressChanged 1 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 innerhalb des Informations-Objekts zwei Felder befüllt: LatLonLabel (Label) und LatLonCode (numerischer Code). Nur Frankreich.
| Code | LatLonLabel | 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
Der RESTful-Endpunkt gibt einen strukturierten JSON-Fehlertext mit einem HTTP-Statuscode, einer Meldung und einer Fehlerkennung zurück.
| HTTP | Fehlertyp | Antworttext |
|---|---|---|
| 400 | Fehlender Parameter Licence
|
{"status":400,"message":"Missing parameters","details":"Licence","error":"bad request"} |
| 400 | Leerer Parameter Licence
|
{"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 | Fehlender Parameter Address
|
{"status":400,"message":"Missing parameters","details":"Address","error":"bad request"} |
| 400 | Fehlender Parameter Country
|
{"status":400,"message":"Missing parameters","details":"Country","error":"bad request"} |
| 400 | Leerer Parameter Country
|
{"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