aboutsummaryrefslogtreecommitdiff
path: root/API.rst
diff options
context:
space:
mode:
authorJonathan Weth <git@jonathanweth.de>2020-07-27 11:43:43 +0200
committerJonathan Weth <git@jonathanweth.de>2020-07-27 11:43:43 +0200
commita6115f21a121e954fa2714753b16c81bfcc05989 (patch)
treeedb33c3c03589e4a1591df5cec165d2886c25687 /API.rst
parentdf32d50ab72d35c2a727fe46ef704fd6729b0c5c (diff)
downloadRWA.Support.SessionService-a6115f21a121e954fa2714753b16c81bfcc05989.tar.gz
RWA.Support.SessionService-a6115f21a121e954fa2714753b16c81bfcc05989.tar.bz2
RWA.Support.SessionService-a6115f21a121e954fa2714753b16c81bfcc05989.zip
Ensure that only one just can run
Close #6
Diffstat (limited to 'API.rst')
-rw-r--r--API.rst10
1 files changed, 8 insertions, 2 deletions
diff --git a/API.rst b/API.rst
index dd67cf1..9cec20b 100644
--- a/API.rst
+++ b/API.rst
@@ -19,11 +19,17 @@ Start a new remote session and register it in RWA
**Return type:** string (JSON)
-**Structure of returned JSON:**
+**Structure of returned JSON (success):**
+
+::
+
+ {"status": "success", "id": <pid>, "url": "<url>", "pin": <pin>}
+
+**Structure of returned JSON (error):**
::
- {"id": <pid>, "url": "<url>", "pin": <pin>}
+ {"status": "error"}
status