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
descriptionDescription of project.yesstring
shortnameShortname of project.yesstring
hostThe host name for the default group folder (required if projectname not specified).maybestring
hosturlThe host URL for the default group folder (required if projectname not specified) –DEPRECATED use host.maybestring
ownerOwner of project/group (required if projectname not specified).maybestring
accessAccess to group and comments [public|member].noenummember
addmemberWhether to add the current member as a manager.nobooleantrue
detailstypeThe name of the member details config file.nostring
messageSubscription message.nostring
projectnameParent project namenostring
relatedurlURL of a related website.nostring
templateThe template folder for customizations (aka style owner).nostring
titleThe user friendly title of project.nostring
visibilityThe group name this is visible to or 'public'.nostring[projectname-shortname]

Permission

Permissions requirements to be updated.

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