Overview
This web service deletes a specified engagement (PwsEngagementRef). The service will return the identity of the deleted engagement (PwsEngagementRef). Before deleting an engagement, please use PwsDeleteProject to remove all the projects under this engagement.
Request Format
| Panel | ||
|---|---|---|
| ||
|
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
Int32 | No | Click here for more information. | 1 | ||
String | Yes | Click here for more information. | AWYoWMBC/cjl/RFPrykteA== | ||
EngagementIdentity | Yes | This is the identity of the engagement to be deleted | |||
StealLockFlag | Boolean |
No
false
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
trueEngagementTimestamp
String
No
This is a Base64 encoded timestamp utilized for engagement locking. To protect against overwriting other changes, you may optionally echo back the timestamp returned by a call to PwsGetEngagement. This will cause the request to fail if any change has been made between invocations of PwsGetEngagement and PwsDeleteEngagement.
**deprecated** | |||||
EngagementTimestamp | String | **deprecated** | |||
| LocksToSteal | PwsEntityLockSummary | No | The detailed information of the locks that are to be stolen. If not specified, the request will fail if any requested locks are already held. If specified, the information supplied must exactly match the current state of existing locks or the attempt to steal the existing locks will fail. Typically, this service is invoked with LocksToSteal empty or null. If there are existing locks, they will be returned in the LockHolders member of PwsFault. This data can then be sent, as is, back to the server in a second invocation of this service, as LocksToSteal, if the caller desires to steal the locks. | ||
| ProjectorLockSetId | Int32 | No | A projector lock set id is an identifier for a group of one or more locks held as a unit. | ||
| CascadeDeleteFlag | Boolean | No | false | If set to true, the associated project(s) will be deleted alongside the engagement. Contract line item(s) under the engagement will be deleted regardless of the flag setting. | false |
Request Usage Example(s)
| 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:sch="http://projectorpsa.com/DataContracts/Shared/Scheduling/" xmlns:com="http://projectorpsa.com/DataContracts/Shared/Common/">
<soapenv:Header/>
<soapenv:Body>
<pws:PwsDeleteEngagement>
<pws:serviceRequest>
<req:RequestId>1</req:RequestId>
<req:SessionTicket>AWYoWMBC/cjl/RFPrykteA==</req:SessionTicket>
<sch:EngagementIdentity>
<com:EngagementCode>P001323</com:EngagementCode>
<com:EngagementUid>1152921504607326487</com:EngagementUid>
</sch:EngagementIdentity>
<sch:StealLockFlag>true</sch:StealLockFlag>
</pws:serviceRequest>
</pws:PwsDeleteEngagement>
</soapenv:Body>
</soapenv:Envelope> |
...
| Panel | ||
|---|---|---|
| ||
|
Response Elements
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 | |||
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. | AAAAAA99vU0= | **deprecated** | |
LockStolenFromUserIdentity | PwsUserRefIf a lock is stolen in the process of updating an engagement, this identifies the user from whom the lock was stolen from | **deprecated** | |||
| StolenLocks | PwsEntityLockSummary | This structure contains information about the locks that were stolen in order to complete this request, Will be included only when LocksToSteal is specified in the request. |
Response Usage Example(s)
...