Skip to main content

 Web service API

How to use PageSeeder's Web service API

get group

/groups/{group} [GET]

com.pageseeder.group.GetGroup

Description

Get a group or project.

Although this service returns groups, since project is a special kind of group, it might also be used to return projects.

Parameters

No parameters required.

Permission

This service is restricted to guest and higher unless the group is accessible to public.

Response

The returned XML is either a <group> or a <project> as following:

<group|project id="123"
               name="myproject-mygroup"
               owner="My Organisation"
               description="My Own Group"
               access="[public|member]"
               common="[true|false]"
               [title="My Group"]
               [relatedurl="http://mycompany/mypage.html"]
               [visibility="myproject-mygroup"]
               [template="myproject"]
               [detailstype="mydetails"]
               commenting="[public|reviewer|contributor]"
               moderation="[none|reviewer|email|all]"
               registration="[normal|moderated|confirmed]"
               defaultrole="[reviewer|contributor]"
               defaultnotify="[immediate|daily|none]" >
  <message>Welcome to the group!</message>
</group|project>

All services return at least the following core attributes for groups/projects (except in comment/group elements which only include id and name):

<group|project id="123"
               name="myproject-mygroup"
               owner="My Organisation"
               description="My Own Group"
               access="[public|member]"
               common="[true|false]"
               [title="My Group"]   
               [relatedurl="http://mycompany/mypage.html"] />

Error Handling

CodeCause / Description
0x1108the group was not found
Created on , last edited on