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
archivedwhether to return archived projects/groups only (otherwise they are not included)nobooleanfalse
forif 'server' return all projects/groups for server (Administrator only); if 'manager' return only projects/groups member is a manager of (server|manager|member)nostringmember
nameprefixprefix that project/group's full name can have to be returnednostring
titleprefixprefix that project/group's title can have to be returnednostring
pagethe page to loadnointeger1
pagesizethe number of results per pagenointeger1000

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