summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorFrédéric Guillot <fred@kanboard.net>2014-06-25 09:46:31 -0300
committerFrédéric Guillot <fred@kanboard.net>2014-06-25 09:46:31 -0300
commit1c6431b3ea70635221c6d72467ff0a454c06548d (patch)
tree3a79703dfc42f81d588749c35c3a310dc452d417 /docs
parent4f08fc83a32489cc1f0187f5f77e49e40bc19810 (diff)
Update API documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/api-json-rpc.markdown73
1 files changed, 73 insertions, 0 deletions
diff --git a/docs/api-json-rpc.markdown b/docs/api-json-rpc.markdown
index 7b0b795c..b275a948 100644
--- a/docs/api-json-rpc.markdown
+++ b/docs/api-json-rpc.markdown
@@ -135,6 +135,79 @@ Procedures
+### getBoard
+
+- Purpose: **Get all necessary information to display a board**
+- Parameters: **project_id** (integer)
+- Result on success: **board properties**
+- Result on failure: **null**
+
+### getColumns
+
+- Purpose: **Get all columns information for a given project**
+- Parameters: **project_id** (integer)
+- Result on success: **columns properties**
+- Result on failure: **null**
+
+### moveColumnUp
+
+- Purpose: **Move up the column position**
+- Parameters: **project_id** (integer), **column_id** (integer)
+- Result on success: **true**
+- Result on failure: **false**
+
+### moveColumnDown
+
+- Purpose: **Move down the column position**
+- Parameters: **project_id** (integer), **column_id** (integer)
+- Result on success: **true**
+- Result on failure: **false**
+
+### updateColumn
+
+- Purpose: **Update column properties**
+- Parameters: **column_id** (integer), **values** (**title** string, **task_limit** integer)
+- Result on success: **true**
+- Result on failure: **false**
+
+### addColumn
+
+- Purpose: **Add a new column**
+- Parameters: **project_id** (integer), **values** (**title** string, **task_limit** integer)
+- Result on success: **true**
+- Result on failure: **false**
+
+### removeColumn
+
+- Purpose: **Remove a column**
+- Parameters: **column_id** (integer)
+- Result on success: **true**
+- Result on failure: **false**
+
+### getAllowedUsers
+
+- Purpose: **Get allowed users for a given project**
+- Parameters: **project_id** (integer)
+- Result on success: Key/value pair of user_id and username
+- Result on failure: **false**
+
+### revokeUser
+
+- Purpose: **Revoke user access for a given project**
+- Parameters: **project_id** (integer), **user_id** (integer)
+- Result on success: **true**
+- Result on failure: **false**
+
+### allowUser
+
+- Purpose: **Grant user access for a given project**
+- Parameters: **project_id** (integer), **user_id** (integer)
+- Result on success: **true**
+- Result on failure: **false**
+
+
+
+
### createTask
- Purpose: **Create a new task**