Web service API

How to use PageSeeder's Web service API

memberships

/groups/{group}/members [GET]

com.pageseeder.membership.ListMembersForGroup

Description

Collection of members in the group

Returns the list of members for a group.

Parameters

NameDescriptionRequiredTypeDefault value
deletedIf deleted and invited members should be included in the response (subgroups not included)nobooleanfalse
membersA comma-separated list of member ids to return only certain members (overrides usernames)nolongs
pageThe page to load (only for subgroups=false)nolong1
pagesizeThe number of results per page (may return less results if subgroups=true)nolong1000
subgroupsIf subgroups should be included in the response (false if members or usernames specified)nobooleantrue
usernamesA comma separated list of member usernames to return only certain membersnostrings

Permission

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

Response

This service returns a <memberships> element containing:

  1. the group or project common to all memberships as basic  <group> or <project>;
  2. each membership as a <membership> element including the <member> only 
<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]"
               status="normal"
               role="[role]"
              [subgroups="[subgroups]"]>
     <member id="[member id]"
             firstname="[first name]"
             surname="[surname]"
             username="[username]"
             status="[activated|unactivated]">
        <fullname>[full name]</fullname>
     </member>
   </membership>
   <membership status="invited" ...> ... </membership>
   ...
</memberships> 

Error Handling

CodeCause / Description
0x1022 The member does not belong to the group
0x1027 The supplied member ID is invalid
0x6004 If the member details have not been configured properly

 

Created on , last edited on