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
archivedWhether to return archived projects/groups only.nobooleanfalse
forIf 'server', return all projects/groups for server (Administrator only) [server|member]nobooleanmember
groupsWhether to return groups.nobooleantrue
nameprefixPrefix that project/group's full name must have to be returned.nostring
resultsizeThe max number of results (the tree may have more nodes as ancestors are always added).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 (in alphabetical order by name):

<projects for="[username|email]">
    <project id="[id]"
             name="[name]"
             owner="[owner]"
             description="[description]"
             ...>
        <!-- groups -->
        <group id="[id]"
                name="[name]"
                description="[description]"
                owner="[owner]"
                ...>
            <group id="[id]"
                    name="[name]"
                    description="[description]"
                    owner="[owner]"
                    ...>
                ...

                <!-- 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>
        ...
    </project>
</projects>

Error Handling

No specific errors expected for this service.

Created on , last edited on