aboutsummaryrefslogtreecommitdiff
path: root/API.rst
diff options
context:
space:
mode:
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