Web service API

How to use PageSeeder's Web service API

list projecttree

/members/{member}/projecttree [GET]

com.pageseeder.group.ListProjectsAsTree

Description

List the projects and groups that the specified member is registered to as a tree.

This service returns the list of groups and projects in hierarchical form so that sub-projects and groups appear nested correctly within the specified project.

Parameters

NameDescriptionRequiredTypeDefault value
archived Whether to return archived projects/groups only no boolean false
for if 'server' return all projects/groups for server (Administrator only) [server|member] no boolean member
groups Whether to return groups no boolean true
nameprefix prefix that project/group's full name must have to be returned no string
resultsize the max number of results (the tree may have more nodes as ancestors are always added) no integer 1000

Permission

Undocumented permissions requirements.

Response

The returned XML is as follows with <project> at the top if a context project is specified (in alphabetical order by name):

<projects for="[username|email]">
   <project id="[id]"
            name="[name]"
            owner="[owner]"
            description="[description]" ...>
     <!-- sub projects -->
     <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]" ...>
       <group id="[id]"
              name="[name]"
              description="[description]"
              owner="[owner]" ...>
       ...
     </project>
     ...
     <!-- groups -->
     <group id="[id]"
            name="[name]"
            description="[description]"
            owner="[owner]" ...>
     <group id="[id]"
            name="[name]"
            description="[description]"
            owner="[owner]" ...>
     ...
   </project>
</projects>
 

Error Handling

No specific errors expected for this service.

Created on , last edited on