The BirthLocality endpoint retrieves French localities matching a search term at a given date.
Related CityDate documentation:
GET request
Endpoint
https://{SERVER_ADDRESS}/BirthLocality/?BirthDate={DATE}&Search={LOOKUP}&Licence={LICENCE_CODE}&NbMax={NB_MAX}Replace the values in braces with your own information:
| Parameter | Value | Description | Mandatory/Optional |
|---|---|---|---|
| SERVER_ADDRESS | {SERVER_ADDRESS} |
Address of the DQE server that will process the data. | Mandatory |
| Licence | {LICENCE_CODE} |
Licence code assigned to your account. | Mandatory |
| BirthDate | {DATE} |
Date in YYYY-MM-DD format. |
Mandatory |
| Search | {LOOKUP} |
Search field using locality label, postal code or INSEE code. | Mandatory |
| NbMax | {NB_MAX} |
Maximum number of results returned by the API. | Optional. Default value: 20. |
POST request
Endpoint
https://{SERVER_ADDRESS}/BirthLocality/Add the following parameters in the request body using x-www-form-urlencoded.
| Parameter | Value | Description | Mandatory/Optional |
|---|---|---|---|
| Licence | {LICENCE_CODE} |
Licence code assigned to your account. | Mandatory |
| BirthDate | {DATE} |
Date in YYYY-MM-DD format. |
Mandatory |
|
Search |
{LOOKUP} |
Search field using locality label, postal code or INSEE code. | Mandatory |
| NbMax | {NB_MAX} |
Maximum number of results returned by the API. | Optional. Default value: 20. |
Response
Success response
The JSON response contains the total number of results found and an array of returned localities.
| Key | Description | Type |
|---|---|---|
| Found | Total number of results found. | INTEGER |
| Results | List of returned localities. | ARRAY |
| Results.City | Locality name. | STRING(50) |
| Results.CountyCode | County or department code. | STRING(2) |
| Results.CountyLabel | County or department label. | STRING(50) |
| Results.CountryCode | Country or DROM code. | STRING(2) |
| Results.CountryLabel | Country or DROM label. | STRING(50) |
| Results.CodeInsee | Locality INSEE code. | STRING(5) |
| Results.ValidityStartDate | Start date of INSEE code validity. | DATE (YYYY-MM-DD) |
| Results.ValidityEndDate | End date of INSEE code validity. Empty if the code is still valid. | DATE (YYYY-MM-DD) / NULL |
Country and DROM codes
| Label | Code |
|---|---|
| FRANCE | FR |
| GUADELOUPE | GP |
| MARTINIQUE | MQ |
| GUYANE | GF |
| LA REUNION | RE |
| MAYOTTE | YT |
| SAINT PIERRE ET MIQUELON | PM |
| SAINT BARTHELEMY | BL |
| SAINT MARTIN | MF |
| POLYNESIE FRANCAISE | PF |
| NOUVELLE CALEDONIE | NC |
| WALLIS ET FUTUNA | WF |
| LES TERRES AUSTRALES ET ANTARTIQUES FRANCAISES | TF |
Example:
{
"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": ""
}
]
}Related to