Skip to main content

 Web service API

How to use PageSeeder's Web service API

edit project

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

com.pageseeder.group.EditGroup

Description

Edits an existing PageSeeder project.

Settings are only modified for parameters that are set.

Parameters

NameDescriptionRequiredTypeDefault value
accessAccess to project [public|member] (admin only)nostring
descriptionDescription of projectnostring
detailstypeThe name of the member details config file (admin only)nostring
messageSubscription messagenostring
ownerOwner of project (admin only)nostring
relatedurlURL of a related websitenostring
templateThe template folder for customizations (admin only)nostring
titleThe user friendly title of projectnostring
visibilityGroup name this project is visible to or public (admin only)nostring

Permission

This service requires project  manager or higher.

Response

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

Error Handling

No specific errors expected for this service.

Created on , last edited on