Validación - RESTful
Envía una dirección completa al endpoint RESTful checkaddress
para que se valide y normalice en una sola llamada, con
un veredicto de entregabilidad DQEDetailCode (DQEDetailCode)
y un desglose opcional de los campos corregidos.
Cuándo llamar a este endpoint - CheckAddress
es el paso de validación de nivel 2. Actívalo cuando el usuario
escriba una dirección libremente o modifique una sugerencia
de DQE
antes
de enviarla. Si el usuario aceptó una sugerencia de DQE tal
cual,
la calidad ya está garantizada - no es necesaria ninguna
llamada.
Solicitud
Se admiten tanto GET como POST.
{SERVER_ADDRESS} y
{LICENCE_CODE} son proporcionados por DQE
al
crear la cuenta. Ponte en contacto con tu gestor de cuenta
DQE
para
obtener estas credenciales.
{VERSION} es la versión de la API que llamas
-
v1 o v2. No es una
credencial específica de la cuenta, la eliges tú mismo en
la URL.
La dirección debe codificarse para URL - p. ej.
l'église
→ l%27%C3%A9glise.
GEThttps://{SERVER_ADDRESS}/{VERSION}/checkaddress/?Address={INPUT}&Country={COUNTRY_CODE}&Licence={LICENCE_CODE}
Ejemplos de código
Francia - con Modification=O y Version=1.1
curl "https://{SERVER_ADDRESS}/v1/checkaddress/?Address=%7C1%20rue%20de%20la%20louisiane%7C%7C31200%7Ctoulouse&Country=FRA&Length=38&Modification=O&Version=1.1&Licence={LICENCE_CODE}"
fetch("https://{SERVER_ADDRESS}/v1/checkaddress/?"
+ new URLSearchParams({
Address: "|1 rue de la louisiane||31200|toulouse",
Country: "FRA",
Length: "38",
Modification: "O",
Version: "1.1",
Licence: "{LICENCE_CODE}"
}))
.then(r => r.json())
.then(data => console.log(data));
import requests
response = requests.get(
"https://{SERVER_ADDRESS}/v1/checkaddress/",
params={
"Address": "|1 rue de la louisiane||31200|toulouse",
"Country": "FRA",
"Length": "38",
"Modification": "O",
"Version": "1.1",
"Licence": "{LICENCE_CODE}",
},
)
print(response.json())
<?php
$params = http_build_query([
'Address' => '|1 rue de la louisiane||31200|toulouse',
'Country' => 'FRA',
'Length' => '38',
'Modification' => 'O',
'Version' => '1.1',
'Licence' => '{LICENCE_CODE}',
]);
$ch = curl_init("https://{SERVER_ADDRESS}/v1/checkaddress/?{$params}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER,
true);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
const axios = require('axios');
axios.get('https://{SERVER_ADDRESS}/v1/checkaddress/',
{
params: {
Address: '|1 rue de la louisiane||31200|toulouse',
Country: 'FRA',
Length: '38',
Modification: 'O',
Version: '1.1',
Licence: '{LICENCE_CODE}'
}
})
.then(response => console.log(response.data));
HttpClient client = HttpClient.newHttpClient();
String url = "https://{SERVER_ADDRESS}/v1/checkaddress/"
+ "?Address=%7C1%20rue%20de%20la%20louisiane%7C%7C31200%7Ctoulouse&Country=FRA&Length=38&Modification=O&Version=1.1&Licence={LICENCE_CODE}";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(url))
.GET()
.build();
HttpResponse<String> response = client.send(request,
HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
using var client = new HttpClient();
var url = "https://{SERVER_ADDRESS}/v1/checkaddress/"
+
"?Address=%7C1%20rue%20de%20la%20louisiane%7C%7C31200%7Ctoulouse&Country=FRA&Length=38&Modification=O&Version=1.1&Licence={LICENCE_CODE}";
var response = await client.GetAsync(url);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://{SERVER_ADDRESS}/v1/checkaddress/"
+
"?Address=%7C1%20rue%20de%20la%20louisiane%7C%7C31200%7Ctoulouse&Country=FRA&Length=38&Modification=O&Version=1.1&Licence={LICENCE_CODE}"
resp, err := http.Get(url)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}
Internacional - Italia
curl "https://{SERVER_ADDRESS}/v1/checkaddress/?Address=%7CSTRADA%20BARDONEY%7C%7C11028%7CVALTOURNENCHE&Country=ITA&Length=38&Licence={LICENCE_CODE}"
POSThttps://{SERVER_ADDRESS}/{VERSION}/checkaddress/
Envía todos los parámetros en el cuerpo de la solicitud
usando
Content-Type: application/x-www-form-urlencoded.
La dirección del servidor permanece en la URL.
Ejemplos de código
Francia - dirección completa con indicador Modification
curl -X POST "https://{SERVER_ADDRESS}/v1/checkaddress/"
\
-H "Content-Type: application/x-www-form-urlencoded"
\
-d "Address=%7C1+rue+de+la+louisiane%7C%7C31200%7Ctoulouse"
\
-d "Country=FRA" \
-d "Length=38" \
-d "Modification=O" \
-d "Version=1.1" \
-d "Licence={LICENCE_CODE}"
fetch("https://{SERVER_ADDRESS}/v1/checkaddress/",
{
method: "POST",
headers: { "Content-Type": "application/x-www-form-urlencoded"
},
body: new URLSearchParams({
Address: "|1 rue de la louisiane||31200|toulouse",
Country: "FRA",
Length: "38",
Modification: "O",
Version: "1.1",
Licence: "{LICENCE_CODE}"
})
})
.then(r => r.json())
.then(data => console.log(data));
import requests
response = requests.post(
"https://{SERVER_ADDRESS}/v1/checkaddress/",
data={
"Address": "|1 rue de la louisiane||31200|toulouse",
"Country": "FRA",
"Length": "38",
"Modification": "O",
"Version": "1.1",
"Licence": "{LICENCE_CODE}",
},
)
print(response.json())
<?php
$ch = curl_init("https://{SERVER_ADDRESS}/v1/checkaddress/");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query([
'Address' => '|1 rue de la louisiane||31200|toulouse',
'Country' => 'FRA',
'Length' => '38',
'Modification' => 'O',
'Version' => '1.1',
'Licence' => '{LICENCE_CODE}',
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER,
true);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
const axios = require('axios');
const qs = require('querystring');
axios.post('https://{SERVER_ADDRESS}/v1/checkaddress/',
qs.stringify({
Address: '|1 rue de la louisiane||31200|toulouse',
Country: 'FRA',
Length: '38',
Modification: 'O',
Version: '1.1',
Licence: '{LICENCE_CODE}'
}))
.then(response => console.log(response.data));
HttpClient client = HttpClient.newHttpClient();
String form = "Address=%7C1%20rue%20de%20la%20louisiane%7C%7C31200%7Ctoulouse&Country=FRA&Length=38&Modification=O&Version=1.1&Licence={LICENCE_CODE}";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://{SERVER_ADDRESS}/v1/checkaddress/"))
.header("Content-Type", "application/x-www-form-urlencoded")
.POST(HttpRequest.BodyPublishers.ofString(form))
.build();
HttpResponse<String> response = client.send(request,
HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
using var client = new HttpClient();
var form = new Dictionary<string, string>
{
["Address"] = "|1 rue de la louisiane||31200|toulouse",
["Country"] = "FRA",
["Length"] = "38",
["Modification"] = "O",
["Version"] = "1.1",
["Licence"] = "{LICENCE_CODE}"
};
var response = await client.PostAsync(
"https://{SERVER_ADDRESS}/v1/checkaddress/",
new FormUrlEncodedContent(form));
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
form := url.Values{}
form.Set("Address", "|1 rue de la louisiane||31200|toulouse")
form.Set("Country", "FRA")
form.Set("Length", "38")
form.Set("Modification", "O")
form.Set("Version", "1.1")
form.Set("Licence", "{LICENCE_CODE}")
resp, err := http.PostForm("https://{SERVER_ADDRESS}/v1/checkaddress/",
form)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}
Parámetros
| Parámetro | Valor | Descripción | Obl. / Opc. |
|---|---|---|---|
| Licence |
{LICENCE_CODE}
|
Tu clave de licencia DQE o token OAuth2. Ponte en contacto con soporte si aún no tienes una. | Obligatorio |
| Address |
{INPUT}
|
Cadena de dirección separada por barras verticales.
Las cinco barras
son obligatorias incluso cuando los campos están
vacíos.
Para
Francia, se puede anteponer un sexto segmento
para
el punto de entrega (apartamento, piso, buzón).
dirección adicional|dirección|localidad dependiente o estado|código postal|ciudad
Ejemplo:
|
Obligatorio |
| Country |
{COUNTRY_CODE}
|
Código de país ISO 3166-1 alfa-3 para el ámbito
de
búsqueda de la dirección. Ejemplo: FRA
o
GBR.
|
Obligatorio |
| Length |
{LENGTH}
|
Límite de caracteres para el campo de respuesta
Address. Se aplica solo a direcciones
con caracteres
latinos. Por defecto: 38. Mínimo
recomendado:
32.
|
Opcional |
| Suggestion |
{PROP}
|
Solo Francia. Controla cómo se devuelven los
resultados de
corrección.O - El registro "1"
contiene
el resultado de corrección estándar. Si la dirección
no se puede emparejar de forma única, se devuelven
sugerencias
adicionales como registros "2"
a "n".S - El registro "1"
devuelve
la dirección de entrada tal cual con su estado
de validación
(sin corregir). Si se encuentra una corrección
clara,
se devuelve como registro "2".
Activa
automáticamente Modification=O.
|
Opcional |
| Modification |
O
|
Valor fijo O. Añade
ChangedAddressTag e
IsAddressChanged a la respuesta,
indicando qué campos de la dirección se ajustaron
(dirección adicional, dirección, localidad dependiente,
código postal o ciudad). Ver
ChangedAddressTag.
|
Opcional |
| Version |
{VERSION}
|
1.1 - Añade campos de calidad de
geocodificación (LatLonLabel,
LatLonCode)
a la respuesta (solo Francia, se requiere
suscripción
- contacta con tu gestor de cuenta DQE para activarla).
|
Opcional |
Campos de la respuesta
La respuesta es un objeto JSON con dos claves de nivel superior:
Found (entero) y Addresses
(un array
de objetos de dirección). Cuando Suggestion=O,
se
pueden devolver varios objetos de dirección.
Campos de complemento - La validación se
aplica
hasta
el número de calle. Cuando se envía un complemento
(nombre
de edificio, piso, etc.) y coincide con un complemento de
referencia,
el
motor lo enriquece con el nombre completo registrado. Cuando
no
se envía ningún complemento, se devuelve la lista completa
de complementos disponibles
(separados por punto y coma). Los complementos no reconocidos
se devuelven tal cual.
Mayúsculas de salida - El uso de mayúsculas
sigue la
norma postal
del país correspondiente.
Nivel superior
| Key | Description | Type |
|---|---|---|
| Found | Número de objetos de dirección devueltos. | Integer |
| Addresses | Array de objetos de dirección. | Array |
Objeto de dirección - Addresses[0]
| Key | Description | France | International |
|---|---|---|---|
| Address | Línea de dirección normalizada (número, tipo y nombre de calle). | String (38) | String (50) |
| PostalCode | Código postal. | String (5) | String (10) |
| City | Nombre de la ciudad. | String (38) | String (50) |
| Hamlet | Localidad con nombre o aldea (Francia) o campo equivalente a nivel de distrito (internacional). La disponibilidad varía según el país. | String (38) | String (50) |
| SpecialDistribution |
Indicador CEDEX: 1 = dirección CEDEX,
0 = no CEDEX.
|
String (1) | String (1) |
| Country | Código de país ISO 3166-1 alfa-3. | String (3) | String (3) |
| StateCode | Código ISO de la región o estado administrativo. |
Always "*"
|
String (50) |
| SubLocality | Sublocalidad. | Empty | String (50) |
| CityId | Identificador único de la ciudad (código INSEE para Francia). | String (20) | String (20) |
| Input | No se completa en este endpoint. Siempre devuelve una cadena vacía. | String | String |
| Label | Etiqueta de visualización formateada para la dirección. No se devuelve para todos los conjuntos de datos internacionales. | String | String |
| AdditionalAddress | Información adicional de la dirección (nombre de edificio, piso, etc.). | String (1024) | String (150) |
| StreetNumber | Número de calle completo incluyendo cualquier complemento (bis, ter, etc.). | String (10) | String (10) |
| StreetType |
Tipo de calle (p. ej., RUE, AVENUE,
BOULEVARD).Vacío cuando el tipo de calle está incluido en el nombre de la calle como una sola palabra compuesta (en cuyo caso el nombre completo se devuelve en Street).
|
String (20) | String (20) |
| Street |
Nombre de la calle sin número ni tipo. Excepción: cuando el tipo de calle está incluido en el nombre de la calle como una sola palabra compuesta (p. ej. Tannenburgweg), aquí se devuelve el nombre completo y StreetType queda vacío.
|
String (38) | String (50) |
| StreetId | Identificador único de la calle. | String (20) | String (20) |
| IsValidStreetNumber |
Indicador de validez del número de calle. 1
si el número existe en los datos de referencia,
0
en caso contrario. Devuelve una cadena vacía
para algunas
direcciones
internacionales donde la validación a nivel de
número no
está disponible.
|
Integer | Integer |
| StreetNumberListCount | Cuando el número consultado no se encuentra o falta, devuelve el recuento total de números de calle válidos para esta calle. Puede ser una cadena vacía para algunas direcciones internacionales donde este dato no está disponible. | String | String |
| StreetNumberList | Lista de todos los números válidos de esta calle, separados por punto y coma. Se completa cuando el número enviado es inválido o está ausente. | String (1024) | String (1024) |
| StreetNumberOnly | Solo el número de calle, sin ningún complemento (bis, ter, etc.). | String (10) | String (10) |
| StateLabel | Etiqueta de la región o estado. | No disponible | String |
| AdministrativeArea | Condado o nivel administrativo equivalente. | Empty | String |
| Suburb | Barrio periférico. | Empty | String |
| Company | Nombre de la empresa asociada a la dirección. | String (38) | String (38) |
| Latitude | Coordenadas geográficas de la dirección encontrada. No disponibles para todos los países - ver coverage. | String | String |
| Longitude | Coordenadas geográficas de la dirección encontrada. No disponibles para todos los países - ver coverage. | String | String |
| Informations | Objeto de metadatos de validación de DQE. Ver a continuación. | Object | Object |
Objeto Informations - Addresses[0].Informations
| Key | Description | France | International |
|---|---|---|---|
| DQEDetailCode | Código de resultado de la validación. Ver DQEDetailCode a continuación. | String (2) | String (2) |
| DQEErrorAddressLabel |
Etiqueta de texto plano del resultado de la validación
(OK
o una descripción de error).
|
String (38) | String (38) |
| AdditionalAddressComp | Información adicional de la línea de dirección 2. | String (38) | String (38) |
| StreetNumberComp | Complemento del número de calle (bis, ter, etc.). | String (38) | String (50) |
| StreetNumberId | Identificador único del número de calle (Hexaclé para Francia). | String (10) | No disponible |
| PostalCityId | Identificador postal de la ciudad (código Hexaposte para Francia). | String (6) | No disponible |
| IrisCode | Código de unidad estadística IRIS. Solo Francia, se requiere suscripción - contacta con tu gestor de cuenta DQE para activarla. | String (9) | No disponible |
| RoudisCode | Código de enrutamiento Roudis. Solo Francia. | String (5) | No disponible |
| LatLonLabel |
Etiqueta de calidad de geocodificación (p. ej.,
ENTREE,
BATIMENT). Se devuelve cuando
Version=1.1. Ver
Calidad de geocodificación.
|
String | No disponible |
| LatLonCode |
Código numérico de calidad de geocodificación.
Se devuelve
cuando
Version=1.1.
|
String | No disponible |
| IsAddressChanged |
1 si se ajustó al menos un campo,
0 en caso contrario. Siempre presente
en la
respuesta.
|
String (1) | String (1) |
| ChangedAddressTag |
Cadena binaria de 5 caracteres que indica qué
campos
de la dirección
se ajustaron. Ver
ChangedAddressTag.
Siempre presente; se completa cuando se establece
Modification=O.
|
String (5) | String (5) |
Populated
when Version=1.1Populated
when Modification=O
Response example
1 Rue de la Louisiane 31200 Toulouse
{
"Found": 1,
"Addresses": [
{
"Address":
"1 RUE DE LA LOUISIANE",
"PostalCode":
"31200",
"City":
"TOULOUSE",
"Hamlet":
"",
"SpecialDistribution":
"",
"Country":
"FRA",
"StateCode":
"*",
"SubLocality":
"",
"CityId":
"31555",
"Input":
"",
"Label":
"",
"AdditionalAddress":
"BATIMENT D RESIDENCE ALLEE DES CEDRES;BATIMENT A RESIDENCE ALLEE DES CEDRES;BATIMENT B RESIDENCE ALLEE DES CEDRES;BATIMENT C RESIDENCE ALLEE DES CEDRES",
"StreetNumber":
"",
"StreetType":
"RUE",
"Street":
"DE LA LOUISIANE",
"StreetId":
"2408474",
"IsValidStreetNumber":
"",
"StreetNumberListCount":"",
"StreetNumberList":
"",
"StreetNumberOnly":
"1",
"StateLabel":
"",
"AdministrativeArea":
"",
"Suburb":
"",
"Company":
"",
"Latitude":
"43.634746",
"Longitude":
"1.430098",
"Informations": {
"DQEDetailCode":
"10",
"DQEErrorAddressLabel":
"OK",
"AdditionalAddressComp":"",
"StreetNumberComp":
"",
"StreetNumberId":
"3155526YEA",
"PostalCityId":
"14411",
"IrisCode":
"3701",
"RoudisCode":
"4221",
"LatLonLabel":
"",
"LatLonCode":
"",
"IsAddressChanged":
"1",
"ChangedAddressTag":
"" }
}
]
}
DQEDetailCode
Addresses[0].Informations.DQEDetailCode
es el
indicador principal
del resultado de validación. Úsalo para determinar
la acción a tomar tras el envío del formulario.
Para ver los mensajes de interfaz recomendados asociados
a cada código,
consulta
la
guía de integración.
| Code | Description |
|---|---|
| 10 | Dirección correcta |
| 20 | Dirección correcta (street not recognized, but it is a CEDEX or P.O. box) |
| 21 | Población pequeña, número de calle fuera de rango |
| 22 | Población pequeña, falta el número de calle (el resto de la dirección es correcto) |
| 23 | Ciudad grande, número de calle fuera de rango |
| 24 | Ciudad grande, falta el número de calle (el resto de la dirección es correcto) |
| 25 | Dirección CEDEX desconocida para CEDEXA (si CEDEXA está activo) |
| 30 | Población pequeña, calle no reconocida |
| 31 | Población pequeña - calle no reconocida o ausente; información de distrito reconocida pero insuficiente para determinar la calle. Solo Francia. |
| 40 | No se espera en los despliegues cloud actuales. Definido por compatibilidad. |
| 41 | Población pequeña, falta la calle |
| 50 | Ciudad grande, calle no reconocida |
| 51 | Ciudad grande, calle no reconocida o ausente (información de distrito reconocida pero insuficiente para determinar la calle). Solo Francia. |
| 60 | No se espera en los despliegues cloud actuales. Definido por compatibilidad. |
| 61 | Ciudad grande, falta la calle |
| 70 | Código postal / ciudad no coinciden - calle presente |
| 71 | No se espera en los despliegues cloud actuales. Definido por compatibilidad. |
| 80 | Código postal / ciudad no coinciden - falta la calle |
| 81 | Bloque de dirección de entrada vacío. No se devuelve para Francia. |
| 90 | Dirección internacional detectada - el código de país de entrada no parece coincidir con la dirección de entrada. |
| 95 | Código de país ausente o incorrecto |
Población pequeña frente a ciudad grande -
En Francia, una ciudad
se considera grande cuando tiene más de 2
500
habitantes. A nivel internacional, el umbral es de 500 calles.
Esta distinción determina si se aplican los códigos de población
pequeña
(21,
22, 30, 31, 41) o los códigos de ciudad grande (23, 24, 50,
51,
61).
Distrito - Los códigos
31 y
51 indican que se reconoció un distrito:
una zona geográfica identificada por el motor (p. ej. una
aldea
o urbanización) que no se puede emparejar con una calle
específica.
Estos códigos son exclusivos de Francia.
DQEDetailCode - ejemplos de entrada
Entradas de ejemplo que producen cada código. Los campos no indicados se dejan vacíos.
| Code | France | 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 |
No se devuelve fuera de Francia |
| 40 | No se espera en los despliegues cloud actuales. Definido por compatibilidad. | No se espera en los despliegues cloud actuales. Definido por compatibilidad. |
| 41 | |||24130|Ginestet |
|||70011|AlberobelloITA |
| 50 | |route du chardonnay||75009|Paris |
|STREET ABCD||60607|CHICAGOUSA |
| 51 | |Lotissement Casella||20243|PRUNELLI DI FIUMORBO |
No se devuelve fuera de Francia |
| 60 | No se espera en los despliegues cloud actuales. Definido por compatibilidad. | No se espera en los despliegues cloud actuales. Definido por compatibilidad. |
| 61 | |||75009|Paris |
|||60607|CHICAGOUSA |
| 70 | |rue de la mairie||75009|Bordeaux |
|FRANKLIN GTWY SE||00067|MARIETTAUSA |
| 71 | No se espera en los despliegues cloud actuales. Definido por compatibilidad. | No se espera en los despliegues cloud actuales. Definido por compatibilidad. |
| 80 | |||75009|Bordeaux |
|||00067|MARIETTAUSA |
| 81 | No se devuelve para Francia | |||| |
| 90 |
|7C avenue Monbijou||4960|MalmedyCountry: FRA - la dirección no parece francesa |
- |
| 95 | - | - |
ChangedAddressTag
Se devuelve cuando se añade Modification=O a la solicitud. IsAddressChanged is 1 if any field was adjusted, 0 otherwise. ChangedAddressTag es una cadena binaria de 5 caracteres, una posición por campo de dirección. 1 = ajustado por DQE, 0 = sin cambios.
dirección adicional|dirección|localidad dependiente|código postal|ciudad
| ChangedAddressTag | Meaning |
|---|---|
00000 |
Ningún campo ajustado - dirección aceptada tal como se envió. |
11111 |
Los cinco campos ajustados. |
00011 |
Código postal y ciudad ajustados; los demás campos sin cambios. |
01111 |
Dirección, localidad dependiente, código postal y ciudad ajustados; dirección adicional sin cambios. |
10000 |
Solo se ajustó la dirección adicional. |
01000 |
Solo se ajustó la línea de dirección. |
00100 |
Solo se ajustó la localidad dependiente. |
Consejo - Cuando
IsAddressChanged is 1, al menos un campo fue modificado por DQE. Muestra la corrección al usuario como una ventana emergente, conservando siempre la opción de mantener su entrada original.Calidad de geocodificación
Cuando se establece Version=1.1 y se tiene suscripción de geocodificación, se completan dos campos dentro del objeto Informations: LatLonLabel (etiqueta) y LatLonCode (código numérico). Solo Francia.
| Code | LatLonLabel | Description |
|---|---|---|
| 1 | ENTREE | Punto de acceso principal a un recinto, grupo de edificios o parcela de terreno (placa de dirección). |
| 2 | BATIMENT | Edificio o parte de un edificio. |
| 3 | ESCALIERS | Hueco de escalera, normalmente dentro de un edificio. |
| 4 | LOGEMENT | Vivienda o habitación dentro de un edificio. |
| 5 | PARCELLE CADASTRALE | Parcela catastral. |
| 6 | SEGMENT DE VOIE | Posición derivada del tramo de calle de conexión. Puede estar fuera del polígono de la ciudad pero en la misma calle. |
| 7 | POINT D ACCESS TECHNIQUE | Punto de acceso técnico (corte de agua, electricidad, gas, etc.). |
| 8 | POINT DELIVRANCE POSTALE | Punto de entrega postal (buzón). |
| 9 | ZONE D ADRESSAGE | Punto ubicado en la localidad dependiente. |
| 10 | CENTRE VILLE | Centro de la ciudad. |
| 0 | CENTRE DE LA VOIE | Punto en el centro de la calle. |
| 90 | A CONTROLER | Calidad de geocodificación incierta - debe verificarse. |
| 99 | NON PRESENTE | Geocodificación no disponible para esta dirección. |
Errores
El endpoint RESTful devuelve un cuerpo de error JSON estructurado con un código de estado HTTP, un mensaje y un identificador de error.
| HTTP | Error type | Response body |
|---|---|---|
| 400 | Falta el parámetro Licence
|
{"status":400,"message":"Missing parameters","details":"Licence","error":"bad request"} |
| 400 | El parámetro Licence está vacío |
{"status":400,"message":"Licence must be filled","details":"Empty","error":"bad request"} |
| 401 | Número de licencia incorrecto | {"status":401,"message":"Your licence is not allowed to cover this functionnality","details":"{WRONG}","error":"unauthorized_client"} |
| 400 | Falta el parámetro Address
|
{"status":400,"message":"Missing parameters","details":"Address","error":"bad request"} |
| 400 | Falta el parámetro Country
|
{"status":400,"message":"Missing parameters","details":"Country","error":"bad request"} |
| 400 | El parámetro Country está vacío |
{"status":400,"message":"Country must be filled","details":"Empty","error":"bad request"} |
| 400 | Error tipográfico en el nombre del parámetro | {"status":400,"message":"Missing parameters","details":"Address","error":"bad request"} |
Prueba la API
Haz clic en el botón de abajo para probar este endpoint en vivo en tu navegador.
Abrir consola
Ver también
Relacionada con