From ad8fcf035ab92d8cd06179959000b9a1681b1505 Mon Sep 17 00:00:00 2001
From: Frederic Guillot <fred@kanboard.net>
Date: Fri, 22 Jan 2016 21:23:12 -0500
Subject: Add new API procedures for groups, roles and project permissions

---
 doc/api-application-procedures.markdown | 60 +++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)

(limited to 'doc/api-application-procedures.markdown')

diff --git a/doc/api-application-procedures.markdown b/doc/api-application-procedures.markdown
index ab1230cc..2897b526 100644
--- a/doc/api-application-procedures.markdown
+++ b/doc/api-application-procedures.markdown
@@ -229,3 +229,63 @@ Response example:
     }
 }
 ```
+
+### getApplicationRoles
+
+- Purpose: **Get the application roles**
+- Parameters: none
+- Result: **Dictionary of role => role_name**
+
+Request example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "method": "getApplicationRoles",
+    "id": 317154243
+}
+```
+
+Response example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 317154243,
+    "result": {
+        "app-admin": "Administrator",
+        "app-manager": "Manager",
+        "app-user": "User"
+    }
+}
+```
+
+### getProjectRoles
+
+- Purpose: **Get the project roles**
+- Parameters: none
+- Result: **Dictionary of role => role_name**
+
+Request example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "method": "getProjectRoles",
+    "id": 8981960
+}
+```
+
+Response example:
+
+```json
+{
+    "jsonrpc": "2.0",
+    "id": 8981960,
+    "result": {
+        "project-manager": "Project Manager",
+        "project-member": "Project Member",
+        "project-viewer": "Project Viewer"
+    }
+}
+```
\ No newline at end of file
-- 
cgit v1.2.3