Codes des URL de camptocamp.org

Activités :
Catégories : info site
Type d'article : collaboratif (CC by-sa)

Cet article explique comment créer des adresses valides pour le site camptocamp.org.

Documents du wiki

Forme de base

L'URL sera de la forme suivante :

  • www : https://www.camptocamp.org/<document_types>/<document_id>
  • api : https://api.camptocamp.org/<document_types>/<document_id>

Arguments

  • <document_types> pourra être une valeur parmi les suivantes :
    • areas
    • articles
    • maps
    • images
    • routes
    • outings
    • profiles
    • waypoints
    • xreports
  • <document_id> sera l'identifiant numérique du document

Exemples

Paramètre de langue

Il est possible de forcer la langue du document dans la partie www (la page api renvoie systématiquement toutes les langues) en rajoutant /<lang> à la fin de l'URL :

Pages spéciales wiki

Edit

Cette URL permet d'éditer un document, et n'est pas disponible dans l'API (faire une requête POST sur l'url de base pour cela). Elle a la forme suivante :

https://www.camptocamp.org/<document_types>/edit/<document_id>/<lang>

Voir section précédente pour les valeurs possibles pour les arguments <document_types>, <document_id> et <lang>.

Exemple

History

Cette URL permet de consulter l'historique d'un document. Elle a la forme suivante :

  • www : https://www.camptocamp.org/<document_types>/history/<document_id>/<lang>
  • api : https://api.camptocamp.org/document/<document_id>/history/<lang>

Voir section précédente pour les valeurs possibles pour les arguments <document_types>, <document_id> et <lang>.

Exemple

Version

Cette URL permet de consulter une version précédente d'un document. Elle a la forme suivante :

  • www : https://www.camptocamp.org/<document_types>/version/<document_id>/<lang>/<version_id>
  • api : https://api.camptocamp.org/<document_types>/<document_id>/<lang>/<version_id>

Le paramètre <version_id> correspond à l'identifiant numérique de la version. Voir section précédente pour les valeurs possibles pour les arguments <document_types>, <document_id> et <lang>.

Exemple

Liste de documents du wiki

  • www : https://www.camptocamp.org/<document_types>#<filters>
  • api : https://api.camptocamp.org/<document_types>?<filters>

Reportez-vous à la première section de cet article pour les valeurs possibles pour <document_types>.

<filters> est une liste de clef-valeur, ou la clef est le nom d'une propriété, et la valeur la ou les valeurs que doivent prendre les documents sur cette propriété :

Le filtre key1=value1&key2=value2 remontera tous les documents dont key1 sera value1 et key2 sera value2.

Notez que la valeur peut elle-même être une liste de valeurs séparées par des virgules : key=value1,value2 remontera tous les documents dont key sera value1 ou value2.

Filtres

bbox

Cet argument filtre sur une zone géographique et fonctionne sur les types de documents suivants : routes, outings, waypoints et profiles.

  • www : https://www.camptocamp.org/routes#bbox=590505%252C5330001%252C616799%252C5367226
  • api : https://api.camptocamp.org/routes?bbox=590505%2C5330001%2C616799%2C5367226

Notez que la valeur est un ensemble de quatre chiffres séparés par %252C sur www, et par %2C sur api.

Pages spéciales

Whatsnew

Notes

Veuillez trouver sous ce lien la version de cet article correspondant à la version 5 (V5) de camptocamp.org