Web service API

How to use PageSeeder's Web service API

member

/members/{member} [DELETE]

com.pageseeder.member.DeleteMember

Description

Warning!

This class is not part of the public API, and may be subject to change!

Deletes member with specified id plus all associated objects and replaces any member references in XLinks with string values.

It will perform the following operations:

  1. Remove group memberships
  2. Update the xlinks where the member is the author by its full name
  3. Remove references to the member where the member changed the status or modified an xlink
  4. Unassign Xlink 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 will not be updated.

Parameters

No parameters required.

Permission

Undocumented permissions requirements.

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

Created on , last edited on