Overview
This web service deletes a specified project (PwsProjectRef). The service will return the identity of the deleted project (PwsProjectRef).
...
| Panel | ||
|---|---|---|
| ||
|
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. | |||||||
CascadeDeleteFlag | Boolean | No | false | If set to 'true', all roles will be deleted; otherwise, request will trigger an error if any undeleted role existsroles exist. | true | |||||
ProjectIdentity | Yes | This is the identity of the project to be deleted. Click here for more information. | ||||||||
StealLockFlag | Boolean | No | false | If set to 'true', any locks on the project 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 | **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. | |||||||
| ProjectTimestamp | 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 in a prior response. This will cause the request to fail if any change has been made between the two invocationsan optimistic locking timestamp that, if provided on update request, will cause the request to fail when the timestamp stored in the database does not match the provided value. | ||||||
| ProjectorLockSetId | Int32 | No | A Projector lock set id is an identifier for a group of one or more locks held as a unit. | |||||||
| DeleteEmptyEngagementFlag | Boolean | No | false | If set to true, the associated engagement will be deleted if there is no existing project. If the engagement still has project(s), engagement deletion request is ignored. When set to false and the engagement has no existing project, warning 54668 will be included in the response. |
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:PwsDeleteProject>
<pws:serviceRequest>
<req:SessionTicket>ARM5cmQi4CD5BoGl6bHk4w==</req:SessionTicket>
<!--sch:CascadeDeleteFlag>false</sch:CascadeDeleteFlag-->
<sch:ProjectIdentity>
<com:ProjectCode>P001053-WS5</com:ProjectCode>
</sch:ProjectIdentity>
<sch:StealLockFlag>true</sch:StealLockFlag>
</pws:serviceRequest>
</pws:PwsDeleteProject>
</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. | 0 | |
Status | Click here for more information. | Ok | ||
ServerTimestampUtc | DateTime | Click here for more information. | 2018-02-01T15:16:43.8444098Z | |
ProjectIdentity | The identity of the project that was deleted. Click here for more information. | |||
EngagementTimestamp | String | See EngagementTimestamp above in Request Elements table | AAAAAA+K6i4= **deprecated** | |
LockStolenFromUserIdentity | PwsUserRefIf 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** | ||
| 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>
<PwsDeleteProjectResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsDeleteProjectResult 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/">0</ResponseId>
<Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
<ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-02-01T15:16:43.8444098Z</ServerTimestampUtc>
<a:ProjectIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:ProjectCode>P001053-WS5</b:ProjectCode>
<b:ProjectId i:nil="true"/>
<b:ProjectUid>1152921504607411807</b:ProjectUid>
</a:ProjectIdentity>
<a:EngagementTimestamp>AAAAAA+K6i4=</a:EngagementTimestamp>
<a:LockStolenFromUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
</PwsDeleteProjectResult>
</PwsDeleteProjectResponse>
</s:Body>
</s:Envelope> |
PwsDeleteProject - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
...
| ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 54076 | EngagementIsLocked | The engagement is locked by PPSA Support User and may not be updated. |
| 54596 | ProjectHasUndeletedRoles | Project cannot be deleted because there are one or more undeleted roles. |
| 54668 | EngagementEmpty | Warning - Engagement has no underlying projects. Deleting the engagement is recommended. |