Web service API

How to use PageSeeder's Web service API

list subgroups

/groups/{group}/subgroups [GET]

com.pageseeder.group.ListSubgroups

Description

Returns the list of subgroups in the specified Group.

 

Parameters

No parameters required.

Permission

Only members who can view the specified group can invoke this service.

Response

The XML returns each subgroup in the main group as <subgroup> element wrapped in a <subgroups> element.

<subgroups>
   <subgroup id="[id]"
             role="[approver|manager|contributor|reviewer|guest||inherit]"
             notification="[immediate|daily|none|inherit]"
             listed="[true|false|inherit]">
     <group id="[group id]
            name="[group name]" .../>
   </subgroup>
   ...
</subgroups>

Error handling

No specific errors expected for this service.

Created on , last edited on