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 and groups for the given member.

This service returns the list of projects and groups under the specified project ({group}).

Parameters

NameDescriptionRequiredTypeDefault value
archivedWhether to return archived projects/groups only.nobooleanfalse
forIf 'server', return all projects/groups for server (Administrator only) [member|server].noenummember
groupsWhether to return groups.nobooleantrue
relationshipIf 'children', return project's children, otherwise return all descendants. [children|descendants].noenumchildren
pageThe page to load.nointeger1
pagesizeThe number of results per page.nointeger1000

Permission

Permissions requirements to be updated.

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