...
This web service deletes a specified Client client (PwsClientRef). The service will return the identity of the deleted Client client (PwsClientRef).
Request Format
...
| Element | Data Type | Required? | Default | Description | Sample Data |
|---|
| RequestId | Int32 | No |
| Click here for more information. | 1 |
| SessionTicket | String (50) | Yes |
| Click here for more information. | AVWN2cthcvkr13Vtxbkl4Q== |
| CascadeDeleteFlag | Boolean | No | false | This flag is set to " true" , when the user wants to delete the Client client and, all of the Clientclient's children - If set to " false", an attempt to delete a client that has one more children will fail
- If set to " true", and the Client client and all of its children can be deleted, all Clients clients are deleted
- If set to " true", and the InactivateIfInUseFlag is also set to true, the client and its children 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 children (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)
| true/false |
| ClientIdentity | PwsClientRef | Yes |
| This is the identity of the client to be deleted |
|
| InactivateIfInuseFlag | Boolean | No | false | If set to true, a client that cannot be deleted because it is in use will be set to inactive, otherwise the request will fail. | true |
Request Usage Example(s)
| Code Block |
|---|
| language | xml |
|---|
| title | Request 01 |
|---|
| collapse | true |
|---|
|
<PwsDeleteClient>
<serviceRequest>
<RequestId>1</RequestId>
<SessionTicket>AVWN2cthcvkr13Vtxbkl4Q==</SessionTicket>
<CascadeDeleteFlag>true</CascadeDeleteFlag>
<ClientIdentity>
<ClientNumber>C000117</com:ClientNumber>
</ClientIdentity>
<InactivateIfInuseFlag>true</InactivateIfInuseFlag>
</serviceRequest>
</PwsDeleteClient> |
...
Response Elements
| Element | Data Type | Description | Sample Data |
|---|
| Messages | PwsMessage |
The web service response status and Message.. | 1 |
| Status | RequestStatus | Click here for more information |
..Response Usage Example(s)
...