summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2016-04-21 21:10:04 -0400
committerFrederic Guillot <fred@kanboard.net>2016-04-21 21:10:04 -0400
commit60e0753b90838120510861ebc674f826140b31de (patch)
treef85b81e439adad8b3011c3127442c822740b02d0 /doc
parentb0e41bc81b40cfdc5e067bf1eb4d05e3aa438c7d (diff)
Added API procedure "getMemberGroups"
Diffstat (limited to 'doc')
-rw-r--r--doc/api-group-member-procedures.markdown36
1 files changed, 36 insertions, 0 deletions
diff --git a/doc/api-group-member-procedures.markdown b/doc/api-group-member-procedures.markdown
index c4889265..1065ba11 100644
--- a/doc/api-group-member-procedures.markdown
+++ b/doc/api-group-member-procedures.markdown
@@ -1,6 +1,42 @@
Group Member API Procedures
===========================
+## getMemberGroups
+
+- Purpose: **Get all groups for a given user**
+- Parameters:
+ - **user_id** (integer, required)
+- Result on success: **List of groups**
+- Result on failure: **false**
+
+Request example:
+
+```json
+{
+ "jsonrpc": "2.0",
+ "method": "getMemberGroups",
+ "id": 1987176726,
+ "params": [
+ "1"
+ ]
+}
+```
+
+Response example:
+
+```json
+{
+ "jsonrpc": "2.0",
+ "id": 1987176726,
+ "result": [
+ {
+ "id": "1",
+ "name": "My Group A"
+ }
+ ]
+}
+```
+
## getGroupMembers
- Purpose: **Get all members of a group**