CityDate API - BirthLocality
El endpoint BirthLocality recupera localidades francesas que coinciden con un término de búsqueda en una fecha determinada.
Documentación relacionada de CityDate - El endpoint
API - Descripción - CityDate - CPFRA →
Introducción a CityDate →
BirthLocality busca localidades por nombre o código INSEE. ¿Busca en cambio comprobar la validez de una fecha de nacimiento para una ciudad conocida?API - Descripción - CityDate - CPFRA →
Introducción a CityDate →
BirthLocality
Solicitud
Se admiten tanto GET como POST.
{SERVER_ADDRESS} y {LICENCE_CODE} son proporcionados por DQE al crear la cuenta. Póngase en contacto con su gestor de cuenta de DQE para obtener estas credenciales.
GEThttps://{SERVER_ADDRESS}/BirthLocality/?BirthDate={DATE}&Search={LOOKUP}&Licence={LICENCE_CODE}&NbMax={NB_MAX}
Ejemplos de código
Buscar por nombre de localidad
curl "https://{SERVER_ADDRESS}/BirthLocality/?BirthDate=1980-05-15&Search=PARIS&Licence={LICENCE_CODE}"
fetch("https://{SERVER_ADDRESS}/BirthLocality/?" + new URLSearchParams({
BirthDate: "1980-05-15",
Search: "PARIS",
Licence: "{LICENCE_CODE}"
}))
.then(r => r.json())
.then(data => console.log(data));
import requests
response = requests.get(
"https://{SERVER_ADDRESS}/BirthLocality/",
params={
"BirthDate": "1980-05-15",
"Search": "PARIS",
"Licence": "{LICENCE_CODE}",
},
)
print(response.json())
<?php
$params = http_build_query([
'BirthDate' => '1980-05-15',
'Search' => 'PARIS',
'Licence' => '{LICENCE_CODE}',
]);
$ch = curl_init("https://{SERVER_ADDRESS}/BirthLocality/?{$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}/BirthLocality/', {
params: {
BirthDate: '1980-05-15',
Search: 'PARIS',
Licence: '{LICENCE_CODE}'
}
})
.then(response => console.log(response.data));
HttpClient client = HttpClient.newHttpClient();
String url = "https://{SERVER_ADDRESS}/BirthLocality/"
+ "?BirthDate=1980-05-15&Search=PARIS&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}/BirthLocality/" +
"?BirthDate=1980-05-15&Search=PARIS&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}/BirthLocality/" +
"?BirthDate=1980-05-15&Search=PARIS&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))
}
POSThttps://{SERVER_ADDRESS}/BirthLocality/
Añada los siguientes parámetros al cuerpo de la solicitud usando x-www-form-urlencoded. La dirección del servidor permanece en la URL.
Ejemplos de código
Buscar por nombre de localidad
curl -X POST "https://{SERVER_ADDRESS}/BirthLocality/" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "BirthDate=1980-05-15" \
-d "Search=PARIS" \
-d "Licence={LICENCE_CODE}"
fetch("https://{SERVER_ADDRESS}/BirthLocality/", {
method: "POST",
headers: { "Content-Type": "application/x-www-form-urlencoded" },
body: new URLSearchParams({
BirthDate: "1980-05-15",
Search: "PARIS",
Licence: "{LICENCE_CODE}"
})
})
.then(r => r.json())
.then(data => console.log(data));
import requests
response = requests.post(
"https://{SERVER_ADDRESS}/BirthLocality/",
data={
"BirthDate": "1980-05-15",
"Search": "PARIS",
"Licence": "{LICENCE_CODE}",
},
)
print(response.json())
<?php
$ch = curl_init("https://{SERVER_ADDRESS}/BirthLocality/");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query([
'BirthDate' => '1980-05-15',
'Search' => 'PARIS',
'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}/BirthLocality/', qs.stringify({
BirthDate: '1980-05-15',
Search: 'PARIS',
Licence: '{LICENCE_CODE}'
}))
.then(response => console.log(response.data));
HttpClient client = HttpClient.newHttpClient();
String form = "BirthDate=1980-05-15&Search=PARIS&Licence={LICENCE_CODE}";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://{SERVER_ADDRESS}/BirthLocality/"))
.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> {
["BirthDate"] = "1980-05-15",
["Search"] = "PARIS",
["Licence"] = "{LICENCE_CODE}"
};
var response = await client.PostAsync(
"https://{SERVER_ADDRESS}/BirthLocality/",
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("BirthDate", "1980-05-15")
form.Set("Search", "PARIS")
form.Set("Licence", "{LICENCE_CODE}")
resp, err := http.PostForm("https://{SERVER_ADDRESS}/BirthLocality/", form)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}
Parámetros
| Parámetro | Descripción | Obl / Opc |
|---|---|---|
| Licence | Código de licencia asignado a su cuenta. | Obligatorio |
| BirthDate | Fecha en formato YYYY-MM-DD. |
Obligatorio |
| Search | Campo de búsqueda usando el nombre de la localidad o el código INSEE. | Obligatorio |
| NbMax | Número máximo de resultados devueltos por la API. |
Opcional Predeterminado: 20
|
Respuesta
| Clave | Descripción | Tipo |
|---|---|---|
| Found | Número total de resultados encontrados. | INTEGER |
| Results | Lista de localidades devueltas. | ARRAY |
| Results.City | Nombre de la localidad. | STRING(50) |
| Results.CountyCode | Código de condado o departamento. | STRING(2) |
| Results.CountyLabel | Nombre de condado o departamento. | STRING(50) |
| Results.CountryCode | Código de país o DROM. | STRING(2) |
| Results.CountryLabel | Nombre de país o DROM. | STRING(50) |
| Results.CodeInsee | Código INSEE de la localidad. | STRING(5) |
| Results.ValidityStartDate | Fecha de inicio de validez del código INSEE. | DATE (YYYY-MM-DD) |
| Results.ValidityEndDate | Fecha de fin de validez del código INSEE. Vacío si el código sigue vigente. | DATE (YYYY-MM-DD) / NULL |
Códigos de país / DROM - FR = Francia, GP = Guadalupe, MQ = Martinica, GF = Guayana Francesa, RE = La Reunión, YT = Mayotte, PM = San Pedro y Miquelón, BL = San Bartolomé, MF = San Martín, PF = Polinesia Francesa, NC = Nueva Caledonia, WF = Wallis y Futuna, TF = Tierras Australes y Antárticas Francesas
Ejemplo de respuesta
Resultados de la búsqueda
{
"Found": 3,
"Results": [
{"City": "AAST", "CountyCode": "64", "CountyLabel": "PYRENEES-ATLANTIQUES", "CountryCode": "FR", "CountryLabel": "FRANCE", "CodeInsee": "64001", "ValidityStartDate": "1943-01-01", "ValidityEndDate": ""},
{"City": "ABAINVILLE", "CountyCode": "55", "CountyLabel": "MEUSE", "CountryCode": "FR", "CountryLabel": "FRANCE", "CodeInsee": "55001", "ValidityStartDate": "1943-01-01", "ValidityEndDate": ""}
]
}
Errores
| HTTP | Descripción |
|---|---|
| 400 | Solicitud incorrecta o falta un parámetro obligatorio — por ejemplo, falta BirthDate, Search o Licence. |
Probar la API
Haga clic en el botón de abajo para probar este endpoint en vivo desde su navegador.
Abrir consola
Ver también
Relacionada con