Versions Compared

Key

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

...

ElementData TypeRequired?DefaultDescriptionSample Data
RequestIdInt32No
Click here for more information1
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 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/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
   <soapenv:Header/>
   <soapenv:Body>
      <pws:PwsDeleteClient>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AavFwbZgVb9V4tr3R7BbzQ==</req:SessionTicket>
            <req:CascadeDeleteFlag>true</req:CascadeDeleteFlag>
            <req:ClientIdentity>
               <!--com:ClientId>?</com:ClientId-->
               <com:ClientNumber>C000122</com:ClientNumber>
               <!--com:ClientUid>?</com:ClientUid-->
            </req:ClientIdentity>
            <req:InactivateIfInuseFlag>true</req:InactivateIfInuseFlag>
         </pws:serviceRequest>
      </pws:PwsDeleteClient>
   </soapenv:Body>
</soapenv:Envelope>

...