Versions Compared

Key

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

...

ElementData TypeRequired?DefaultDescriptionSample Data
RequestIdInt32No

Click here for more information

1
SessionTicketString (50)Yes
Click here for more information
AavFwbZgVb9V4tr3R7BbzQ==
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. Click here for more information.
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

...

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
2018-01-17T19:00:18.2269303Z
ClientIdentityPwsClientRef [0..1]The identity of the deleted client. Click here for more information.

Response Usage Example(s)

...