Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Overview

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

Request Format


PwsDeleteEngagement Request

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.


EngagementIdentity

PwsEngagementRef

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


EngagementTimestamp

String

No 


This is a Base64 encoded timestamp utilized for engagement locking. For internal use only.


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>
  • No labels