Description des méthodes de l'API TrailManager

 

{{>toc}}

 
 

GetTrails

Action  Récupération de la liste des randonnées
Entrée GET/POST
Sortie JSON ([[api_json_trail|JSON TRAIL]])
Schéma d'appel
http://api.geolives.com/API_KEY/TrailManager?action=getTrails&page=1

Paramètres
 
Paramètre Obligatoire Val. défaut Argument Template Description
page - 1 Numéro de page &page=1 Numéro de page de résultats (début : 1)
pagesize - 6 Nombre de résultats par page &pagesize=6 Nombre de résultats par page
FILTRAGE
activite - - Numéro de l'activité &activite=1 Filtre sur le type de sport ([[Liste_des_codes_sport|Voir la liste des sports]]) 
difficulte - - Valeur de 0 à 5 &difficulte=1 Filtrer sur la difficulté (difficulté exacte) 
balise - - true &balise=true Obentir uniquement les SityGuides balisés (attention, définir à false ne va pas effectuer de filtrage inverse)
duree_min - - durée min. en minutes &duree_min=45 Obtenir uniquement les SityGuides de plus de X minutes
duree_max - - durée max. en minutes &duree_max=45 Obtenir uniquement les SityGuides de moins de X minutes
longueur_min - - longueur min. en mètres &longueur_min=4500 Obtenir uniquement les SityGuides de plus de X mètres
longueur_max - - longueur max. en mètres &longueur_min=4500 Obtenir uniquement les SityGuides de moins de X mètres
filtrage SIT - - Alias critère + valeur attendue  &sit_XXX='XXX' (string) &sit_XXX=XXX (numeric) Filtrage par critères SIT - Consulter la page spécifique au SIT pour plus de détails
filtrage MSQ  Le filtrage MSQ est disponible. consulter la page [[filtrage_msq|Filtrage MSQ]] pour plus d'information

GetTrailsJSON

Action  Récupération de la position des randonnées correspondant aux critères
Entrée GET
Sortie GEOJSON (http://geojson.org/)
Schéma d'appel
http://api.geolives.com/API_KEY/TrailManager?action=getTrailsJSON

Paramètres
 
Paramètre Obligatoire Val. défaut Argument Template Description
pagesize - 6 Nombre de résultats par page &pagesize=6 Nombre de résultats par page
FILTRAGE
activite - - Numéro de l'activité &activite=1 Filtre sur le type de sport ([[Liste_des_codes_sport|Voir la liste des sports]])
difficulte - - Valeur de 0 à 5 &difficulte=1 Filtrer sur la difficulté (difficulté exacte) 
balise - - true &balise=true Obentir uniquement les SityGuides balisés (attention, définir à false ne va pas effectuer de filtrage inverse)
duree_min - - durée min. en minutes &duree_min=45 Obtenir uniquement les SityGuides de plus de X minutes
duree_max - - durée max. en minutes &duree_max=45 Obtenir uniquement les SityGuides de moins de X minutes
longueur_min - - longueur min. en mètres &longueur_min=4500 Obtenir uniquement les SityGuides de plus de X mètres
longueur_max - - longueur max. en mètres &longueur_min=4500 Obtenir uniquement les SityGuides de moins de X mètres
filtrage SIT - - Alias critère + valeur attendue  &sit_XXX='XXX' (string) &sit_XXX=XXX (numeric) Filtrage par critères SIT - Consulter la page spécifique au SIT pour plus de détails
filtrage MSQ  Le filtrage MSQ est disponible. consulter la page [[filtrage_msq|Filtrage MSQ]] pour plus d'information

GetTrailDetails

Action  Récupérer l'ensemble des données d'un SityGuide déterminé
Entrée GET
Sortie JSON ([[api_json_trail_full|JSON TRAIL FULL]])
Schéma d'appel
http://api.geolives.com/API_KEY/TrailManager?action=getTrailDetails

Paramètres
 
Paramètre Obligatoire Val. défaut Argument Template Description
id OUI - Identifiant unique du SityGuide &id=1234 Identifiant du SityGuide

intScript

Action  Script d'initialisation du module d'intégration
Entrée GET
Sortie JAVASCRIPT
Schéma d'appel
http://api.geolives.com/API_KEY/TrailManager?action=intScript

Paramètres

Attention les paramètres de filtrage sont passés dans un paramètre "filter" et non pas séparément. Ces paramètres sont séparés par des points-virgule (;) 

Exemple :
http://api.geolives.com/VOTRE_CLEF_API/TrailManager?action=intScript&lang=fr&filter=msq_ville=30007;activite=1;...
 
Paramètre Obligatoire Val. défaut Argument Template Description
FILTRAGE
activite - - Numéro de l'activité filter=activite=1; Filtre sur le type de sport ([[Liste_des_codes_sport|Voir la liste des sports]]) 
difficulte - - Valeur de 0 à 5 filter=difficulte=1; Filtrer sur la difficulté (difficulté exacte) 
balise - - true filter=balise=true; Obentir uniquement les SityGuides balisés (attention, définir à false ne va pas effectuer de filtrage inverse)
duree_min - - durée min. en minutes filter=duree_min=45; Obtenir uniquement les SityGuides de plus de X minutes
duree_max - - durée max. en minutes filter=duree_max=45; Obtenir uniquement les SityGuides de moins de X minutes
longueur_min - - longueur min. en mètres filter=longueur_min=4500; Obtenir uniquement les SityGuides de plus de X mètres
longueur_max - - longueur max. en mètres filter=longueur_min=4500; Obtenir uniquement les SityGuides de moins de X mètres
filtrage SIT - - Alias critère + valeur attendue  filter=sit_XXX='XXX'; (string) &sit_XXX=XXX;(numeric) Filtrage par critères SIT - Consulter la page spécifique au SIT pour plus de détails
filtrage MSQ  Le filtrage MSQ est disponible. consulter la page [[filtrage_msq|Filtrage MSQ]] pour plus d'information