Overview
This web service deletes a specified client (PwsClientRef). The service will return the identity (PwsClientRef) of the deleted client.
...
| Element | Data Type | Required? | Default | Description |
|---|---|---|---|---|
| RequestID | Int32 | No | The caller may supply any desired value here. The value supplied will be echoed back in the response as the ResponseId. | |
| SessionTicket | String | Yes | This field is required. The session ticket is generated by the web service PwsAuthenticate. | |
| 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. |
...
| Element | Data Type | Description |
|---|---|---|
| ResponseID | Int32 | Echoes the supplied request ID |
| Status | String | Status of the request |
| ServerTimestampUTC | datetime | The request completion date and time stamp expressed in UTC (Coordinated Universal Time) |
| ClientIdentity | PwsClientRef [0..1] |
Usage Example(s) Response
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<PwsDeleteClientResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsDeleteClientResult xmlns:a="http://projectorpsa.com/DataContracts/Responses/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:PwsMessage>
<b:AdditionalErrorText i:nil="true"/>
<b:ErrorCode i:nil="true"/>
<b:ErrorNumber i:nil="true"/>
<b:ErrorText i:nil="true"/>
<b:Type i:nil="true"/>
<b:ReferenceId1 i:nil="true"/>
<b:ReferenceId2 i:nil="true"/>
</b:PwsMessage>
</Messages>
<ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
<Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
<ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2017-12-21T16:14:01.7558585Z</ServerTimestampUtc>
<a:ClientIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:ClientId i:nil="true"/>
<b:ClientNumber>C000117</b:ClientNumber>
<b:ClientUid>1152921504606989806</b:ClientUid>
</a:ClientIdentity>
</PwsDeleteClientResult>
</PwsDeleteClientResponse>
|