Web service API

How to use PageSeeder's Web service API

list visible groups

/members/{member}/visiblegroups [GET]

com.pageseeder.group.ListVisibleGroups

Description

Returns the list of groups visible to the specified member.

A visible group is one that the member does not belong to and has the Group Setting "Group Visible to:" equal to "public" or to the name of a group the member belongs to.

Parameters

No parameters required.

Permission

Permissions requirements to be updated.

Response

When it exists group visible, the returned XML is:

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

When it doesn't exist, the returned XML is:

<groups/>

Error Handling

CodeCause / Description
0x102AThe member not found.

Created on , last edited on