...
This web service deletes a specified engagement (PwsEngagementRef). The service will return the identity of the deleted client engagement (PwsClientRefPwsEngagementRef).
Request Format
Panel | ||
---|---|---|
| ||
|
...
Element | Data Type | Required? | Default | Description | Sample Data |
---|---|---|---|---|---|
RequestId | Int32 | No | Click here for more information. | 1 | |
SessionTicket | String | Yes | Click here for more information. | AWYoWMBC/cjl/RFPrykteA== | |
EngagementIdentity | Yes | This is the identity of the engagement to be deleted. Click here for more information. | |||
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 | true | |
EngagementTimestamp | String | No | This is a Base64 encoded timestamp utilized for engagement locking. For internal use only. The caller may optionally echo back the timestamp returned by a prior call to PwsGetEngagement, to protect against inadvertently deleting an engagement that has been modified. If a value is specified here, and it does not match the current timestamp on the engagement in the database, the request to delete the engagement will fail. |
Request Usage Example(s)
...
Element | Data Type | Description | Sample Data |
---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
ResponseId | Int32 | Click here for more information. | 1 |
Status | Click here for more information. | Ok | |
ServerTimestampUtc | DateTime | Click here for more information. | 2018-01-19T19:32:35.9700152Z |
EngagementIdentity | The identity of the deleted engagement | ||
EngagementTimestamp | String | This is a Base64 encoded timestamp utilized for engagement locking. For internal use only. | AAAAAA99vU0= |
LockStolenFromUserIdentity | If a lock is stolen in the process of updating an engagement, this identifies the user from which the lock was stolen from. Click here for more information. |
...