groupfolder forpath

Description

This services returns the group folder information including sharing information for a given path.

Parameters

Permission

Requires guest or higher, unless group is accessible to public.

Response

If successful, the group folder is returned as a <groupfolder> element.

The hidden attribute/property is specified to indicate how many groups are not listed when there are groups that the group folder is shared to but that the user does not have permission to view.

<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>

Or in JSON

{ 
  "id": number,
  "scheme": string,
  "host": string,
  "port": number,
  "path": string,
  "external": boolean,
  "public": boolean,
  "sharing": {
    "status": string,
    "share":[
      {
        "owner": boolean,
        "editable": boolean,
        "addcomments": boolean,
        "shareedits": boolean,
        "sharexrefs": boolean,
        "group": group
      }
    ]
  }
}

Error Handling