member

Description

Deletes member with specified ID plus all associated objects and replaces any member references as an author with string values.

It performs the following operations:

1. Remove group memberships
2. Update the comments, edits, etc. where the member is the author by setting full name and email directly
3. Remove references to the member where the member changed the status or modified a comment
4. Unassign tasks to the member
5. Remove the personal group/project
6. Remove any OAuth client and persistent token
7. Delete the profile picture
8. Remove any lock
9. Delete the member.

The database transaction is only committed at the end, so if an error occurs, the database isn't updated.

Deleted objects

After deletion all API calls to the following objects return a 404 HTTP error.

Updated objects

When the member is deleted the following objects are preserved and remain accessible:

• Comments,
• Tasks,
• Notes,
• Edits,
• Versions,
• Workflows.

References to the member as an author are replaced to only retain the full name and email address of the member, or the full name is set to “Name removed” with no email if the clear parameter is used.

References to the member where they are an assignee (assignedto), modifier (modifiedby), or have changed the status (statuschangedby) are removed.

For example, in the following comment:

{
  "id": 13,
  "contentrole": "Comment",
  "created": "2023-07-10T19:09:43+10:00",
  "title": "Test",
  "author": {
    "id": 123,
    "firstname": "Aaron",
    "surname": "Andrews",
    "username": "aandrews",
    "status": "activated",
    "fullname": "Aaron Andrews",
    "email": "aaron@example.org"
  },
  "modifiedby": {
    "id": 123,
    "firstname": "Aaron",
    "surname": "Andrews",
    "username": "aandrews",
    "status": "activated",
    "fullname": "Aaron Andrews",
    "email": "aaron@example.org",
    "date": "2023-07-11T13:13:24+10:00"
  },
  "content":[{
    "type":"application/xhtml+xml",
    "value":"<p>The author will be removed!</p>"
  }],
  "groups":[{
    "id": 72,
    "name": "sample-doc"
  }]
}

After the member “Aaron Andrews” is deleted, the comment becomes:

{
  "id": 13,
  "contentrole": "Comment",
  "created": "2023-07-10T19:09:43+10:00",
  "title": "Test",
  "author": {
    "fullname": "Aaron Andrews",
    "email": "aaron@example.org"
  },
  "content":[{
    "type":"application/xhtml+xml",
    "value":"<p>The author will be removed!</p>"
  }],
  "groups":[{
    "id": 72,
    "name": "sample-doc"
  }]
}

The modifiedby is no longer returned.

Parameters

clear

The clear parameter also removes the name and email address from PageSeeder so that the member is no longer identifiable.

This parameter affects comments, edits, notes, tasks and any object associated with the member. For example, the author of comment written by a member that has been deleted appears as:

"author":{
  "fullname": "Aaron Andrews",
  "email": "aaron@example.org"
}

If the clear parameter is set to true, then it is:

"author":{
  "fullname": "Name removed"
}

Permission

This service requires administrator.

Response

The service returns a <member-delete> element containing a single <member> element corresponding to the member before it is deleted.

<member-delete>
  <member ...> ... </member>
</member-delete>

Or in JSON:

{
  "member": { ... }
}

Error Handling

No specific errors expected for this service.