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.

Parameters

NameDescriptionRequiredTypeDefault value
descriptionDescription of group.yesstring
projectnameParent project name.yesstring
shortnameShortname of group.yesstring
accessAccess to group and comments  (admin only) [public|member].nostringmember
addmemberWhether to add the current member as a manager.nobooleantrue
commentingWho can comment [public|reviewer|contributor].nostringpublic
commonWhether this is a common group.nobooleanfalse
createdocumentsWhether to create default documents.nobooleantrue
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 editing server wide properties of all external URIs in this group (admin only).nobooleanfalse
messageSubscription message.nostring
moderationWhich comments will 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 website.nostring
templateThe template folder for customizations (aka style owner – admin only).nostring
titleThe user friendly title of group. Max 255 characters.nostring
visibilityGroup name this is visible to or 'public' (admin only).nostring[projectname-shortname]

Permission

Permissions requirements to be updated.

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="[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 inválid.
0x0201Missing required shortname and description.

Created on , last edited on