member
/members/{member} [DELETE]
API Support | Available since | Last updated | Output |
---|---|---|---|
5.9300 | 5.9800 | json, xml |
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:
- Remove group memberships
- Update the comments, edits, etc. where the member is the author by setting full name and email directly
- Remove references to the member where the member changed the status or modified a comment
- Unassign tasks to the member
- Remove the personal group/project
- Remove any lock
- Delete the member.
The database transaction is only committed at the end, so if an error occurs, the database isn't updated.
Parameters
Name | Description | Required | Type | Default |
---|---|---|---|---|
clear | Whether to clear the member name and email from comments, edits, etc | no | boolean | false |
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.