Web service API

How to use PageSeeder's Web service API

groupfolder

/members/{member}/groups/{group}/groupfolders/{groupfolderid} [DELETE]

com.pageseeder.groupfolder.DeleteGroupFolder

Description

Delete the group folder from the groups specified.

If groups is not empty and the group folder is owned this service will return HTTP 202 and start an Asynchronous process to unshare all document edits and xrefs.

Note

The groups parameter must be on the request URL. If the group on the URL does not own the group folder then the groups parameter must equal the group on the URL.

Parameters

Name Description Required Type Default value
groups the groups the folder will be unshared from - comma separated list of names yes strings

Permission

Undocumented permissions requirements.

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>
    [<thread> ... </thread>]
  </groupfolder-delete>

Error Handling

0x1406 If the group folder id not found
0x1408 If the group folder id not shared to group
0x140D Invalid group
0x140E Group folder not owned by or shared to group
0x1410 The groups parameter can not contain the owner group

Created on , last edited on