Web service API

How to use PageSeeder's Web service API

edit group

/members/{member}/groups/{group}/edit [POST]

com.pageseeder.group.EditGroup

This service is deprecated since version 5.7900

Description

Edits an existing PageSeeder project/group.

Group settings are only modified for parameters that are set.

Deprecation warning!

This service has been deprecated, use service /members/{member}/groups/{group} [PATCH]

Parameters

NameDescriptionRequiredTypeDefault value
accessAccess to group and comments [public|member]nostring
commentingWho can comment [public|reviewer|contributor]nostring
commonWhether this is a common groupnoboolean
defaultnotifyDefault notification for new members [immediate|daily|none]nostring
defaultroleDefault role for new members [reviewer|contributor]nostring
descriptionDescription of project/groupnostring
detailstypeThe name of the member details config filenostring
messageSubscription messagenostring
moderationWhich comments will be moderated [reviewer|email|all]nostring
ownerOwner of project/groupnostring
registrationSelf-registration method [normal|moderated|confirmed]nostring
relatedurlURL of a related websitenostring
templateThe template folder for customisations (aka style owner)nostring
visibilityGroup name this is visible to or 'public'nostring

Permission

Undocumented permissions requirements.

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
0x110C One of the parameters is invalid.

Created on , last edited on