Généralités
- Par défaut, le format de sortie est json.
-
Utilisez le paramètre format=xml ou format=json pour contrôler le format de sortie
/requests/SearchNearbyTowns.php?town_id=117&radius=20&format=xml -
Pour les requêtes SEARCH, utilisez le paramètre number_max pour limiter le nombre de résultat à récupérer
/requests/SearchTowns.php?region_id=1,6,12&number_max=2 -
Pour les requêtes SEARCH, utilisez le paramètre order_by pour trier les résultats par ordre croissant
/requests/SearchNearbyTowns.php?town_id=117&radius=20&order_by=distance -
Pour les requêtes SEARCH, utilisez le paramètre order_by_desc pour trier les résultats par ordre décroissant
/requests/SearchNearbyTowns.php?town_id=117&radius=20&order_by_desc=distance -
Utilisez le paramètre debug=true pour afficher la requête SQL générée
/requests/SearchNearbyTowns.php?town_id=117&radius=20&debug=true - Si vous rencontrez un problème avec la base de données, vous pouvez essayer de corriger le problème sur la page d'installation.
Liste des requêtes :
Pays
-
GetCountry Au moins un paramètre obligatoire
-
country_id : Id du pays recherché
/requests/GetCountry.php?country_id=1
-
country_id : Id du pays recherché
-
SearchCountries Au moins un paramètre obligatoire
-
country_id : Id's des pays recherchés
/requests/SearchCountries.php?country_id=1,2,3 -
code : Codes des pays recherchés
/requests/SearchCountries.php?code=250,251 -
name : Chaîne de caractère contenue dans le nom du pays recherché
/requests/SearchCountries.php?name=ance
-
country_id : Id's des pays recherchés
Régions
-
GetRegion Au moins un paramètre obligatoire
-
region_id : Id de la région recherchée
/requests/GetRegion.php?region_id=3
-
region_id : Id de la région recherchée
-
SearchRegions Au moins un paramètre obligatoire
-
region_id : Id's des régions recherchées
/requests/SearchRegions.php?region_id=1,6,12 -
country_id : Id's des pays dans lesquels se trouvent les régions
/requests/SearchRegions.php?country_id=1,2,3 -
code : Chaîne de caractères contenue dans le code de la région recherchée
/requests/SearchRegions.php?code=FR-B -
name : Chaîne de caractères contenue dans le nom nettoyé de la région recherchée
/requests/SearchRegions.php?name=ta
-
region_id : Id's des régions recherchées
Départements
-
GetDepartment Au moins un paramètre obligatoire
-
department_id : Id du département recherché
/requests/GetDepartment.php?department_id=36
-
department_id : Id du département recherché
-
SearchDepartments Au moins un paramètre obligatoire
-
department_id : Id's des départements recherchés
/requests/SearchDepartments.php?department_id=1,6,12 -
region_id : Id's des régions dans lesquelles se trouvent les départements
/requests/SearchDepartments.php?region_id=1,6,12 -
code : Codes des départements recherchés
/requests/SearchDepartments.php?code=35,29,22,56 -
name : Chaîne de caractères contenue dans le nom nettoyé du département recherché
/requests/SearchDepartments.php?name=ter
-
department_id : Id's des départements recherchés
-
GetPrefixedDepartmentName Le paramètre department_id est obligatoire
- department_id : L'id du département à récupérer
-
prefix : Le préfixe à récupérer (Valeurs possibles : "de", "du", "dans", "en", "le", "la")
/requests/GetPrefixedDepartmentName.php?department_id=36&prefix=dans
Villes
-
GetTown Au moins un paramètre obligatoire
-
town_id : Id de la ville recherchée
/requests/GetTown.php?town_id=572
-
town_id : Id de la ville recherchée
-
SearchTowns Au moins un paramètre obligatoire
-
town_id : Id's des villes recherchées
/requests/SearchTowns.php?town_id=1,6,12 -
department_id : Id's des départements dans lesquels se trouvent les villes
/requests/SearchTowns.php?department_id=1,6,12 -
region_id : Id's des régions dans lesquelles se trouvent les villes
/requests/SearchTowns.php?region_id=1,6,12 -
insee : Codes insee des villes recherchées
/requests/SearchTowns.php?insee=01008,01009 -
zipcode : Codes postaux des villes recherchées
/requests/SearchTowns.php?zipcode=35000,35460 -
inhabitants_min : Nombres d'habitants minimum pour les villes recherchées
/requests/SearchTowns.php?inhabitants_min=10000 -
inhabitants_max : Nombres d'habitants maximum pour les villes recherchées
/requests/SearchTowns.php?inhabitants_max=500 -
zone : zone des villes recherchées
/requests/SearchTowns.php?zone=B1 -
actif : statut des villes recherchées
/requests/SearchTowns.php?actif=0 -
name : Chaîne de caractères contenue dans le nom nettoyé de la ville recherchée
/requests/SearchTowns.php?name=ter
-
town_id : Id's des villes recherchées
-
GetPrefixedTownName Le paramètre town_id est obligatoire
- town_id : L'id de la ville à récupérer
-
prefix : Le préfixe à récupérer (Valeurs possibles : "à", "de")
/requests/GetPrefixedTownName.php?town_id=31272&prefix=à
-
SearchNearbyTowns Tous les paramètres sont obligatoires
- town_id : L'id de la ville de référence
-
radius : Le rayon en km de la recherche
/requests/SearchNearbyTowns.php?town_id=11743&radius=20