Web service API

How to use PageSeeder's Web service API

list subprojects

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

com.pageseeder.group.ListProjects

Description

List the sub-projects the member is registered to

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

This service returns the list of groups and projects for a single level directly under the specified project ({group}).

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
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 with <project> at the top if a context project is specified:

<projects [for="[username|email]"]
          [limitreached="[true]"]>
   <project 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