Overview
This web service deletes a specified client (PwsClientRef). The service will return the identity (PwsClientRef) of the deleted client.
| Panel |
|---|
|
- serviceRequest: PwsDeleteClientRq
- RequestID: Int32
- SessionTicket: String
- CascadeDeleteFlag: Boolean
- ClientIdentity: PwsClientRef [1]
|
Request Elements
| Element | Data Type | Required? | Default | Description |
|---|
| RequestID | Int32 | No |
| The caller may supply any desired value here. The value supplied will be echoed back in the response as the ResponseId. |
| SessionTicket | String | Yes |
| This field is required. The session ticket is generated by the web service PwsAuthenticate. |
| CascadeDeleteFlag | Boolean | No | "true" or "false" | This flag is set to "true" when the user wants to delete the client and, all of the client's children - If set to "false", an attempt to delete a client that has child clients will fail
- If set to "true", and the client and all of its can be deleted, all clients are deleted
- If set to "true", and the InactivateIfInUseFlag is also set to true, the client and its child clients will be deleted if possible, otherwise they will be marked inactive. A client can be deleted if it is not in use elsewhere and all its child clients (if any) can be deleted. Otherwise, it must be inactivated
- If set to "true", and the InactivateIfInUseFlag is set to false, an error is returned (because at least one client cannot be deleted, per bullet 2 above
|