Web service API

How to use PageSeeder's Web service API

edit group

/members/{member}/groups/{group} [PATCH]

com.pageseeder.group.EditGroup

Description

Edits a group.

Edits an existing PageSeeder project/group.

Group settings are only modified for parameters that are set.

Parameters

NameDescriptionRequiredTypeDefault value
accessAccess to group and comments (admin only) [public|member].noenum
commentingWho can comment [public|reviewer|contributor].noenum
commonWhether this is a common group.noboolean
defaultnotifyDefault notification for new members [immediate|daily|none].noenum
defaultproperty.*Whether group property named * should take the default value.noboolean
defaultroleDefault role for new members [reviewer|contributor].noenum
descriptionDescription of group.nostring
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).noboolean
messageSubscription message.nostring
moderationWhich comments will be moderated [reviewer|email|all].noenum
ownerOwner of group (admin only).nostring
property.*Value for group property named *.nostring
registrationSelf-registration method [normal|moderated|confirmed].noenum
relatedurlURL of a related website.nostring
templateThe template folder for customizations (aka style owner – admin only).nostring
titleThe user friendly title of group.nostring
visibilityGroup name this is visible to or 'public' (admin only).nostring

Permission

Permissions requirements to be updated.

Response

<group|project-modification>
    <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-modification>
 

Error Handling

CodeCause / Description
0x110COne of the parameters is invalid

Created on , last edited on