Web service API

How to use PageSeeder's Web service API

members

/members [GET]

com.pageseeder.member.FindMembers

Description

Members

Warning!

This class is not part of the public API, and may be subject to change!

Finds members.

If there is a group on the request only returns direct members of groups under the top ancestor project.

The returned XML is as follows:


 <members [limitreached="true"]>
   <member id="[member id]"
    firstname="[first name]"
      surname="[surname]"
     username="[username]"
        email="[email]"
       status="[activated|unactivated|set-password]">
     <fullname>[full name]</fullname>
   </member>
   ...
 </members>
 

Parameters

Name Description Required Type Default value
page the page to load no integer 1
pagesize the number of results per page no integer 1000

Permission

Undocumented permissions requirements.

Response

Undocumented XML response

The returned XML is as follows:


 <members [limitreached="true"]>
   <member id="[member id]"
    firstname="[first name]"
      surname="[surname]"
     username="[username]"
        email="[email]"
       status="[activated|unactivated|set-password]">
     <fullname>[full name]</fullname>
   </member>
   ...
 </members>
 

Error Handling

No specific errors expected for this generator.

Created on , last edited on