groupfolders

Description

List the group folders for the group on the URL.

Parameters

owned

If this parameter is false then non-default group folders owned by this group are not returned. For example if:

• the images folder within the acme-specs group is shared with team-marketing and
• the documents folder within the team-media group is shared with the acme-specs group.

By default the following group folders would be returned for the acme-specs group:

/ps/acme/specs (this is the default group folder)
/ps/acme/specs/images (this is owned by acme-specs)
/ps/team/media/documents

However, with the owned=false parameter the following group folders would be returned:

/ps/acme/specs
/ps/team/media/documents

Permission

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

Response

If successful, the group folders are returned as  <groupfolder> elements wrapped in a <groupfolders> 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.

<groupfolders>
  <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="false" 
             sharexrefs="true" 
             addcomments="false">
        <group name="my-group2" .../>
      </share>
      <share editable="false"  
             shareedits="true" 
             sharexrefs="false" 
             addcomments="true">
        <group name="my-group3" .../>
      </share>
    </sharing>]
  </groupfolder>
  ...
</groupfolders>

Or in JSON

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

Error Handling

No specific errors expected for this service.