Web service API

How to use PageSeeder's Web service API

create project

/members/{member}/projects [POST]

com.pageseeder.group.CreateGroup

Description

Creates a new project in PageSeeder.

Parameters

NameDescriptionRequiredTypeDefault value
description Description of project yes string
shortname Shortname of project yes string
host The host name for the default group folder (required if projectname not specified) maybe string
hosturl The host URL for the default group folder (required if projectname not specified) - DEPRECATED use host maybe string
owner Owner of project/group (required if projectname not specified) maybe string
access Access to group and comments [public|member] no enum member
addmember Whether to add the current member as a manager no boolean true
detailstype The name of the member details config file no string
message Subscription message no string
projectname Parent project name no string
relatedurl URL of a related website no string
template The template folder for customizations (aka style owner) no string
title The user friendly title of project no string
visibility Group name this is visible to or 'public' no string [projectname-shortname]

Permission

Undocumented permissions requirements.

Response

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

Error Handling

CodeCause / Description
0x110CMissing required hosturl if projectname is not.
0x0201Missing required shortname or description 

Created on , last edited on