Skip to main content

 Services

Web services from /about to /webhooks

deregister group member

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

com.pageseeder.membership.EditMembership

Description

Deregister a member from a group.

Parameters

No parameters required.

Permission

The current member or an administrator can invoke this service.

Response

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

<membership-modification>
  <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>[some text about the group]
      </description>
    </group>
  </membership>
</membership-modification>
 

Error Handling

CodeCause / Description
0x0106Member was not found
0x0107Group was not found
Created on , last edited on