Versions Compared

Version Old Version 66 New Version Current
Changes made by

Bettina Borces

Bettina Borces

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
titlePwsDeleteClient Request

...

ElementData TypeRequired?DefaultDescriptionSample Data
RequestIdInt32No

Click here for more information

1
SessionTicketString (50)Yes
Click here for more information
AVWN2cthcvkr13Vtxbkl4QAavFwbZgVb9V4tr3R7BbzQ==
CascadeDeleteFlagBooleanNofalse

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
ClientIdentityPwsClientRefYes
This is the identity of the client to be deleted
InactivateIfInuseFlagBooleanNofalseIf set to 'true', a client that cannot be deleted because it is in use will be set to inactive, otherwise the request will failtrue/false

...

Code Block
languagexml
titleRequest Example 01
collapsetrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pws="http://projectorpsa.com/PwsProjectorServices/" xmlns:req="http://projectorpsa.com/DataContracts/Requests/"   <PwsDeleteClient>xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsDeleteClient>
         <serviceRequest><pws:serviceRequest>
            <RequestId>1<<req:RequestId>1</req:RequestId>
            <SessionTicket>AVWN2cthcvkr13Vtxbkl4Q<req:SessionTicket>AavFwbZgVb9V4tr3R7BbzQ==</req:SessionTicket>
            <CascadeDeleteFlag>true<<req:CascadeDeleteFlag>true</req:CascadeDeleteFlag>
            <ClientIdentity><req:ClientIdentity>
               <ClientNumber>C000117<<com:ClientNumber>C000122</com:ClientNumber>
            </req:ClientIdentity>
            <InactivateIfInuseFlag>true<<req:InactivateIfInuseFlag>true</req:InactivateIfInuseFlag>
         </pws:serviceRequest>
      </pws:PwsDeleteClient>
   </soapenv:Body>
</soapenv:Envelope>


Response Format


Panel
titlePwsDeleteClientRs


Response Elements


ElementData TypeDescriptionSample Data
MessagesPwsMessage[]

The web service response status and message. Click here for more information.


ResponseIdInt32Click here for more information1
StatusRequestStatusClick here for more informationOk
ServerTimestampUtcDateTimeClick here for more information
20172018-1201-21T1617T19:1400:0118.7558585Z2269303Z
ClientIdentityPwsClientRef [0..1]The identity of the deleted client

...

Code Block
languagexml
titleResponse Example 01
collapsetrue
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
       <PwsDeleteClientResponse><PwsDeleteClientResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsDeleteClientResult  <PwsDeleteClientResult>xmlns:a="http://projectorpsa.com/DataContracts/Responses/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Messages i:nil="truexmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
             <ResponseId>1<<ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
             <Status>Ok<<Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc>2017-12-21T16:14:01.7558585Z</ServerTimestampUtc><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


ErrorNumberErrorCodeErrorNumberErrorTextErrorText
101ClientInactivated101The client could not be deleted and instead it was marked inactive
50046UpdatePermissionDenied50046You do not have permission to update this item.
57623UnexpectedErrorDeletingClient57623There was an unexpected error while trying to delete the client.
57624ClientHasChildClients57624The client could not be deleted because there are one or more child clients of this client.
57625ChildClientCouldNotBeDeleted57625The client could not be deleted because one of its child clients could not be deleted.
57626ChildIsReferencedByEngagement57626The client could not be deleted because at least one engagement is associated with this client.

57627

ClientIsReferencedByUser57627The client could not be deleted because at least one user is associated with this client.

57628

ClientIsReferencedByInvoice57628The client could not be deleted because at least one invoice is associated with this client.
57629ClientNotFound57629The specified client was not found.
57631ClientNotSpecified57631A specified client identity was incomplete. Each client identity must specify either a client id, client uid or client number.

...