Skip to main content

 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 removed/deregistered and invited members should be included in the response (subgroups and permanently deleted 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 (might 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

This service requires reviewer or higher.

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> and if applicable, the <details> element.
<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
0x1022The member does not belong to the group
0x1027The supplied member ID is invalid
0x6004If the member details have not been configured properly

 

Created on , last edited on