Web service API

How to use PageSeeder's Web service API

edit subgroup

/groups/{group}/subgroups/{subgroup} [PATCH]

com.pageseeder.group.EditSubgroup

Description

Edit an existing subgroup.

Parameters

NameDescriptionRequiredTypeDefault value
listedWhether the member's email address is listed in the groupnoenuminherit
notificationThe member's notification option in the groupnoenuminherit
roleThe member's role in the group noenuminherit

notification

The notification parameter must be one of "immediate", "essential", "daily", "weekly", "none", or "inherit".

If not specified, the value "inherit" is used meaning that the members will inherit the notification settings from the subgroup. 

role

The role parameter must be one of "guest", "reviewer", "contributor", "manager", "approver" or "inherit".

If not specified, the value "inherit" is used meaning that the members will inherit the role from the subgroup. 

listed

The listed boolean parameter can be used to override the group's default setting. It affects whether other group members are able to see the subgroup's members' user details.

The supported values are "true", "false" and "inherit", the default value is "inherit" meaning that the members will inherit the value from the subgroup. 

 

Permission

Only group Managers can invoke this service.

Response

The XML response returns the modified <subgroup> element wrapping the <group> element acting as the subgroup.

<subgroup-modification>
   <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>
 </subgroup-modification>

Error Handling

CodeCause / Description
0x110B Invalid subgroup parameter
0x1109 Invalid notification parameter
0x110A Invalid role parameter

Created on , last edited on