Update api.md

add documentation for new API calls for Managing groups

diff --git a/doc/api.md b/doc/api.md
index 147c8b7513c8c980619b1dd13e3c2491979c90c0..478ef6d2b973804f5a32f8b16cb85dadc5f91b65 100644 (file)
--- a/doc/api.md
+++ b/doc/api.md
@@ -346,6 +346,79 @@ Friendica doesn't allow showing followers of other users.
 \r
 Friendica doesn't allow showing friends of other users.\r
 \r
+\r
+## Implemented API calls (not compatible with other API’s)\r
+\r
+### users/group_show\r
+Return all or a specified group of the user with the containing contacts as array.\r
+\r
+#### Parameters\r
+* gid: optional, if not given, API returns all groups of the user\r
+\r
+#### Return values\r
+Array of:\r
+* name: name of the group\r
+* gid: id of the group\r
+* user: array of group members (return from api_get_user() function for each member)\r
+\r
+\r
+### users/group_delete\r
+delete the specified group of contacts; API call need to include the correct gid AND name of the group to be deleted.\r
+\r
+### Parameters\r
+* gid: id of the group to be deleted\r
+* name: name of the group to be deleted \r
+\r
+#### Return values\r
+Array of:\r
+* success: true if successfully deleted\r
+* gid: gid of the deleted group\r
+* name: name of the deleted group\r
+* status: „deleted“ if successfully deleted\r
+* wrong users: empty array\r
+\r
+\r
+### users/group_create\r
+Create the group with the posted array of contacts as members. \r
+#### Parameters\r
+* name: name of the group to be created\r
+\r
+#### POST data\r
+JSON data as Array like the result of „users/group_show“:\r
+* gid\r
+* name\r
+* array of users\r
+\r
+#### Return values\r
+Array of:\r
+* success: true if successfully created or reactivated\r
+* gid: gid of the created group\r
+* name: name of the created group\r
+* status: „missing user“ | „reactivated“ | „ok“\r
+* wrong users: array of users, which were not available in the contact table \r
+\r
+\r
+### users/group_update\r
+Update the group with the posted array of contacts as members (post all members of the group to the call; function will remove members not posted). \r
+#### Parameters\r
+* gid: id of the group to be changed\r
+* name: name of the group to be changed\r
+\r
+#### POST data\r
+JSON data as array like the result of „users/group_show“:\r
+* gid\r
+* name\r
+* array of users\r
+\r
+#### Return values\r
+Array of:\r
+* success: true if successfully updated\r
+* gid: gid of the changed group\r
+* name: name of the changed group\r
+* status: „missing user“ | „ok“\r
+* wrong users: array of users, which were not available in the contact table \r
+\r
+\r
 ## Not Implemented API calls\r
 The following API calls are implemented in GNU Social but not in Friendica: (incomplete)\r
 \r