aboutsummaryrefslogtreecommitdiff
path: root/API.rst
diff options
context:
space:
mode:
Diffstat (limited to 'API.rst')
-rw-r--r--API.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/API.rst b/API.rst
new file mode 100644
index 0000000..d9b2698
--- /dev/null
+++ b/API.rst
@@ -0,0 +1,35 @@
+API documentation for Session Service
+=====================================
+
+General information
+-------------------
+
+Bus name: ``de.rwa.rwa``
+
+Object name: ``/RWA``
+
+Methods
+-------
+
+start
+^^^^^
+Start a new remote session and register it in RWA
+
+**Arguments:** none
+
+**Return type:** string (JSON)
+
+**Structure of returned JSON:**
+
+::
+
+ {"id": <pid>, "url": "<url>", "pin": <pin>}
+
+
+stop
+^^^^
+Stop a remote session
+
+**Arguments:** pid/id (integer)
+
+**Return type:** none