...
| Element | Data Type | Required? | Default | Description |
|---|---|---|---|---|
| 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
|
| 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
...
)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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> |
...
| Element | Data Type | Description |
|---|---|---|
| ClientIdentity | PwsClientRef [0..1] |
Response Usage Example(s)
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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>
|
...