wiki:Geonol/API_REST/autocomplete_territory.json

Version 2 (modified by http://cbenz.myopenid.com/, 9 years ago) (diff)

--

Autocompleter

L'autocompleter est un service web qui renvoie une liste de communes françaises.

L'API de l'autocompleter est compatible avec celle de l'autocompleter de jquery-ui (http://jqueryui.com/demos/autocomplete).

Paramètres de la requête

L'autocompleter appelle l'URL http://annuaire.comarquage.fr/rest/autocomplete_territory.json

Les paramètres de « query string » :

  • jsonp (str) : nom de la fonction javascript retournée pour l'utilisation en AJAX depuis un autre domaine. (http://en.wikipedia.org/wiki/JSONP)
  • term (str) : la recherche de communes est effectuée sur ce paramètre. La recherche est « floue » (fuzzy-search) : elle compare les radicaux (stemming) des noms de communes, et non les chaînes de caractères exactes. Si ce paramètre est absent ou est une chaîne vide, la recherche renvoie les 10 premières communes triées par ordre alphabétique.

Réponse

Une liste de chaînes de caractères UTF-8 correspondant à des noms de communes françaises est retournée au format JSON.

Au cas où il y ait une ambiguïté sur le nom d'une commune, le code du département est spécifié entre parenthèses sur 2 caractères après le nom de la commune. Si plusieurs communes portent le même nom dans le même département, le code INSEE de la commune est spécifié entre parenthèses à la place du code du département.

Si le paramètre jsonp est fourni dans la requête, cette liste est encapsulée dans un appel de fonction dont le nom est la valeur du paramètre jsonp.

La liste est limitée à 10 éléments maximum.

Exemples

Implémentation

Cet autocompleter utilise le logiciel libre Podis2 : http://gitorious.org/infos-pratiques/podis2