Web service API

How to use PageSeeder's Web service API

add subgroup

/groups/{group}/subgroups/add [POST]

com.pageseeder.group.AddSubgroup

Description

Adds a new subgroup in an existing group.

Parameters

NameDescriptionRequiredTypeDefault value
subgroupThe ID or name of the group to add as a subgroupyesstring
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

subgroup

This parameter must be the ID or name of the group to add as a subgroup to the main group.

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 managers of both the group and the subgroup can invoke this service.

Response

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

<subgroup-addition>
   <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-addition>

Error Handling

CodeCause / Description
0x1108 Invalid group parameter
0x1109 Invalid notification parameter
0x110A Invalid role parameter
0x110D Subgroup already exists

Created on , last edited on