membership

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 subsequently change this setting 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 subsequently change this setting 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 modify the member accordingly.

notification

The notification can be none, immediate or daily.

Permission

The member on the request or an administrator can invoke this service.

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