Versions Compared

Version Old Version 2 New Version Current
Changes made by

Min Zeng

Bettina Borces

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview


This web service deletes a specified project (PwsProjectRef). The service will return the identity of the deleted project (PwsProjectRef).

...

Panel
titlePwsDeleteProject Request

Request Elements


Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

 No

No


Click here for more information.

1


SessionTicket

String

Yes 

Yes


Click here for more information.

AWYoWMBC/cjl/RFPrykteA==

EngagementIdentity

PwsEngagementRef

Yes 


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

PwsProjectRef

Yes


This is the identity of the

engagement

project 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. To protect against overwriting other changes, you may optionally echo back the timestamp returned by a call to PwsSaveEngagement(or a prior call to PwsSaveEngagement). This will cause the request to fail if any change has been made between invocations of PwsGetEngagement and PwsSaveEngagement

**deprecated**




EngagementTimestamp

String

**deprecated**




LocksToStealPwsEntityLockSummaryNo
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.
ProjectTimestampStringNo
This is an 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.
ProjectorLockSetIdInt32No
A Projector lock set id is an identifier for a group of one or more locks held as a unit.
DeleteEmptyEngagementFlagBooleanNofalseIf 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
languagexml
titleExample 01
collapsetrue
<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>PwsDeleteProject>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AWYoWMBC/cjl/RFPrykteASessionTicket>ARM5cmQi4CD5BoGl6bHk4w==</req:SessionTicket>
            <sch:EngagementIdentity><!--sch:CascadeDeleteFlag>false</sch:CascadeDeleteFlag-->
               <com:EngagementCode>P001323</com:EngagementCode><sch:ProjectIdentity>
               <com:EngagementUid>1152921504607326487<ProjectCode>P001053-WS5</com:EngagementUid>ProjectCode>
            </sch:EngagementIdentity>ProjectIdentity>
            <sch:StealLockFlag>true</sch:StealLockFlag>
         </pws:serviceRequest>
      </pws:PwsDeleteEngagement>PwsDeleteProject>
   </soapenv:Body>
</soapenv:Envelope>

Response Format


Panel
titlePwsDeleteEngagement PwsDeleteProject Response

Response Elements


Element

Data Type

Description

Sample Data

Messages

PwsMessage[]

The web service response status and message. Click here for more information.


ResponseId

Int32

Click here for more information.

1

0

Status

RequestStatus

Click Click here for  for more information.

Ok

ServerTimestampUtc

DateTime

Click here for more information.

2018-

01

02-

19T19

01T15:

32

16:

35

43.

9700152Z

8444098Z

EngagementIdentityProjectIdentity

PwsEngagementRefPwsProjectRef

The identity of the deleted engagementproject that was deleted. Click here for more information.


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 which the lock was stolen from

**deprecated**


StolenLocksPwsEntityLockSummaryThis 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
languagexml
titleExample 01
collapsetrue
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsDeleteEngagementResponse<PwsDeleteProjectResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsDeleteEngagementResult<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/">1<>0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-0102-19T1901T15:3216:3543.9700152Z<8444098Z</ServerTimestampUtc>
            <a:EngagementIdentityProjectIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:EngagementCode>P001323<ProjectCode>P001053-WS5</b:EngagementCode>ProjectCode>
               <b:EngagementIdProjectId i:nil="true"/>
               <b:EngagementUid>1152921504607326487<ProjectUid>1152921504607411807</b:EngagementUid>ProjectUid>
            </a:EngagementIdentity>ProjectIdentity>
            <a:EngagementTimestamp>AAAAAA99vU0EngagementTimestamp>AAAAAA+K6i4=</a:EngagementTimestamp>
            <a:LockStolenFromUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
         </PwsDeleteEngagementResult>PwsDeleteProjectResult>
      </PwsDeleteEngagementResponse>PwsDeleteProjectResponse>
   </s:Body>
</s:Envelope>

...

PwsDeleteProject - Common Errors and Warnings

...

The specified engagement does not exist.
ErrorNumberErrorCodeErrorText
54059EngagementNotSpecifiedA specified engagement identity was incomplete. Each engagement identity must specify either an engagement id, and engagement uid or an engagement code.
54061EngagementNotFound
54076EngagementIsLockedThe engagement is locked by {ownerDisplayName} and may not be updated.??The engagement is locked PPSA Support User and may not be updated.
5453254596UnexpectedErrorDeletingEngagementThere was an unexpected error while trying to delete the engagement.
54536NoPermissionToDeleteEngagementYou do not have appropriate permissions to delete this engagement.
54537EngagementHasProjectsThis engagement could not ProjectHasUndeletedRolesProject cannot be deleted because there are one or more projects associated with itundeleted roles.
5455654668EngagementHasInvoicesThis engagement could not be deleted because there are one or more invoices associated with itEngagementEmptyWarning - Engagement has no underlying projects. Deleting the engagement is recommended.