Web service API

How to use PageSeeder's Web service API

find group members

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

com.pageseeder.membership.FindGroupMembers

Description

This service searches for members in the group that match the specified criteria and returns the group details for a list of group members based on the search parameters.

Search parameters

The options to search members are all optional.

The search performs an exact matching but case insensitive search.

Parameters

NameDescriptionRequiredTypeDefault value
countonlyIf "true", only return the count of the number of results.nobooleanfalse
emailThe member's email address.noemail
field1Custom field #1.nostring
field10Custom field #10.nostring
field11Custom field #11.nostring
field12Custom field #12.nostring
field13Custom field #13.nostring
field14Custom field #14.nostring
field15Custom field #15.no string
field2Custom field #2.nostring
field3Custom field #3.nostring
field4Custom field #4.nostring
field5Custom field #5.nostring
field6Custom field #6.nostring
field7Custom field #7.nostring
field8Custom field #8.nostring
field9Custom field #9.nostring
firstnameThe member's first name.nostring
member-roleThe member's role, can be: guest, reviewer, contributor, manager, moderator, approver, moderator-and-approver).nostring
member-usernameThe member's username.no string
pageThe page to load (only for subgroups=false).nolong1
pagesizeThe number of results per page (may return less results if subgroups=true).no long1000
roleIf equal to "manager", display the full details for each member (group manager only).no string
statusThe member's membership status, can be: normal, invited, self-invited, moderated, disabled.nostring
subgroupsIf subgroups should be included in the response (only status normal returned, false if field[x] specified).nobooleantrue
surnameThe member's last name.nostring

Permission

All group members (not guest members) are able to invoke this service.

This service will only return the full member details if the role parameter is specified and set to "manager" and the logged in user has the role of Manager in the group.

Response

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

Custom fields can also be returned, see Custom member details.

Error Handling

No specific errors expected for this service.

Created on , last edited on