aboutsummaryrefslogtreecommitdiffstats
path: root/app/views/help/restapis.textile
diff options
context:
space:
mode:
Diffstat (limited to 'app/views/help/restapis.textile')
-rw-r--r--app/views/help/restapis.textile30
1 files changed, 30 insertions, 0 deletions
diff --git a/app/views/help/restapis.textile b/app/views/help/restapis.textile
new file mode 100644
index 000000000..ed4aaf3b4
--- /dev/null
+++ b/app/views/help/restapis.textile
@@ -0,0 +1,30 @@
+---
+layout: default
+title: API Rest
+---
+
+h3. Syntaxe
+
+Les différents objets Neptune sont accessibles dans Chouette par l'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??
+
+