L'endpoint BirthLocality récupère les localités françaises correspondant à un terme de recherche à une date donnée.
Documentation CityDate associée :
Requête GET
Endpoint
https://{SERVER_ADDRESS}/BirthLocality/?BirthDate={DATE}&Search={LOOKUP}&Licence={LICENCE_CODE}&NbMax={NB_MAX}Remplacez les valeurs entre accolades par vos propres informations :
| Paramètre | Valeur | Description | Obligatoire/Optionnel |
|---|---|---|---|
| SERVER_ADDRESS | {SERVER_ADDRESS} |
Adresse du serveur DQE qui traitera les données. | Obligatoire |
| Licence | {LICENCE_CODE} |
Code de licence attribué à votre compte. | Obligatoire |
| BirthDate | {DATE} |
Date au format YYYY-MM-DD. |
Obligatoire |
| Search | {LOOKUP} |
Champ de recherche utilisant le libellé de la localité ou le code INSEE. | Obligatoire |
| NbMax | {NB_MAX} |
Nombre maximum de résultats renvoyés par l'API. | Optionnel. Valeur par défaut : 20. |
Requête POST
Endpoint
https://{SERVER_ADDRESS}/BirthLocality/Ajoutez les paramètres suivants dans le corps de la requête au format x-www-form-urlencoded.
| Paramètre | Valeur | Description | Obligatoire/Optionnel |
|---|---|---|---|
| Licence | {LICENCE_CODE} |
Code de licence attribué à votre compte. | Obligatoire |
| BirthDate | {DATE} |
Date au format YYYY-MM-DD. |
Obligatoire |
| Search | {LOOKUP} |
Champ de recherche utilisant le libellé de la localité ou le code INSEE. | Obligatoire |
| NbMax | {NB_MAX} |
Nombre maximum de résultats renvoyés par l'API. | Optionnel. Valeur par défaut : 20. |
Réponse
Réponse de succès
| Clé | Description | Type |
|---|---|---|
| Found | Nombre total de résultats trouvés. | INTEGER |
| Results | Liste des localités renvoyées. | ARRAY |
| Results.City | Nom de la localité. | STRING(50) |
| Results.CountyCode | Code du comté ou du département. | STRING(2) |
| Results.CountyLabel | Libellé du comté ou du département. | STRING(50) |
| Results.CountryCode | Code du pays ou DROM. | STRING(2) |
| Results.CountryLabel | Libellé du pays ou DROM. | STRING(50) |
| Results.CodeInsee | Code INSEE de la localité. | STRING(5) |
| Results.ValidityStartDate | Date de début de validité du code INSEE. | DATE (YYYY-MM-DD) |
| Results.ValidityEndDate | Date de fin de validité du code INSEE. Vide si le code est toujours valide. | DATE (YYYY-MM-DD) / NULL |
Exemple :
{
"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": ""
}
]
}Voir aussi
Associé à