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
countonly If "true" only return the count of the number of results no boolean false
email The member's email no email
field1 Custom field #1 no string
field10 Custom field #10 no string
field11 Custom field #11 no string
field12 Custom field #12 no string
field13 Custom field #13 no string
field14 Custom field #14 no string
field15 Custom field #15 no  string
field2 Custom field #2 no string
field3 Custom field #3 no string
field4 Custom field #4 no string
field5 Custom field #5 no string
field6 Custom field #6 no string
field7 Custom field #7 no string
field8 Custom field #8 no string
field9 Custom field #9 no string
firstname The member's first name no string
member-role The member's role, can be: guest, reviewer, contributor, manager, moderator, approver, moderator-and-approver no string
member-username The member's username no  string
page The page to load (only for subgroups=false) no long 1
pagesize The number of results per page (may return less results if subgroups=true) no  long 1000
role If equal to "manager", display the full details for each member (group manager only) no  string
status The member's membership status, can be: normal, invited, self-invited, moderated, disabled no string
subgroups If subgroups should be included in the response (only status normal returned, false if field[x] specified) no boolean true
surname The member's last name no string

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