Web service API

How to use PageSeeder's Web service API

get group memberdetails

/members/{member}/groups/{group}/memberdetails [GET]

com.pageseeder.group.GetGroupMemberDetails

Description

Get a group's member details.

This service is used when a member does not belong to a group but wishes to join it. It returns the member detail fields (if defined for the group) that the member needs to enter when joining.

It will also return values that have been entered before by the member if they joined previously or the details are configured to be shared across groups.​​​​​​

Parameters

NameDescriptionRequiredTypeDefault value
roleIf equal to "manager", display all the group-specific fields for member (group manager only)nostring

 

Permission

Undocumented permissions requirements.

Response

The returned XML is as follows:

<details>
   <field position="1"
          name="[name]"
          editable="[true|false]"
          visibility="[group|member|manager]"
          [title="[title]"]
          [type="[type]"]>[value]</field>
   ...
</details> 

Error handling

No specific errors expected for this service.

Created on , last edited on