Overview
This web service deletes a specified engagement (PwsEngagementRef). The service will return the identity of the deleted client engagement (PwsClientRefPwsEngagementRef). 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 |
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
trueEngagementTimestamp
String
No
This is a Base64 encoded timestamp utilized for engagement locking. For internal use only.
**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. 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.**deprecated** | ||
LockStolenFromUserIdentity | **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)
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PwsDeleteEngagementResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsDeleteEngagementResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/Scheduling/" 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-19T19:32:35.9700152Z</ServerTimestampUtc>
<a:EngagementIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:EngagementCode>P001323</b:EngagementCode>
<b:EngagementId i:nil="true"/>
<b:EngagementUid>1152921504607326487</b:EngagementUid>
</a:EngagementIdentity>
<a:EngagementTimestamp>AAAAAA99vU0=</a:EngagementTimestamp>
<a:LockStolenFromUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
</PwsDeleteEngagementResult>
</PwsDeleteEngagementResponse>
</s:Body>
</s:Envelope> |
PwsDeleteEngagement - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
| ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 54059 | EngagementNotSpecified | A specified engagement identity was incomplete. Each engagement identity must specify either an engagement id, and engagement uid or an engagement code. |
| 54061 | EngagementNotFound | The specified engagement does not exist. |
| 54076 | EngagementIsLocked | The engagement is locked by {ownerDisplayName} and may not be updated.??The engagement is locked and may not be updated. |
| 54532 | UnexpectedErrorDeletingEngagement | There was an unexpected error while trying to delete the engagement. |
| 54536 | NoPermissionToDeleteEngagement | You do not have appropriate permissions to delete this engagement. |
| 54537 | EngagementHasProjects | This engagement could not be deleted because there are one or more projects associated with it. |
| 54556 | EngagementHasInvoices | This engagement could not be deleted because there are one or more invoices associated with it. |