Overview
This web service deletes a specified engagement (PwsEngagementRef). The service will return the identity of the deleted client (PwsClientRef).
Request Format
PwsDeleteEngagement Request
- PwsDeleteEngagement
- serviceRequest: PwsDeleteEngagementRq
- RequestId: Int32
- SessionTicket: String
- EngagementIdentity: PwsEngagementRef
- StealLockFlag: Boolean
- EngagementTimestamp: String
- serviceRequest: PwsDeleteEngagementRq
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
---|---|---|---|---|---|
RequestId | Int32 | No | Click here for more information. | ||
SessionTicket | String | Yes | Click here for more information. | ||
EngagementIdentity | Yes | This is the identity of the engagement to be deleted | |||
StealLockFlag | Boolean | Yes | If set to 'true', any locks on the engagement will be stolen if it is currently locked, otherwise, if it is set to 'false' and a lock is in place the service will fail | ||
EngagementTimestamp | String | No | This is a Base64 encoded timestamp utilized for engagement locking. For internal use only. |