...
This web service deletes a specified client (PwsClientRef). The service will return the identity of the deleted client (PwsClientRef).
Request Format
| Panel |
|---|
| title | PwsDeleteClient Request |
|---|
|
- PwsDeleteClientRq
[1]- InactivateIfInuseFlag: Boolean
|
Request Elements
| Element | Data Type | Required? | Default | Description | Sample Data |
|---|
| RequestId | Int32 | No |
| Click here for more information | 1 |
| SessionTicket | String | Yes |
| Click here for more information | AavFwbZgVb9V4tr3R7BbzQ== |
| 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 - If set to "'false"', an attempt to delete a client that has one more children will fail
- If set to "'true"', and the client and all of its children can be deleted, all 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 [1] | 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/false |
Request Usage Example(s)
| Code Block |
|---|
| language | xml |
|---|
| title | Request Example 01 |
|---|
| collapse | true |
|---|
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
<PwsDeleteClient> <soapenv:Header/>
<soapenv:Body>
<serviceRequest> <pws:PwsDeleteClient>
<RequestId>1</RequestId><pws:serviceRequest>
<SessionTicket>AVWN2cthcvkr13Vtxbkl4Q==</SessionTicket><req:RequestId>1</req:RequestId>
<CascadeDeleteFlag>true</CascadeDeleteFlag><req:SessionTicket>AavFwbZgVb9V4tr3R7BbzQ==</req:SessionTicket>
<ClientIdentity><req:CascadeDeleteFlag>true</req:CascadeDeleteFlag>
<!--ClientId>?</com:ClientId--><req:ClientIdentity>
<ClientNumber>C000117<<com:ClientNumber>C000122</com:ClientNumber>
<!--ClientUid>?</com:ClientUid-->/req:ClientIdentity>
</ClientIdentity><req:InactivateIfInuseFlag>true</req:InactivateIfInuseFlag>
<InactivateIfInuseFlag>true</InactivateIfInuseFlag></pws:serviceRequest>
</serviceRequest>pws:PwsDeleteClient>
</soapenv:Body>
</PwsDeleteClient>soapenv:Envelope> |
Response Format
Response Elements
[0..1] | The identity of the deleted client |
|
Response Usage Example(s)
...
| Code Block |
|---|
| language | xml |
|---|
| title | Response Example 01 |
|---|
| collapse | true |
|---|
|
<PwsDeleteClientResponse>
<PwsDeleteClientResult>
<Messages>
<PwsMessage>
<AdditionalErrorText i:nil="true"/<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<ErrorCode i:nil="true"/<PwsDeleteClientResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<ErrorNumber i:nil="true"/>
<ErrorText i:nil="true"/<PwsDeleteClientResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Messages <Type i:nil="truexmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
<ReferenceId1 i:nil="true"/><ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
<ReferenceId2 i:nil="true"/><Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
</PwsMessage>
</Messages>
<ResponseId>1</ResponseId>
<Status>Ok</Status>
<ServerTimestampUtc>2017-12-21T16:14:01.7558585Z<<ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-01-17T19:00:18.2269303Z</ServerTimestampUtc>
<ClientIdentity><a:ClientIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<ClientId<b:ClientId i:nil="true"/>
<ClientNumber>C000117<<b:ClientNumber>C000122</b:ClientNumber>
<ClientUid>1152921504606989806<<b:ClientUid>1152921504606998463</b:ClientUid>
</a:ClientIdentity>
</PwsDeleteClientResult>
</PwsDeleteClientResponse>
</s:Body>
</s:Envelope>
|
PwsDeleteClient - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
| ErrorNumber | ErrorCode | ErrorNumberErrorTextErrorText |
|---|
| 101 | ClientInactivated101 | The client could not be deleted and instead it was marked inactive |
| 50046 | UpdatePermissionDenied | 50046 | You do not have permission to update this item. |
| 57623 | UnexpectedErrorDeletingClient57623 | There was an unexpected error while trying to delete the client. |
| 57624 | ClientHasChildClients | 57624 | The client could not be deleted because there are one or more child clients of this client. |
| 57625 | ChildClientCouldNotBeDeleted | 57625 | The client could not be deleted because one of its child clients could not be deleted. |
| 57626 | ChildIsReferencedByEngagement | 57626 | The client could not be deleted because at least one engagement is associated with this client. |
57627 | ClientIsReferencedByUser | 57627 | The client could not be deleted because at least one user is associated with this client. |
57628 | ClientIsReferencedByInvoice57628 | The client could not be deleted because at least one invoice is associated with this client. |
| 57629 | ClientNotFound57629 | The specified client was not found. |
| 57631 | ClientNotSpecified57631 | A specified client identity was incomplete. Each client identity must specify either a client id, client uid or client number. |
...