Web service API

How to use PageSeeder's Web service API

find projects

/members/{member}/projects/find [GET]

com.pageseeder.group.FindProjects

Description

Finds projects and groups for a member.

Note that archived groups are not included.

Parameters

NameDescriptionRequiredTypeDefault value
for if 'server' return all projects/groups for server (Administrator only); if 'manager' return only projects/groups member is a manager of (server|manager|member) no string member
nameprefix prefix that project/group's full name must have to be returned no string
page the page to load no integer 1
pagesize the number of results per page no integer 1000

Permission

Undocumented permissions requirements.

Response

The returned XML is as follows (in alphabetical order on name):

<projects for="[username|email]"
          limitreached="[true]">
   <project id="[id]"
            name="[name]"
            owner="[owner]"
            description="[description]" ... />
   <group id="[id]"
          name="[name]"
          description="[description]"
          owner="[owner]" .../>
   <project id="[id]"
            name="[name]"
            description="[description]"
            owner="[owner]"  ... />
   <group id="[id]"
          name="[name]"
          description="[description]"
          owner="[owner]" .../>
   <group id="[id]"
          name="[name]"
          description="[description]"
          owner="[owner]" .../>
     ...
</projects>

Error handling

No specific errors expected for this service.

Created on , last edited on