groupfolder

Description

Removes the group folder from the specified groups.

Usage examples

To stop sharing the images folder within the acme-specs group with the team-marketing group, you can make the following API request (newlines added for readability only) - assuming member ID is 123 and group folder ID is 456:

DELETE https://example.org/ps/api/members/123/groups/acme-specs/groupfolders/456.json
?groups=team-marketing

Or 

DELETE https://example.org/ps/api/members/123/groups/team-marketing/groupfolders/456.json
?groups=team-marketing

To stop sharing the images folders within the acme-specs group with other groups, you can only make the following API request (newlines added for readability only):

DELETE https://example.org/ps/api/members/123/groups/acme-specs/groupfolders/456.json
?groups=team-marketing,team-media

Alternatively, you could also use the PATCH service, if you don’t want to list the groups to remove:

PATCH https://example.org/ps/api/members/123/groups/acme-specs/groupfolders/456.json?groups=

Parameters

groups

This parameter lets you specify the list of groups that the groups folder is no longer be shared to as a comma-separated list of group names. The names must not include admin, public or the owner group specified in the service URL as {group}.

You must have project manager access to each of the specified groups and groups can only be specified once for each parameters and cannot be specified for both.

Permission

Only project managers or administrators can invoke this service.

Response

If successful, the group folder that was deleted is returned as <groupfolder> element wrapped in a <groupfolder-delete> element.

<groupfolder-delete>
  <groupfolder 
            id="[groupuri id]"
            scheme="[scheme]"
            host="[host]"
            port="[port]"
            path="[path]"
            external="[true|false]"
            sharing="[private|shared]">
    <sharing status="[private|shared]" 
                 [hidden="2"] 
                 [public="true"]>
      <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>
</groupfolder-delete>

Or in JSON

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

Error Handling