Web service API

How to use PageSeeder's Web service API

list projects

/members/{member}/projectlist [GET]

com.pageseeder.group.ListProjects

Description

List the projects and groups for the specified member.

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 top level projects, otherwise return all projects. [children|descendants].noenumchildren
pageThe page to load.nolong1
pagesizeThe number of results per page.nolong1000

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]"
             .../>
    ...
</projects>

Error Handling

CodeCause / Description
0x0204The Member was not found.

Created on , last edited on