Web service API

How to use PageSeeder's Web service API

manage group member

/groups/{group}/members/{member}/manage [POST]

com.pageseeder.membership.ManageMembership

Description

Edit the membership details for a member.

Group membership parameters

If a group is specified on the request, the new member is also added to the group. All group membership parameters are optional, and will default to the group's default values.

The notification parameter must be one of "immediate", "daily" or "none". Users are able to change this setting later through the user interface in their group registration options.

The role parameter must be one of "guest", "reviewer", "contributor", "manager", "approver", "moderator-and-approver", "moderator".

The listed boolean parameter can be used to override the group's default setting. It affects whether other group member are able to see the member's user details. Users are able to change this setting later through the user interface in their group registration options.

Registration / Deregistration

This service can be used to register/deregister a member to/from group by using the appropriate parameters ( register and deregister respectively).

Parameters

NameDescriptionRequiredTypeDefault value
deregisterSet to "true" to deregister the member from the groupnobooleanfalse 
field1Custom field #1nostring
field10Custom field #10nostring
field11Custom field #11nostring
field12Custom field #12nostring
field13Custom field #13nostring
field14Custom field #14nostring
field15Custom field #15nostring
field2Custom field #2nostring
field3Custom field #3nostring
field4Custom field #4nostring
field5Custom field #5nostring
field6Custom field #6nostring
field7Custom field #7nostring
field8Custom field #8nostring
field9Custom field #9nostring
listedWhether the member's email address is listed in the groupnoboolean
notificationThe member's notification option in the groupnoenum
registerSet to "true" to register the member to the group nobooleanfalse  
roleThe member's role in the group (cannot be used if deregister=true)noenum
welcome-emailWhether to send a group welcome email to the membernobooleantrue

Permission

This service can only be invoked by a manager in the group or an administrator .

Group membership parameters

Response

When successful, the XML returned the full details of the updated membership as a <membership> element wrapped in a <membership-modification>:

<membership-modification>
   <membership id="[membershipid]"
               email-listed="[true|false]"
               notification="[none|immediate|daily]"
               flags="[flags]"
              [status="[status]"]
              [role="[role]"]>
     <member id="[member id]"
             firstname="[first name]"
             surname="[surname]"
             username="[username]"
             status="[activated|unactivated|set-password]">
       <fullname>[full name]</fullname>
     </member>
     <group id="[group id]"
            name="[name]"
            visibility="[visibility]"
            template="[template]">
       <description>[description]</description>
     </group>
   </membership>
 </membership-modification>
 

Error Handling

CodeCause / Description
0x1006If the user is not a member of the group.
0x1007Unabled to find matching group
0x100DIf the specified role is illegal
0x1014If the user attempts to deregister and register or change his role at the same time
0x6004If the member details have not been configured properly

Created on , last edited on