Web service API

How to use PageSeeder's Web service API

list group members details

/groups/{group}/members/alldetails [GET]

com.pageseeder.membership.ListMembersForGroup

Description

Lists the members of a group and all details of their membership. See <member> for documentation on available information.

Parameters

NameDescriptionRequiredTypeDefault value
deletedIf removed/deregistered and invited members should be included in the response (subgroups and permanently deleted not included).nobooleanfalse
membersTo return details of specific members, submit a comma-separated list of member IDs (overrides usernames).nolong
pageThe page to load (only for subgroups=false).nolong1
pagesizeThe number of results per page (may return less results if subgroups=true).nolong1000
subgroupsTo include subgroup members in the response (false – if members or usernames specified).nobooleantrue
usernamesTo return details of specific members, submit a comma-separated list of usernames.nostrings

Permission

Accessible to members of a group with a role of Manager or higher. The member must be logged-in to access this service.

Response

Valid requests will return the following XML: 

<memberships count="[n]"
             [limitreached="true"]>
    <group|project id="[group id]"
                   name="[group name]"
                   description="[description]"
                   owner="[owner]"
                   [relatedurl="[url]"] />
        <membership id="[membership id]"
                    email-listed="[true|false]"
                    notification="[notification]"
                    flags="[flags]"
                    status="normal"
                    role="[role]"
                    [subgroups="[subgroups]"]>
            <member id="[member id]"
                    firstname="[first name]"
                    surname="[surname]"
                    username="[username]"
                    flags="[flags]"
                    status="[activated|unactivated]">
                <fullname>[full name]</fullname>
            </member>
            <details>
                <field position="1"
                       name="[field name]"
                       editable="[true|false]"
                       [title="[field title]"]
                       [type="[field type]"]>[field value]
                </field>
                ...
            </details>
        </membership>
        ...
</memberships>

Invalid requests will return the following XML:

<memberships count="0">   
    <group id="12" 
           name="example-g" 
           title="g"
           description="g"
           owner="example"
           access="member"
           common="false"/>
</memberships>

Error Handling

CodeCause / Description
0x6004If the member details have not been configured properly

 

Created on , last edited on