Web service API

How to use PageSeeder's Web service API

groupfolders

/members/{member}/groups/{group}/groupfolders [GET]

com.pageseeder.groupfolder.ListGroupFolders

Description

List the group folders for the group on the URL.

Parameters

Name Description Required Type Default value
owned whether to include group folders owned by this group (ignored for projects) no boolean true
sharing whether to include sharing information no boolean true

Permission

Undocumented permissions requirements.

Response

If successful, the group folders are returned as  <groupfolder> elements wrapped in a <groupfolders> element.

   <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