create group
/members/{member}/groups [POST]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.4101 | 5.9500 | xml, json |
Description
Creates a group in PageSeeder.
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| description | Description of group | yes | string | |
| projectname | Parent project name | yes | string | |
| shortname | Shortname of group | yes | string | |
| access | Access to group and comments (admin only) [public|member] | no | string | member |
| addmember | Whether to add the current member as a manager | no | boolean | true |
| commenting | Who can comment [public|reviewer|contributor] | no | string | reviewer |
| common | Whether this is a common group. DEPRECATED in PageSeeder v5.99. | no | boolean | false |
| createdocuments | Whether to create default documents | no | boolean | true |
| defaultnotify | Default notification for new members [immediate|daily|none] | no | string | immediate |
| defaultrole | Default role for new members [reviewer|contributor] | no | string | reviewer |
| detailstype | The name of the member details config file (admin only) | no | string | |
| editurls | Allow contributors in this group to edit all URLs on the server (admin only) | no | boolean | false |
| message | Subscription message | no | string | |
| moderation | Which comments are to be moderated [reviewer|email|all] | no | string | reviewer |
| owner | Owner of group (admin only) | no | string | [project owner] |
| property.* | Value for group property named * | no | string | |
| registration | Self-registration method [normal|moderated|confirmed] | no | string | normal |
| relatedurl | URL of a related website | no | string | |
| template | The template folder for customizations | no | string | |
| title | The user friendly title of group. Max 255 characters | no | string | |
| visibility | Group name this is visible to or public (admin only) | no | string | [projectname-shortname] |
Permission
Requires contributor or higher in the parent project.
Response
<group|project-creation>
<group|project id="123"
name="myproject-mygroup"
[title="My group"]
description="My own group"
owner="My Organisation"
access="[public| member]"
common="[true|false]"
[relatedurl="http://mycompany/mypage.html"]
[visibility="myproject-mygroup"]
[template="myproject"]
[detailstype="mydetails"]
editurls="[true|false]"
commenting="[public|reviewer|contributor]"
moderation="[none|reviewer|email|all]"
registration="[normal|moderated|confirmed]"
defaultrole="[reviewer|contributor]"
defaultnotify="[immediate|daily|none]" >
<message>Welcome to the group!</message>
</group|project>
</group|project-creation>
Error Handling
| Code | Cause / Description |
|---|---|
| 0x110C | The projectname must be specified, or is invalid |
| 0x0201 | Missing required shortname and description |