Web service API

How to use PageSeeder's Web service API

create group

/members/{member}/groups [POST]

com.pageseeder.group.CreateGroup

Description

Creates a group

Creates a new project/group in PageSeeder.

Parameters

NameDescriptionRequiredTypeDefault value
description Description of group yes string
projectname Parent project name yes string
shortname Shortname of group yes string
access Access to group and comments  (admin only) [public|member] no string member
addmember Whether to add the current member as a manager no boolean true
commenting Who can comment [public|reviewer|contributor] no string public
common Whether this is a common group no boolean false
createdocuments Whether to create default documents (ignored if project=true) no boolean true
defaultnotify Default notification for new members [immediate|daily|none] no string immediate
defaultrole Default role for new members [reviewer|contributor] no string reviewer
detailstype The name of the member details config file (admin only) no string
editurls Allow editing server wide properties of all external URIs in this group (admin only) no boolean
message Subscription message no string
moderation Which comments will be moderated [reviewer|email|all] no string reviewer
owner Owner of project/group (admin only) no string
property.* Value for group property named * no string
registration Self-registration method [normal|moderated|confirmed] no string normal
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 group no string
visibility Group name this is visible to or 'public' (admin only) no string [projectname-shortname]

Permission

Undocumented permissions requirements.

Response

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

Error handling

CodeCause / Description
0x110C One of the parameters is invalid

Created on , last edited on