Web Services de Géolocalisation
Mise en place et utilisation
Inclure la librairie javascript
SpwGeolocalisationApi.js :
<script type='text/javascript' src='REPLACE'></script>
Une fois la librairie chargée, la variable globale
spwGeolocalisation
est créée.
Cet objet dispose de méthodes appelant le web service de géolocalisation.
Chacune de ces méthodes lance un appel Ajax au web service de géolocalisation.
Ces appels Ajax étant asychrones, les méthodes ne renvoient jamais de valeur, c'est pourquoi elles possèdent toutes les deux mêmes derniers paramètres :
- onSuccess : fonction appelée en cas de succès. Elle a un paramètre contenant la réponse du serveur
- onError : fonction appelée en cas d'erreur. Elle a 3 paramètres : request, status et error
Exemple :
spwGeolocalisation.getListeLocalitesByCp(6987, getListeLocalitesByCpSuccessHandler, getListeLocalitesByCpErrorHandler);
function getListeLocalitesByCpSuccessHandler(data) {
alert(data.localites.length);
}
function getListeLocalitesByCpErrorHandler(request, status, error) {
alert("Une erreur est survenue lors du chargement des localités : " + error);
}
Proxy
L'utilisation d'un proxy permet de contourner le problème de "Cross-Domain" en javascript.
Ce proxy consiste en du code qui s'exécute sur votre serveur Web.
Le navigateur envoie la requête à votre proxy et le proxy à son tour, transmet la requête au serveur voulu.
L'initialisation de l'URL vers page proxy est nécessaire avant tout appel à une des méthodes de l'API de géolocalisation.
Exemples :
spwGeolocalisation.setProxyPage("proxy.jsp?");
ou
spwGeolocalisation.setProxyPage("/cgi-bin/proxy.cgi?url=");
Il est également possible de spécifier si l'url que envoyée au proxy doit être 'Url encodée'.
Par défaut, l'url n'est pas encodée.
Exemple :
spwGeolocalisation.setEncodeUrl(true);
Pour les applications J2EE, la page proxy.jsp est disponible ici.
Liste des méthodes
getVersion
Description |
Renvoie la version du jeu de donnees courante |
Paramètres |
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
getListeCommunes
Description |
Renvoie la liste des communes wallonnes |
Paramètres |
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
searchCommunes
Description |
Recherche phonetique de communes |
Paramètres |
- search : Chaine recherchee
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
getListeLocalites
Description |
Renvoie la liste des localites wallonnes |
Paramètres |
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
getListeLocalitesByCp
Description |
Renvoie la liste des localites correspondant a un code postal |
Paramètres |
- cp : Code postal
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
getListeLocalitesByIns
Description |
Renvoie la liste des localites correspondant a un code INS |
Paramètres |
- ins : Code INS
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
searchLocalites
Description |
Recherche phonetique de localites |
Paramètres |
- search : Chaine recherchee
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
getListeRuesByCp
Description |
Renvoie la liste des rues correspondant a un code postal |
Paramètres |
- cp : Code postal
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
getListeRuesOfAllCpsOfCommuneByCp
Description |
Renvoie la liste des rues correspondant a tous les codes postaux de la commune dont fait partie le code postal passe en parametre |
Paramètres |
- cp : Code postal
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
getListeRuesByLocalite
Description |
Renvoie la liste des rues correspondant a une localite |
Paramètres |
- localite : Localite
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
getListeRuesByCpAndNomApprox
Description |
Renvoie la liste des rues correspondant a un code postal et a un nom de rue approximatif |
Paramètres |
- cp : Code postal
- nomRueApprox : Nom de rue approximatif
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
getListeRuesByLocaliteAndNomApprox
Description |
Renvoie la liste des rues correspondant a une localite et a un nom de rue approximatif |
Paramètres |
- localite : Localite
- nomRueApprox : Nom de rue approximatif
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
getListeRuesOfAllCpsOfCommuneByCpAndNomApprox
Description |
Renvoie la liste des rues correspondant a tous les codes postaux de la commune dont fait partie le code postal passe en parametre et a un nom de rue approximatif. La liste est triee par score puis par code postal avec la priorite au code postal passe en parametre. |
Paramètres |
- cp : Code postal
- nomRueApprox : Nom de rue approximatif
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
getListeRuesByCommune
Description |
Renvoie la liste des rues correspondant appartenant a une commune (nom exact) |
Paramètres |
- commune : Commune
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
searchRues
Description |
Recherche phonetique de rues sur leur nom, leur localite et leur commune |
Paramètres |
- search : Chaine recherchee
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
getNearestRue
Description |
Renvoie la rue la plus proche des coordonnees lambert passees en parametre |
Paramètres |
- x : Coordonnee X
- y : Coordonnee Y
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
getListPositionsByCpAndRue
Description |
Renvoie une liste de positions en milieu de rue correspondant aux renseignements passes en parametres |
Paramètres |
- cp : Code postal
- rue : Nom de la rue
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
getPositionByCpAndRue
Description |
Renvoie la position du milieu de la rue correspondant exactement aux renseignements passes en parametres |
Paramètres |
- cp : Code postal
- rue : Nom de la rue
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
getListPositionsByCpRueAndNumero
Description |
Renvoie une liste de positions correspondant aux renseignements passes en parametres |
Paramètres |
- cp : Code postal
- rue : Nom de la rue
- numero : Numero de bâtiment
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
getPositionByCpRueAndNumero
Description |
Renvoie la position du batiment correspondant aux renseignements passes en parametres |
Paramètres |
- cp : Code postal
- rue : Nom de la rue
- numero : numero de bâtiment
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
getListPositionsByCpLocaliteRueAndNumero
Description |
Renvoie une liste de positions correspondant aux renseignements passes en parametres |
Paramètres |
- cp : Code postal
- localite : Nom de la localite
- rue : Nom de la rue
- numero : numero de bâtiment
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
getPositionByCpLocaliteRueAndNumero
Description |
Renvoie la position du batiment correspondant aux renseignements passes en parametres |
Paramètres |
- cp : Code postal
- localite : Nom de la localite
- rue : Nom de la rue
- numero : numero de batiment
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
searchPosition
Description |
Recherche une position sur base de la chaine de recherche passee en parametre |
Paramètres |
- search : Chaine de recherche
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
searchPositionScored
Description |
Recherche une position avec score sur base de la chaine de recherche passee en parametre |
Paramètres |
- search : Chaine de recherche
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
getNearestPosition
Description |
Renvoie la position la plus proche des coordonnees lambert passees en parametre |
Paramètres |
- x : Coordonnee X
- y : Coordonnee Y
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
searchAll
Description |
Recherche tout type d'objet sur base de la chaine de recherche passee en parametre |
Paramètres |
- search : Chaine de recherche
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
getProvinceByCp
Description |
Recherche la province contenant le code postal passe en parametre |
Paramètres |
- cp : Code postal
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
getListeProvincesRW
Description |
Retourne la liste des provinces de la Région Wallonne + Bruxelles |
Paramètres |
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
getListeLocalitesByProvince
Description |
Recherche la liste des localites pour une province donnee |
Paramètres |
- province : Nom de la province
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
getListeCpsByProvince
Description |
Recherche la liste des codes postaux pour une province donnee |
Paramètres |
- province : Nom de la province
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
processBatchGeolocalisation
Description |
Test de la geolocalisation par lot |
Paramètres |
- batch : Lot d'adresses a geocoder
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
getListPositionsBySmartGeocoding
Description |
Renvoie une liste de positions correspondant aux renseignements passes en parametres avec choix intelligent du service de geocodage |
Paramètres |
- cp : Code postal
- localite : Nom de la localite
- rue : Nom de la rue
- numero : numero de batiment
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
getPositionBySmartGeocoding
Description |
Renvoie une position correspondant aux renseignements passes en parametres avec choix intelligent du service de geocodage |
Paramètres |
- cp : Code postal
- localite : Nom de la localite
- rue : Nom de la rue
- numero : numero de batiment
- onSuccess : Fonction appelée en cas de réponse
- onError : Fonction appelée en cas d'erreur
|
stringify
Description |
Converti un objet JSON en String |
Paramètres |
|