Web service API

How to use PageSeeder's Web service API

get groupfolder sharing

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

com.pageseeder.groupfolder.GetGroupFolder

Description

Get a group folder with ID and sharing details (that's why the member on the URL)

Load the group folder (GroupURI) specified by the url parameter as XML.

Parameters

NameDescriptionRequiredTypeDefault value
sharing whether to include full sharing information no boolean false

Permission

Undocumented permissions requirements.

Response

The output has the following format:

   <groupfolder id="[groupuri id]"
       scheme="[scheme]"
       host="[host]"
       port="[port]"
       path="[path]"
       external="[true|false]"
       editable="[true|false]"
       public="[true|false]"
       [sharing="[private|shared]"]
     [<sharing hidden="2">
       <share editable="true" shareedits="true" sharexrefs="true" addcomments="true" default="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

CodeCause / Description
0x1401 If the url is invalid
0x1404 If the group folder is not found
0x1405 If the group folder is not in group

Created on , last edited on