...
| Panel | ||
|---|---|---|
| ||
|
- This request also requires the common input elements (includes the Common Input Elements)
Request Elements
| Element | Data Type | Required? | Default | Description | Common InputCommon Input Elements | |
|---|---|---|---|---|---|---|
| CascadeDeleteFlag | Boolean | No | "false" | This flag is set to "true" when the user wants to delete the client and, all of the client's children
| ||
| ClientIdentity | PwsClientRef [1] | 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. |
...
| Panel | ||
|---|---|---|
| ||
|
- The response also includes the Common Output Elements
Response Elements
| Element | Data Type | Description | Common OutputCommon Output Elements | |
|---|---|---|---|---|
| ClientIdentity | PwsClientRef [0..1] |
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<PwsDeleteClientResponse>
<PwsDeleteClientResult>
<Messages>
<PwsMessage>
<AdditionalErrorText i:nil="true"/>
<ErrorCode i:nil="true"/>
<ErrorNumber i:nil="true"/>
<ErrorText i:nil="true"/>
<Type i:nil="true"/>
<ReferenceId1 i:nil="true"/>
<ReferenceId2 i:nil="true"/>
</PwsMessage>
</Messages>
<ResponseId>1</ResponseId>
<Status>Ok</Status>
<ServerTimestampUtc>2017-12-21T16:14:01.7558585Z</ServerTimestampUtc>
<ClientIdentity>
<ClientId i:nil="true"/>
<ClientNumber>C000117</ClientNumber>
<ClientUid>1152921504606989806</ClientUid>
</ClientIdentity>
</PwsDeleteClientResult>
</PwsDeleteClientResponse>
|
Errors and Warnings
| ErrorCode | ErrorNumberErrorCode | ErrorText | Type |
|---|---|---|---|
| ClientInactivated | 101 | The client could not be deleted and instead it was marked inactive | Warning |
| UpdatePermissionDenied | 50046 | Permission denied | Error |
| UnexpectedErrorDeletingClient | 57623 | Unexpected error deleting client | Error |
| ClientHasChildClients | 57624 | Client could not be deleted because it has at least one child client (CascadeDeleteFlag = false) | Error |
| ChildClientCouldNotBeDeleted | 57625 | Client could not be deleted because it has at least one child client that cannot be deleted (CascadeDeleteFlag = true) | Error |
| ChildIsReferencedByEngagement | 57626 | The client could not be deleted because at least one engagement is associated with this client. | Error |
| ClientIsReferencedByUser | 57627 | Client could not be deleted because it is referenced by at least one user | Error |
| ClientIsReferencedByInvoice | 57628 | Client could not be deleted because it is referenced by at least one invoice | Error |
...