Overview

This web service deletes a specified client (PwsClientRef). The service will return the identity of the deleted client (PwsClientRef).

Request Format

PwsDeleteClientRq

- RequestId: Int32
- SessionTicket: String
- CascadeDeleteFlag: Boolean
- ClientIdentity: PwsClientRef [1]
- InactivateIfInuseFlag: Boolean

Request Elements

Element	Data Type	Required?	Default	Description
RequestId	Int32	No
SessionTicket	String	Yes
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)
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.

Request Usage Example(s)

Request 01

      <PwsDeleteClient>
         <serviceRequest>
            <RequestId>1</RequestId>
            <SessionTicket>AVWN2cthcvkr13Vtxbkl4Q==</SessionTicket>
            <CascadeDeleteFlag>true</CascadeDeleteFlag>
            <ClientIdentity>
               <!--ClientId>?</com:ClientId-->
               <ClientNumber>C000117</com:ClientNumber>
               <!--ClientUid>?</com:ClientUid-->
            </ClientIdentity>
            <InactivateIfInuseFlag>true</InactivateIfInuseFlag>
         </serviceRequest>
      </PwsDeleteClient>

Response Format

PwsDeleteClientRs

PwsDeleteClientRs
- Message: PwsMessage
- ResponseId: Int32
- Status: String
- ServerTimestampUtc: DateTime
- PwsClientRef [0..1]

Response Elements

Element	Data Type	Description
Messages	PwsMessage
ResponseId	Int32
Status	RequestStatus
ServerTimestampUtc	DateTime
ClientIdentity	PwsClientRef [0..1]

Response Usage Example(s)

Response 01

      <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>

PwsDeleteClient - Common Errors and Warnings

For all errors and warnings please refer to the Complete List of Errors and Warnings

ErrorCode	ErrorNumber	ErrorText
ClientInactivated	101	The client could not be deleted and instead it was marked inactive
UpdatePermissionDenied	50046	You do not have permission to update this item.
UnexpectedErrorDeletingClient	57623	There was an unexpected error while trying to delete the client.
ClientHasChildClients	57624	The client could not be deleted because there are one or more child clients of this client.
ChildClientCouldNotBeDeleted	57625	The client could not be deleted because one of its child clients could not be deleted.
ChildIsReferencedByEngagement	57626	The client could not be deleted because at least one engagement is associated with this client.
ClientIsReferencedByUser	57627	The client could not be deleted because at least one user is associated with this client.
ClientIsReferencedByInvoice	57628	The client could not be deleted because at least one invoice is associated with this client.
ClientNotFound	57629	The specified client was not found.
ClientNotSpecified	57631	A specified client identity was incomplete. Each client identity must specify either a client id, client uid or client number.