From 2b0877c65d37ad84ae8852d66fd161bb97d2ba5b Mon Sep 17 00:00:00 2001
From: Simon Ebner <simon.ebner@psi.ch>
Date: Wed, 15 Jan 2014 16:08:06 +0100
Subject: [PATCH] Documented fda rest api

---
 ch.psi.fda/Readme.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)

diff --git a/ch.psi.fda/Readme.md b/ch.psi.fda/Readme.md
index 9193783..96fc029 100644
--- a/ch.psi.fda/Readme.md
+++ b/ch.psi.fda/Readme.md
@@ -26,6 +26,50 @@ To use the FDA libary in an other project use:
 ## REST
 FDA offers a rest service to execute scans. There are 3 distinct service for fda scan, fdaq and cdump.
 
+### FDA Service
+
+Submit scan
+
+```
+PUT fda/{trackingId}
+Accept: application/xml
+
+204 - Success
+
+```
+
+Stop/cancel scan
+
+```
+DELETE fda/{trackingId}
+
+204 - Success
+```
+
+Stop all scans
+
+```
+DELETE fda
+
+204 - Success
+```
+
+Check if scan is running
+
+```
+GET fda/{trackingId}/running
+
+200 - true/false
+```
+
+Wait for scan done (blocks until scan is done)
+
+```
+GET fda/{trackingId}/done
+
+204 - Success
+```
+
 # Notes
 ## Upgrade FDA 1.x to 2.x
 In existing fda.properties file the following property need to be added: `ch.psi.fda.aq.data.dir=../data`
\ No newline at end of file