Add getTimezone() procedure to the API

2014-11-30 19:43:34 -05:00
parent 4bba5be037
commit 81df6a36b4
3 changed files with 41 additions and 0 deletions
--- a/docs/api-json-rpc.markdown
+++ b/docs/api-json-rpc.markdown
@@ -144,6 +144,33 @@ Array
 Procedures
 ----------

+### getTimezone
+
+- Purpose: **Get the application timezone**
+- Parameters: none
+- Result on success: **Timezone** (Example: UTC, Europe/Paris)
+- Result on failure: **Default timezone** (UTC)
+
+Request example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "method": "getTimezone",
+    "id": 1661138292
+}
+```
+
+Response example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 1661138292,
+    "result": "Europe\/Paris"
+}
+```
+
 ### createProject

 - Purpose: **Create a new project**