Web service API

How to use PageSeeder's Web service API

edit membership

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

com.pageseeder.membership.EditMembership

This service is deprecated since version 5.7900

Description

Edit a membership.

Deprecation warning!

This service has been deprecated, use /groups/{group}/members/{member} [PATCH] instead.

Member details

Both the firstname and surname are limited to 20 characters.

The member-username must be less than 100 characters, unique and cannot contain a '@'.

The email must be less than 100 characters, unique and be a valid Email address.

Password details

The member-password must be less than 100 characters.

Passwords must satisfy a given strength check to be accepted:

  • Regular members must have at least a MEDIUM strength.
  • Administrators must use a STRONG password.

Group membership parameters

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.

Additional information specific to the group can also be attached to the user using the details fields field1 to field15

This service can be used to deregister a member from a group by setting the deregister parameter to "true".

 

Parameters

NameDescriptionRequiredTypeDefault value
current-passwordThe member's current password (required by non-administrator if a new password is specified)maybestring
acceptSet to "true" to accept an invitation to the groupnobooleanfalse
deregisterSet to "true" to remove the user from the groupnobooleanfalse
emailThe member's emailnostring
field1nostring
field10nostring
field11nostring
field12nostring
field13nostring
field14nostring
field15nostring
field2nostring
field3nostring
field4nostring
field5nostring
field6nostring
field7nostring
field8nostring
field9nostring
firstnameThe member's first namenostring
force-email-changeSet to "true" to change the email address without notification (admin only)nobooleanfalse
listedWhether the member's email address is listed in the groupnoboolean
member-passwordThe member's passwordnostring
member-usernameThe member's usernamenostring
notificationThe member's notification option in the groupnostring
password-emailSet to "false" to change the password without notification (adminstrator only)nobooleantrue
roleThe member's role in the group (admin only)nostring
surnameThe member's last namenostring
welcome-emailWhether to send a group welcome email to the membernobooleantrue

Permission

The current member or Administrator s can invoke this service.

Response

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

Error Handling

Created on , last edited on