Use the del operation to remove user accounts.
A request XML packet removing user accounts includes the del operation node:
<packet version="1.6.3.0">
<user>
<del>
...
</del>
</user>
</packet>
The del node is nested within the UserGetInput type (user.xsd
). This node has the following graphics representation:
It specifies the filtering rule. Data type: UserSelectionFilterType (user.xsd
). For more information on filters, refer to the Available Filters section.
The del node of the response packet is structured as follows:
It wraps the result of the requested operation. Data type: extension of resultType (common.xsd
).
It returns the execution status of the operation. Data type: string. Allowed values: ok | error.
Is used to return the error code when the operation fails. Data type: unsignedInt.
It returns an error message if the operation fails. Data type: string.
It returns a filtering rule specified in the request packet. Data type: anySimple.
It is required if the operation succeeds. Returns the unique identifier of a removed user account. Data type: integer.
A request packet can look as follows:
<packet version="1.6.3.0">
<user>
<del>
<filter>
<guid>8712cd03-14e2-9e16-95af-c67e3ffc2696</guid>
</filter>
</del>
</user>
</packet>
Request:
<packet version="1.6.3.0">
<user>
<del>
<result>
<status>ok</status>
<filter-id>8712cd03-14e2-9e16-95af-c67e3ffc2696</filter-id>
<id>21</id>
</result>
</del>
</user>
</packet>