Skip to main content

 Web service API

How to use PageSeeder's Web service API

member

/members/{member} [DELETE]

com.pageseeder.member.DeleteMember

Description

Deletes member with specified id plus all associated objects and replaces any member references in XLinks 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 lock
  7. Delete the member.

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

Parameters

NameDescriptionRequiredTypeDefault value
clearWhether to clear the member name and email from comments, edits, etcnobooleanfalse

Permission

This service requires administrator.

Response

The service returns a <member-delete> element containing a single <member> element.

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

Error Handling

No specific errors expected for this service.

Created on , last edited on