groupfolder forpath
/members/{member}/groups/{group}/groupfolders/forpath [GET]
API Support | Available since | Last updated | Output |
---|---|---|---|
5.9400 | 5.9400 | xml, json |
Description
Get the group folder specified by the path parameter as XML.
Parameters
Name | Description | Required | Type | Default |
---|---|---|---|---|
path | The full group folder path beginning with / (/* suffix is added automatically) e.g. /ps/acme/specs/shared | no | path |
Permission
Requires guest or higher, unless group is accessible to public.
Response
If successful, the group folder is returned as a <groupfolder>
element.
<groupfolder id="[groupuri id]" scheme="[scheme]" host="[host]" port="[port]" path="[path]" external="[true|false]" public="[true|false]" [sharing="[private|shared]"]> [<sharing hidden="2"> <share editable="true" shareedits="true" sharexrefs="true" addcomments="true" owner="true"> <group name="my-group1" .../> </share> <share editable="true" shareedits="true" sharexrefs="true" addcomments="false"> <group name="my-group2" .../> </share> <share editable="false" addcomments="true"> <group name="my-group3" .../> </share> </sharing>] </groupfolder>
Error Handling
0x1404 | If the group folder is not found |
---|---|
0x1405 | If the group folder is not in group |
0x140B | Invalid path |
0x6401 | There is no default group folder for the group |