Web service API

How to use PageSeeder's Web service API

list subprojects

/members/{member}/projects/{group}/subprojects [GET]

com.pageseeder.group.ListProjectsAsTree

This service is deprecated since version 5.7900

Description

List the sub-projects the member is registered to

Deprecation warning!

This service is deprecated.

Use Service: /members/{member}/projects/{group}/subprojecttree [GET] instead.

Returns the list of projects and groups for the given member.

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.

Note that the admin group is not included.

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) [member|server] no enum member
groups Whether to return groups no boolean true
nameprefix prefix that project/group's full name must have to be returned no string
relationship if 'children' return project's children or top level projects, otherwise return all descendants [children|descendants] no enum descendants
resultsize the max number of results in the entire tree 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:

<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> 

Error handling

No specific errors expected for this service.

Created on , last edited on