Skip to main content

 Web service API

How to use PageSeeder's Web service API

create group

/members/{member}/groups [POST]

com.pageseeder.group.CreateGroup

Description

Creates a group in PageSeeder.

It is recommended to set the parameter commenting=reviewer so that only group members can post comments.

Parameters

NameDescriptionRequiredTypeDefault value
descriptionDescription of groupyesstring
projectnameParent project nameyesstring
shortnameShortname of groupyesstring
accessAccess to group and comments  (admin only) [public|member]nostringmember
addmemberWhether to add the current member as a managernobooleantrue
commentingWho can comment [public|reviewer|contributor]nostringpublic
commonWhether this is a common group. DEPRECATED in PageSeeder v5.99.nobooleanfalse
createdocumentsWhether to create default documentsnobooleantrue
defaultnotifyDefault notification for new members [immediate|daily|none]nostringimmediate
defaultroleDefault role for new members [reviewer|contributor]nostringreviewer
detailstypeThe name of the member details config file (admin only)nostring
editurlsAllow contributors in this group to edit all URLs on the server (admin only)nobooleanfalse
messageSubscription messagenostring
moderationWhich comments are to be moderated [reviewer|email|all]nostringreviewer
ownerOwner of group (admin only)nostring[project owner]
property.*Value for group property named *nostring
registrationSelf-registration method [normal|moderated|confirmed]nostringnormal
relatedurlURL of a related websitenostring
templateThe template folder for customizationsnostring
titleThe user friendly title of group. Max 255 charactersnostring
visibilityGroup name this is visible to or public (admin only)nostring[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

CodeCause / Description
0x110CThe projectname must be specified, or is invalid
0x0201Missing required shortname and description
Created on , last edited on