Article obsolète
URL et options
json
Une liste de documents peut être exportée en format geoJSON en ajoutant /format/json
à l'url d'une liste de documents, obtenue par un filtre de recherche, trouvée sur le site, ou en la construisant à la main.
Des options permettent de modifier le type des données envoyées : /format/json-option1-option2-option3
Les options sont cumulatives.
En utilisant le type par défaut (aucune option), les données sont les suivantes :
- Les champs correspondent plus ou moins aux données présentes sur la liste en format html, qui ne comprends que des champs chiffrés ou des champs texte monoligne (intitulé). Voir le détail par type de document.
- Les valeurs des champs à valeur prédéfinies (liste à choix unique ou multiple) sont sous format du code texte. Par exemple, les activités sont "skitouring", "snow_ice_mixed", etc, sans traduction.
- Les éventuels champs texte multiligne sont en format brut : les balises de mise en forme ne sont pas décodées.
- Les éventuelles traces GPX ne sont pas incluses.
- Le nb d'items par page par défaut est 100, et le nb maximum est 100. Le nb d'item par page est modifiable grâce au critère
/npp/NN
de l'url.
keys
Avec l'option keys, les valeurs des champs à valeur prédéfinies (liste à choix unique ou multiple) sont les valeurs stockées dans la base de donnée : entier ou liste d'entier.
Cela permet par exemple de trier la liste selon un de ces champs par ordre croissant, côté client.
Par ailleurs, la liste des régions associées ne comporte pas le champ "url" pour alléger la liste (l'url peut être reconstruite facilement à partir du champ "id").
html
Avec l'option html, les champs texte multiligne sont en format html : le parser des balises de mise en forme (utilisé pour l'affichage en html) est appliqué sur le texte.
Par contre les éventuelles images insérées dans le texte sont retirées.
track
Avec l'option track, la trace GPX est ajoutée au JSON du document (s'il en comporte une).
De plus, le nb d'items par page par défaut est 10, et le nb maximum est 20.
cond sorties uniquement
L'option cond permet d'ajouter les champs conditions à une liste de sorties (mêmes champs que ceux visibles sur une liste de conditions).
De plus, le nb d'items par page par défaut est 20, et le nb maximum est 100.
full
L'option full permet d'ajouter tous les champs du document.
Pour exporter tous les champs d'un seul document de type MODULE et d'id DOC_ID, l'url est du type : /MODULE/list/id/DOC_ID/format/json-full
De plus, le nb d'items par page par défaut est 10, et le nb maximum est 20.
notext
L'option notext permet de supprimer les champs texte multilingues du document (sauf l'intitulé).
Par exemple, le format /format/json-full-notext
permet de récupérer tous les champs chiffrés mais pas les champs texte, allégeant le JSON.
Champs communs
Champs communs à tous les document (ou presque).
Méta-data de la liste
Au premier niveau du format JSON, un champ metadata
rassemble des champs annexes à la liste des documents.
Les champs sont les suivants :
totalItems
: nb total d'items correspondant aux critères de recherchenbItems
: nb d'items présent dans la page courantestartIndex
: index du 1er item de la listecurrentPage
: index de la page courantenextPage
: url de la page suivante (index de la page :currentPage + 1
, index des items entrestartIndex + nbItems
etstartIndex + 2 * nbItems - 1
)previousPage
: url de la page précédente (index de la page :currentPage - 1
, index des item entrestartIndex - nbItems
etstartIndex - 1
)baseLanguage
: langue de l'interfacegenerated
: date de génération du JSON
Liste des régions associées
Chaque objet JSON d'un document comporte un champ linkedAreas
décrivant les régions associées au document.
Le champ linkedAreas
est une liste d'objets comportant chacun :
id
name
type
url
: absent si l'option keys est utilisée.
Document
Champs présent pour chaque document.
A la racine de l'objet d'un document :
id
Dans le champ properties
:
module
name
url
nbLinkedImages
nbComments
Sorties
Champs spécifiques à une sortie :
Liste normale
date
activities
creator
maxElevation
heightDiffUp
routesRating
conditionsStatus
frequentationStatus
hasTrack
Conditions
Champs additionnels lorsque l'option cond est utilisée :
Champs chiffrés
accessElevation
upSnowElevation
downSnowElevation
glacierStatus
avalancheObsType
Champs texte
outingRouteDesc
conditionsLevels
conditions
avalancheDesc
weather
timing
Full
Champs additionnels lorsque l'option full est utilisée :
Champs chiffrés
minElevation
heightDiffDown
outingLength
partialTrip
usePublicTransportation
trackStatus
hutStatus
liftStatus
Champs texte
accessComments
hutComments
outingComments
Itinéraires
Champs spécifiques à un itinéraire :
Liste normale
activities
maxElevation
heightDiffUp
difficultiesHeight
rating
mainFacing
hasTrack
nbLinkedOutings
Liste des accès associés
Le champ linkedParkings
décrit les accès associés au document.
C'est une liste d'objets comportant chacun :
id
name
url
: absent si l'option keys est utilisée.
Full
Champs additionnels lorsque l'option full est utilisée :
Champs chiffrés
minElevation
heightDiffDown
routeType
duration
configuration
snowboardingProof
beginnerProof
mountainBikeApproach
liftApproach
requiresGlacierGear
Champs texte
slope
description
remarks
gear
externalResources
routeHistory
Sommets, cols, lacs, falaises
Les options ne fonctionnent pas encore pour ce type de document.
Champs spécifiques :
Liste normale
latitude
longitude
elevation
type
nbLinkedRoutes
Gites, camping, refuges, abris, bivouacs
Les options ne fonctionnent pas encore pour ce type de document.
Champs spécifiques :
Liste normale
latitude
longitude
elevation
type
staffedCapacity
unstaffedCapacity
activities
phone
website
nbLinkedRoutes
Accès
Les options ne fonctionnent pas encore pour ce type de document.
Champs spécifiques :
Liste normale
latitude
longitude
elevation
lowestElevation
snowClearance
publicTransportationTypes
nbLinkedRoutes
Sites de couenne et bloc
Les options ne fonctionnent pas encore pour ce type de document.
Champs spécifiques :
Liste normale
latitude
longitude
elevation
site_types
routes
rock_types
nbLinkedOutings
Produits locaux
Les options ne fonctionnent pas encore pour ce type de document.
Champs spécifiques :
Liste normale
latitude
longitude
elevation
productTypes
website
nbLinkedOutings