diff --git a/developer_manual/core/index.rst b/developer_manual/core/index.rst index 3c6b75b99..fde94dca3 100644 --- a/developer_manual/core/index.rst +++ b/developer_manual/core/index.rst @@ -14,3 +14,4 @@ Please make sure you have set up a :ref:`devenv`. theming externalapi ocs-share-api + ocs-sharee-api diff --git a/developer_manual/core/ocs-sharee-api.rst b/developer_manual/core/ocs-sharee-api.rst new file mode 100644 index 000000000..913ccf06e --- /dev/null +++ b/developer_manual/core/ocs-sharee-api.rst @@ -0,0 +1,51 @@ +============== +OCS Sharee API +============== + +The OCS Sharee API allows you to access the sharing API from outside over +pre-defined OCS calls. + +The base URL for all calls to the share API is: */ocs/v1.php/apps/files_sharing/api/v1* + +All calls to OCS endpoints require the ``OCS-APIRequest`` header to be set to ``true``. + +Search +------ + +Search sharees +^^^^^^^^^^^^^^ + +Get all sharees matching a search term. + +* Syntax: /sharees +* Method: GET + +* URL Arguments: search - (string) the search term +* URL Arguments: lookup - (bool) whether to search globally on the Nextcloud lookup server +* URL Arguments: perPage - (int) number of sharees per page +* URL Arguments: itemType - (string) type of share, e.g. "file" + +* Result: XML with all sharees + +Status codes: + +* 100 - successful + +Recommendation +-------------- + +Sharee recommendations +^^^^^^^^^^^^^^^^^^^^^^ + +Get sharees the sharer might want to share with. + +* Syntax: /sharees_recommended +* Method: GET + +* URL Arguments: itemType - (string) type of share, e.g. "file" + +* Result: XML with recommended sharees + +Status codes: + +* 100 - successful