Web service API

How to use PageSeeder's Web service API

groupfolder forpath

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

com.pageseeder.groupfolder.GetGroupFolder

Description

Warning!

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

Get the group folder specified by the path parameter as XML.

Parameters

NameDescriptionRequiredTypeDefault value
paththe full group folder path beginning with / (/* suffix will be added automatically) e.g. /ps/acme/specs/sharednopath

Permission

Undocumented permissions requirements.

Response

If successful, the group folder is returned as a <groupfolder> element.

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

Error Handling

0x1404 If the group folder is not found
0x1405 If the group folder is not in group
0x140B Invalid path
0x6401 There is no default group folder for the group

Created on , last edited on