Web service API

How to use PageSeeder's Web service API

deregister group member

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

com.pageseeder.membership.EditMembership

Description

Deregister a member

Warning!

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

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

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 username is required unless the an email address is specified.

The email must be less than 100 characters, unique and be a valid Email address. The email address is required unless a username is specified.

Password details

The member-password must be less than 100 characters. When the Password is not specified, the member's email will be used if no confirmation is needed, otherwise a new password will be generated.

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 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

No parameters required.

Permission

The current member or Administrators can invoke this service

Response

When successful, the updated membership is returned as a <membership> element wrapped in a <membership-modification> element.

<membership-modification [welcome-email-failed="true"]>
   <membership id="[membershipid]"
               email-listed="[true|false]"
               notification="[none|immediate|daily]"
              [status="status"]
              [role="role"]>
     <member id="[member id]"
             firstname="[first name]"
             surname="[surname]"
             username="[username]"
             status="[activated|unactivated]">
       <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
0x1001 If the username is invalid
0x1002 If the email address is invalid
0x1004 If the specified username or email is already in use by another user
0x1006 If the member is not a member of the group
0x1007 If the first name or surname is longer than 20 characters
0x1008 If the user or email is not specified
0x1009 If the username is too long
0x100A If the email address is longer then 100 characters
0x100B If the password is too long
0x1014 If the user attempts to deregister and accept invitation at the same time
0x1015 If the password is too weak
0x1026 If the member has not been invited to the group
0x6004 If the member details have not been configured properly

Created on , last edited on