summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorStephan Jauernick <info@stephan-jauernick.de>2014-06-02 20:25:16 +0200
committerStephan Jauernick <info@stephan-jauernick.de>2014-06-02 20:25:16 +0200
commitbbd50dfc626786c890acd5a15e728cadc400f727 (patch)
treecccc8555efc217c6d7682e5865c009cd2435e017 /doc/api
parentfc3ce3429e552db793dee8ec41159920d3c7df55 (diff)
downloadetherpad-lite-bbd50dfc626786c890acd5a15e728cadc400f727.zip
Added documentation for the newly added API method getPadID
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/http_api.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/api/http_api.md b/doc/api/http_api.md
index 2d6e7909..6cbe6e6b 100644
--- a/doc/api/http_api.md
+++ b/doc/api/http_api.md
@@ -455,6 +455,15 @@ returns the read only link of a pad
* `{code: 0, message:"ok", data: {readOnlyID: "r.s8oes9dhwrvt0zif"}}`
* `{code: 1, message:"padID does not exist", data: null}`
+#### getPadID(readOnlyID)
+ * API >= 1.2.10
+
+returns the id of a pad which is assigned to the readOnlyID
+
+*Example returns:*
+ * `{code: 0, message:"ok", data: {padID: "p.s8oes9dhwrvt0zif"}}`
+ * `{code: 1, message:"padID does not exist", data: null}`
+
#### setPublicStatus(padID, publicStatus)
* API >= 1