CityDate API — Buscar una localidad de nacimiento por código postal

Support DQE
Support DQE
  • Actualización

El endpoint BirthLocality recupera las localidades francesas que coinciden con un término de búsqueda en una fecha determinada.

Documentación relacionada de CityDate:

Solicitud GET

Endpoint

https://{SERVER_ADDRESS}/BirthLocality/?BirthDate={DATE}&Search={LOOKUP}&Licence={LICENCE_CODE}&NbMax={NB_MAX}

Sustituya los valores entre llaves por su propia información:

Parámetro Valor Descripción Obligatorio/Opcional
SERVER_ADDRESS {SERVER_ADDRESS} Dirección del servidor DQE que procesará los datos. Obligatorio
Licence {LICENCE_CODE} Código de licencia asignado a su cuenta. Obligatorio
BirthDate {DATE} Fecha en formato YYYY-MM-DD. Obligatorio
Search {LOOKUP} Campo de búsqueda mediante el nombre de la localidad o el código INSEE. Obligatorio
NbMax {NB_MAX} Número máximo de resultados devueltos por la API. Opcional. Valor predeterminado: 20.

Solicitud POST

Endpoint

https://{SERVER_ADDRESS}/BirthLocality/

Añada los siguientes parámetros en el cuerpo de la solicitud usando x-www-form-urlencoded.

Parámetro Valor Descripción Obligatorio/Opcional
Licence {LICENCE_CODE} Código de licencia asignado a su cuenta. Obligatorio
BirthDate {DATE} Fecha en formato YYYY-MM-DD. Obligatorio
Search {LOOKUP} Campo de búsqueda mediante el nombre de la localidad o el código INSEE. Obligatorio
NbMax {NB_MAX} Número máximo de resultados devueltos por la API. Opcional. Valor predeterminado: 20.

Respuesta

Respuesta correcta

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 del departamento. STRING(2)
Results.CountyLabel Nombre del departamento. STRING(50)
Results.CountryCode Código del país o DROM. STRING(2)
Results.CountryLabel Nombre del 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 siendo válido. DATE (YYYY-MM-DD) / NULL

Ejemplo:

{
  "Found": 3,
  "Results": [
    {
      "City": "AAST",
      "CountyCode": "64",
      "CountyLabel": "PYRENEES-ATLANTIQUES",
      "CodeInsee": "64001",
      "ValidityStartDate": "1943-01-01",
      "ValidityEndDate": ""
    },
    {
      "City": "ABAINVILLE",
      "CountyCode": "55",
      "CountyLabel": "MEUSE",
      "CodeInsee": "55001",
      "ValidityStartDate": "1943-01-01",
      "ValidityEndDate": ""
    }
  ]
}

Véase también

Relacionada con

¿Fue útil este artículo?

Usuarios a los que les pareció útil: 0 de 0