diff options
| author | Michel Etienne | 2012-03-23 16:14:08 +0100 |
|---|---|---|
| committer | Michel Etienne | 2012-03-23 16:14:08 +0100 |
| commit | 397452509d86d527804e055a196c43753f49fa29 (patch) | |
| tree | ca20a6ac187513bd4781fa69ce35d53e22b5e1a3 /doc/functional | |
| parent | fa5833943881a7b0dbdffcce1e4b364986196f0f (diff) | |
| download | chouette-core-397452509d86d527804e055a196c43753f49fa29.tar.bz2 | |
add hint and rest API info
Diffstat (limited to 'doc/functional')
| -rw-r--r-- | doc/functional/index.textile | 19 | ||||
| -rw-r--r-- | doc/functional/restapis.textile | 21 |
2 files changed, 36 insertions, 4 deletions
diff --git a/doc/functional/index.textile b/doc/functional/index.textile index 92c6e79d6..ac8c72995 100644 --- a/doc/functional/index.textile +++ b/doc/functional/index.textile @@ -3,5 +3,22 @@ layout: default title: Présentation --- -p. TODO +h3. Sommaire + +# "Espaces de données":referentials +# "Réseaux":networks +# "Transporteurs":companies +# "Lignes":lines +## Séquences d'arrêts +## Horaires +# "Arrêts":stop_areas +## Correspondances +## Accès +## Liaisons Arrêt-Accès +# Calendriers d'application +# Outils +## Imports +## Validation +# Divers +## "API Rest":restapis diff --git a/doc/functional/restapis.textile b/doc/functional/restapis.textile index e361c2404..4f732686d 100644 --- a/doc/functional/restapis.textile +++ b/doc/functional/restapis.textile @@ -5,10 +5,25 @@ title: API Rest h3. Syntaxe -p. TODO - +p. Les différents objets Neptune sont accessibles dans Chouette par une URL Rest: +??[URL_server]/[referential_id]/[Objects]/[id].[format]?? +la liste des objets d'un même type peut être obtenue par l'URL REST : +??[URL_server]/[referential_id]/[Objects].[format]?? +où : +* URL_server : l'adresse web d'installation du serveur Chouette +* referential_id: l'identifiant de l'espace de données +* Objects: le type d'objet demandé (au pluriel) +** networks +** lines +** companies +** ... +* id : l'identifiant de l'objet désiré +* format : le format de sortie : +** json +** xml h3. Exemples +??http://chouette.dryade.net/chouette2/referentials/4/lines/674.json?? +??http://chouette.dryade.net/chouette2/referentials/4/lines/674.xml?? -p. TODO |