summaryrefslogtreecommitdiff
path: root/docs/api-json-rpc.markdown
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2015-03-01 20:25:46 -0500
committerFrederic Guillot <fred@kanboard.net>2015-03-01 20:25:46 -0500
commit23f8f2c576271a9007b5da0a4d0ba144ad66086d (patch)
tree5058c2167540389b583bd87dcd9b9992dc399604 /docs/api-json-rpc.markdown
parent052b14d48290405c8b3684e872f9c15858745bb2 (diff)
Add api procedure to get the application version
Diffstat (limited to 'docs/api-json-rpc.markdown')
-rw-r--r--docs/api-json-rpc.markdown26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/api-json-rpc.markdown b/docs/api-json-rpc.markdown
index 0440da0c..1075de56 100644
--- a/docs/api-json-rpc.markdown
+++ b/docs/api-json-rpc.markdown
@@ -144,6 +144,32 @@ Array
Procedures
----------
+### getVersion
+
+- Purpose: **Get the application version**
+- Parameters: none
+- Result: **version** (Example: 1.0.12, master)
+
+Request example:
+
+```json
+{
+ "jsonrpc": "2.0",
+ "method": "getVersion",
+ "id": 1661138292
+}
+```
+
+Response example:
+
+```json
+{
+ "jsonrpc": "2.0",
+ "id": 1661138292,
+ "result": "1.0.13"
+}
+```
+
### getTimezone
- Purpose: **Get the application timezone**