summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorFrédéric Guillot <fred@kanboard.net>2014-11-22 18:22:10 -0500
committerFrédéric Guillot <fred@kanboard.net>2014-11-22 18:22:10 -0500
commit77e10d25829f3523a168bf61424fac99a539f8be (patch)
tree9b3d274146fa9543c4734a945e61b9d975960ff6 /docs
parent15038cdb10f8c691edc7980fd1aed32dcbed3f9f (diff)
Improve API to return id instead of a boolean
Diffstat (limited to 'docs')
-rw-r--r--docs/api-json-rpc.markdown29
1 files changed, 14 insertions, 15 deletions
diff --git a/docs/api-json-rpc.markdown b/docs/api-json-rpc.markdown
index 23cc3518..f2db3ea2 100644
--- a/docs/api-json-rpc.markdown
+++ b/docs/api-json-rpc.markdown
@@ -149,7 +149,7 @@ Procedures
- Purpose: **Create a new project**
- Parameters:
- **name** (string, required)
-- Result on success: **true**
+- Result on success: **project_id**
- Result on failure: **false**
Request example:
@@ -171,7 +171,7 @@ Response example:
{
"jsonrpc": "2.0",
"id": 1797076613,
- "result": true
+ "result": 2
}
```
@@ -487,10 +487,9 @@ Response example:
}
```
-### getAllowedUsers
+### getMembers
-- Purpose: **Get allowed users for a given project**
-- Note: Only people explicitly allowed are part of this list, administrators are always authorized
+- Purpose: **Get members of a project**
- Parameters:
- **project_id** (integer, required)
- Result on success: Key/value pair of user_id and username
@@ -943,7 +942,7 @@ Response example:
- **score** (integer, optional)
- **date_due**: ISO8601 format (string, optional)
- **category_id** (integer, optional)
-- Result on success: **true**
+- Result on success: **task_id**
- Result on failure: **false**
Request example:
@@ -974,7 +973,7 @@ Response example:
{
"jsonrpc": "2.0",
"id": 1176509098,
- "result": true
+ "result": 3
}
```
@@ -1279,7 +1278,7 @@ Response example:
- **email** (string, optional)
- **is_admin** Set the value 1 for admins or 0 for regular users (integer, optional)
- **default_project_id** (integer, optional)
-- Result on success: **true**
+- Result on success: **user_id**
- Result on failure: **false**
Request example:
@@ -1302,7 +1301,7 @@ Response example:
{
"jsonrpc": "2.0",
"id": 1518863034,
- "result": true
+ "result": 22
}
```
@@ -1466,7 +1465,7 @@ Response example:
- Parameters:
- **project_id** (integer, required)
- **name** (string, required, must be unique for the given project)
-- Result on success: **true**
+- Result on success: **category_id**
- Result on failure: **false**
Request example:
@@ -1489,7 +1488,7 @@ Response example:
{
"jsonrpc": "2.0",
"id": 541909890,
- "result": true
+ "result": 4
}
```
@@ -1638,7 +1637,7 @@ Response example:
- **task_id** (integer, required)
- **user_id** (integer, required)
- **content** Markdown content (string, required)
-- Result on success: **true**
+- Result on success: **comment_id**
- Result on failure: **false**
Request example:
@@ -1662,7 +1661,7 @@ Response example:
{
"jsonrpc": "2.0",
"id": 1580417921,
- "result": true
+ "result": 11
}
```
@@ -1822,7 +1821,7 @@ Response example:
- **time_estimated** (int, optional)
- **time_spent** (int, optional)
- **status** (int, optional)
-- Result on success: **true**
+- Result on success: **subtask_id**
- Result on failure: **false**
Request example:
@@ -1845,7 +1844,7 @@ Response example:
{
"jsonrpc": "2.0",
"id": 2041554661,
- "result": true
+ "result": 45
}
```