Web service API

How to use PageSeeder's Web service API

groupfolder

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

com.pageseeder.groupfolder.GetGroupFolder

Description

Load the group folder specified as XML.

Parameters

NameDescriptionRequiredTypeDefault value
sharingWhether to include full sharing information.nobooleantrue

Permission

Permissions requirements to be updated.

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]"
        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
0x1401If the url is invalid
0x1404If the group folder is not found
0x1405If the group folder is not in group

Created on , last edited on