Requêtes avancées sur SityAPI¶
Outre les méthodes d’interrogation disponibles dans le descriptif de SityAPI. Certaines requêtes d’interrogation spécifiques ont été développées afin de permettre un filtrage plus avancé des résultats.
Ces paramètres ne faisant pas l’objet d’une utilisation courante, le choix a été fait de ne pas inclure par défaut la possibilité d’interroger le serveur sur base de ces critères.
Comment accéder aux requêtes avancées ?
Afin d’activer l’utilisation de requêtes avancées sur votre compte, veuillez en demander l’activation auprès de Geolives (contact at geolives dot com)
Comprendre le mécanisme de requêtes avancées¶
La critères avancés sont définis directement lors de l’appel à l’URL du serveur SityAPI et doivent dans certains cas faire l’objet d’un traitement préalable.
Liste des paramètres avancés¶
Filtrage¶
Les paramètres ci-dessous peuvent être définis par le développeur afin de “forcer” le filtrage selon un ou plusieurs critères.
| Attribut | Rôle | Valeur | Exemple |
|---|---|---|---|
lat - lon |
Filtrage par latitude/longitude (cercle) | Lat/Lon de la position recherchée | lat=50.12345&lon=5.12345 |
$cp |
Filtrage par code postal | Code postal | &cp=4020 |
$distmin - distmax |
Filtrage par longueur de rando | Longueur minimale/maximale de la rando (en m) | &distmin=1500&distmax=3000 |
$difficulty |
Filtrage par difficulté | Niveau de difficulté (0-4) | &difficulte=2 |
$nbpage |
Nombre de résultats par page | Code localité (cf. pagination | &nbpage=10 |
Pagination¶
Les résultats sont présentés sous forme de pages dans le but d’accélérer l’affichage et permettre une consultation plus aisée des résultats.
Le système ajoute automatiquement une barre de pagination au dessus et en dessous de la liste des résultats.
Deux paramètres peuvent être définis afin de paramétrer la pagination :
| Attribut | Rôle | Valeur | Exemple |
|---|---|---|---|
page |
Spécifie la page à consulter | Numéro de page. La numérotation commence à zéro | page=2 |
nbpage |
Nombre de résultats par page | Le nombre de résultats souhaités | &nbpage=10 |
Par défaut l’API génère des pages contenant cinq résultats.
Désactiver la pagination¶
Il est possible de désactiver la pagination en spécifiant un nombre de résultats supérieur au nombre total de randonnées de l’utilisateur.
Attention : Il est déconseillé de demander un nombre supérieur à 25 randonnées par page
Encodage¶
Les résultats sont par défaut encodés en ISO-8859-1. Il est possible de définir un encodage UTF-8 en spécifiant le paramètre
inUTF=true
JQuery¶
Par défaut, les résultats contiennent un appel aux librairies JQuery. Cependant de nombreux sites intègrent déjà JQuery dans le code de base des pages.
Afin d’éviter les conflits, il est possible de désactiver l’appel aux librairies JQuery :
nojquery=true