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 roles 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 engagement containing 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 | 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 invocations.**deprecated** | |||
EngagementTimestamp | String | **deprecated** |
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 deleting this project, this identifies the user from whom the lock was stolen. 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)
...