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
accessAccess to group and comments [public|member] (admin only).nostring
descriptionDescription of project.nostring
detailstypeThe name of the member details config file (admin only).nostring
messageSubscription message.nostring
ownerOwner of project (admin only).nostring
relatedurlURL of a related website.nostring
templateThe template folder for customizations (aka style owner – admin only).nostring
titleThe user friendly title of project.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

No specific errors expected for this generator.

Created on , last edited on