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

Returns the list of members in the group and includes the full details of their membership.

Parameters

NameDescriptionRequiredTypeDefault value
deleted If deleted and invited members should be included in the response (subgroups not included) no boolean false
members A comma-separated list of member ids to return only certain members (overrides usernames) no longs
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
subgroups If subgroups should be included in the response (false if members or usernames specified) no boolean true
usernames A comma separated list of member usernames to return only certain members no strings

Permission

This service will list the full member details and the logged in user must be a Manager in the group.

Response

The XML returned is:

<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>

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