...
Panel | ||
---|---|---|
| ||
|
...
Element | Data Type | Required? | Default | Description | Sample Data |
---|---|---|---|---|---|
RequestId | Int32 | No | Click here for more information | 1 | |
SessionTicket | String (50) | Yes | Click here for more information | AavFwbZgVb9V4tr3R7BbzQ== | |
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
| true/false |
ClientIdentity | PwsClientRef | Yes | This is the identity of the client to be deleted. Click here for more information. | ||
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 | true/false |
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<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:ClientNumber>C000122</com:ClientNumber> </req:ClientIdentity> <req:InactivateIfInuseFlag>true</req:InactivateIfInuseFlag> </pws:serviceRequest> </pws:PwsDeleteClient> </soapenv:Body> </soapenv:Envelope> |
...
Panel | ||
---|---|---|
| ||
|
Response Elements
Element | Data Type | Description | Sample Data |
---|---|---|---|
Messages | PwsMessage[] | The web service response status and message. Click here for more information. | |
ResponseId | Int32 | Click here for more information | 1 |
Status | RequestStatus | Click here for more information | Ok |
ServerTimestampUtc | DateTime | Click here for more information | 2018-01-17T19:00:18.2269303Z |
ClientIdentity | PwsClientRef [0..1] | The identity of the deleted client. Click here for more information. |
Response Usage Example(s)
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <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/"/> <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId> <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status> <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-01-17T19:00:18.2269303Z</ServerTimestampUtc> <a:ClientIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:ClientId i:nil="true"/> <b:ClientNumber>C000122</b:ClientNumber> <b:ClientUid>1152921504606998463</b:ClientUid> </a:ClientIdentity> </PwsDeleteClientResult> </PwsDeleteClientResponse> </s:Body> </s:Envelope> |
...