Web service API

How to use PageSeeder's Web service API

membership

/groups/{group}/members/{member} [PATCH]

com.pageseeder.membership.EditMembership

Description

Edit the details of a member and its membership for a specific group.

Member details

Both the firstname and surname are limited to 50 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", "essential", "daily", "weekly" 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

There are no required parameters for this service, but parameters that are specified will modify the member accordingly.

NameDescriptionRequiredTypeDefault value
current-passwordThe member's current password (required by non-administrator if a new password is specified).maybestring
acceptWhether to accept an invitation to the group.nobooleanfalse
deregisterWhether to remove the member from the group.nobooleanfalse
emailThe member's email address.noemail
field1Custom field #1.no string
field10Custom field #10.nostring 
field11Custom field #11.nostring 
field12Custom field #12.nostring 
field13Custom field #13.nostring 
field14Custom field #14.nostring 
field15Custom field #15.nostring 
field2Custom field #2.nostring
field3Custom field #3.nostring 
field4Custom field #4.nostring 
field5Custom field #5.nostring 
field6Custom field #6.nostring 
field7Custom field #7.nostring 
field8Custom field #8.nostring 
field9Custom field #9.nostring 
firstnameThe member's first name.nostring
force-email-changeSet to "true" to change the email address without notification (administrator only).nobooleanfalse
listedWhether the member's email address is listed in the group.noboolean
member-passwordThe member's password.nostring
member-usernameThe member's username, defaults to the member's email address.nostring
notificationThe member's notification option in the group.noenum
password-emailSet to "false" to change the password without notification (adminstrator only).nobooleantrue
roleThe member's role in the group (administrators only).noenum
surnameThe member's last name.no string
welcome-emailWhether to send a group welcome email to the member.nobooleantrue
notify-asyncWhether emails should be sent asynchronously (for slow email servers).nobooleanfalse

notification

The notification can be 'none', 'immediate' or 'daily'.

Permission

The current member or an Administrator can invoke this service.

Warning!

The permissions regarding the assignment of the group specified fields may change in future releases.

 

Response

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

<membership-modification>
    <membership id="[membershipid]" 
                email-listed="[true|false]" 
                notification="[none|
                              essential|
                              immediate|
                              daily|
                              weekly]"
                [status="[status]"]
                [role="[role]"]>
        <member id="[member id]"
                firstname="[first name]"
                surname="[surname]"
                username="[username]"
                email="[email]"
                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
0x1001If the username is invalid
0x1002If the email address is invalid
0x1004If the specified username or email is already in use by another user
0x1006If the member is not a member of the group
0x1007If the first name or surname is longer than 20 characters
0x1008If the user or email is not specified
0x1009If the username is too long
0x100AIf the email address is longer then 100 characters
0x100BIf the password is too long
0x1015If the password is too weak
0x1017If the current password is incorrect
0x1026If the member has not been invited to the group
0x6003If the password change notification could not be sent
0x6004If the member details have not been configured properly

Created on , last edited on