Web service API

How to use PageSeeder's Web service API

edit project

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

com.pageseeder.group.EditGroup

Description

Edits a project

Edits an existing PageSeeder project/group.

Group settings are only modified for parameters that are set.

Parameters

NameDescriptionRequiredTypeDefault value
access Access to group and comments [public|member] (admin only) no string
description Description of project no string
detailstype The name of the member details config file (admin only) no string
message Subscription message no string
owner Owner of project (admin only) no string
relatedurl URL of a related website no string
template The template folder for customizations (aka style owner - admin only) no string
title The user friendly title of project no string
visibility Group name this is visible to or 'public' (admin only) no string

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

No specific errors expected for this generator.

Created on , last edited on