Web service API

How to use PageSeeder's Web service API

groupfolders

/groups/{group}/groupfolders [GET]

com.pageseeder.groupfolder.ListGroupFolders

This service is deprecated since version 5.9400

Description

Get a group's group folders

Warning!

This class is not part of the public API, and may be subject to change!

List the group folders (GroupURIs) that belong to the current group.

The output has the following format:


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

Parameters

No parameters required.

Permission

Undocumented permissions requirements.

Response

Undocumented XML response

The output has the following format:


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

Error Handling

No specific errors expected for this generator.

Created on , last edited on