Versions Compared

Version Old Version 65 New Version 66
Changes made by

Bettina Borces

Bettina Borces

Saved on

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

Request Usage Example(s)


Code Block
languagexml
titleRequest 01
collapsetrue
      <PwsDeleteClient>
         <serviceRequest>
            <RequestId>1</RequestId>
            <SessionTicket>AVWN2cthcvkr13Vtxbkl4Q==</SessionTicket>
            <CascadeDeleteFlag>true</CascadeDeleteFlag>
            <ClientIdentity>
               <ClientNumber>C000117</com:ClientNumber>
            </ClientIdentity>
            <InactivateIfInuseFlag>true</InactivateIfInuseFlag>
         </serviceRequest>
      </PwsDeleteClient>

...