aboutsummaryrefslogtreecommitdiffstats
path: root/doc/functional/restapis.textile
diff options
context:
space:
mode:
Diffstat (limited to 'doc/functional/restapis.textile')
-rw-r--r--doc/functional/restapis.textile21
1 files changed, 18 insertions, 3 deletions
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