Overview

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

Request Format

PwsDeleteEngagement Request

PwsDeleteEngagement
- serviceRequest: PwsDeleteEngagementRq
  - RequestId: Int32
  - SessionTicket: String
  - EngagementIdentity: PwsEngagementRef
  - StealLockFlag: Boolean
  - EngagementTimestamp: String

Request Elements

Element	Data Type	Required?	Default	Description	Sample Data
RequestId	Int32	No		Click here for more information.	1
SessionTicket	String	Yes		Click here for more information.	AWYoWMBC/cjl/RFPrykteA==
EngagementIdentity	PwsEngagementRef	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	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.

Request Usage Example(s)

Example 01

<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>

Response Format

PwsDeleteEngagement Response

PwsDeleteEngagementResponse
- PwsDeleteEngagementResult: PwsDeleteEngagementRs
  - Messages: PwsMessage
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - EngagementIdentity: PwsEngagementRef
  - EngagementTimestamp: String
  - LockStolenFromUserIdentity: PwsUserRef

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
Status	RequestStatus	Click here for more information.	Ok
ServerTimestampUtc	DateTime	Click here for more information.	2018-01-19T19:32:35.9700152Z
EngagementIdentity	PwsEngagementRef	The identity of the deleted engagement
EngagementTimestamp	String	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.	AAAAAA99vU0=
LockStolenFromUserIdentity	PwsUserRef	If a lock is stolen in the process of updating an engagement, this identifies the user from which the lock was stolen from

Response Usage Example(s)

Example 01

<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.