Overview

This web service deletes a specified contract line item milestone (PwsContractLineItemMilestoneRef). The service will return the identity of the deleted contract line item milestone (PwsContractLineItemMilestoneRef).

Request Format

PwsDeleteContractLineItemMilestone Request

PwsDeleteContractLineItemMilestone
- serviceRequest: PwsDeleteContractLineItemMilestoneRq
  - RequestId: Int32
  - SessionTicket: String
  - ContractLineItemMilestoneIdentity: PwsContractLineItemMilestoneRef
  - EngagementTimestamp: String **deprecated**
  - StealLockFlag: Boolean **deprecated**
  - ContractLineItemTimestamp: String
  - LocksToSteal: PwsEntityLockSummary[1.100]
  - ProjectorLockSetId: Int32

Request Elements

Element	Data Type	Required?	Description	Sample Data
RequestId	Int32	No	Click here for more information	1
SessionTicket	String	Yes	Click here for more information	AdDMw48w49OxnEUPGUuMSw==
ContractLineItemMilestoneIdentity	PwsContractLineItemMilestoneRef	Yes	This is the identity of the contract line item milestone to be deleted
EngagementTimestamp	String	deprecated
StealLockFlag	Boolean	deprecated
ContractLineItemTimestamp	String	No	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.	AAAAABFFCOw=
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.
ProjectorLockSetId	Int32	No	A projector lock set id is an identifier for a group of one or more locks held as a unit. If the session ticket owner for this request is also the holder of a lock in this set, the response will succeed.

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:PwsDeleteContractLineItemMilestone>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AdDMw48w49OxnEUPGUuMSw==</req:SessionTicket>
            <sch:ContractLineItemMilestoneIdentity>
               <com:ContractLineItemMilestoneUid>1152921504607106677</com:ContractLineItemMilestoneUid>
            </sch:ContractLineItemMilestoneIdentity>
            <sch:StealLockFlag>true</sch:StealLockFlag>
         </pws:serviceRequest>
      </pws:PwsDeleteContractLineItemMilestone>
   </soapenv:Body>
</soapenv:Envelope>

Example 02 - lock stolen

<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:PwsDeleteContractLineItemMilestone>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AbbTlJfDgGMtPjjdQCy/MQ==</req:SessionTicket>
            <sch:ContractLineItemMilestoneIdentity>
               <com:ContractLineItemMilestoneUid>1152921504607122896</com:ContractLineItemMilestoneUid>
            </sch:ContractLineItemMilestoneIdentity>
            <sch:StealLockFlag>false</sch:StealLockFlag>
            <sch:LocksToSteal>
               <com:PwsEntityLockSummary>
                  <com:EntityIdentity>
                     <com:EntityCode>P001125-CL1</com:EntityCode>
                     <com:EntityUid>1152921504607095656</com:EntityUid>
                     <com:LockType>C</com:LockType>
                  </com:EntityIdentity>
                  <com:EntityLockSummary>
                     <com:PwsEntityLockSummaryItem>
                        <com:LockCount>1</com:LockCount>
                        <com:LockHolderUserIdentity>
                           <com:UserUid>1152921504606944261</com:UserUid>
                        </com:LockHolderUserIdentity>
                        <com:MostRecentLockAcquisitionTimestamp>2019-01-09T20:00:23.147Z</com:MostRecentLockAcquisitionTimestamp>
                     </com:PwsEntityLockSummaryItem>
                  </com:EntityLockSummary>
               </com:PwsEntityLockSummary>
            </sch:LocksToSteal>            
         </pws:serviceRequest>
      </pws:PwsDeleteContractLineItemMilestone>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsDeleteContractLineItemMilestone Response

PwsDeleteContractLineItemMilestoneResponse
- PwsDeleteContractLineItemMilestoneResult: PwsDeleteContractLineItemMilestoneRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - ContractLineItemMilestoneIdentity: PwsContractLineItemMilestoneRef
  - EngagementTimestamp: String **deprecated**
  - LockStolenFromUserIdentity: PwsUserRef **deprecated**
  - ContractLineItemTimestamp: String
  - StolenLocks: PwsEntityLockSummary

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-22T20:26:16.4306882Z
ContractLineItemMilestoneIdentity	PwsContractLineItemMilestoneRef	The identity of the deleted contract line item milestone
EngagementTimestamp	String	deprecated
LockStolenFromUserIdentity	PwsUserRef	deprecated
ContractLineItemTimestamp	String	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.	AAAAABFFCOw=
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)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsDeleteContractLineItemMilestoneResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsDeleteContractLineItemMilestoneResult 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-22T20:26:16.4306882Z</ServerTimestampUtc>
            <a:ContractLineItemMilestoneIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:ContractLineItemMilestoneId i:nil="true"/>
               <b:ContractLineItemMilestoneUid>1152921504607106677</b:ContractLineItemMilestoneUid>
            </a:ContractLineItemMilestoneIdentity>
            <a:EngagementTimestamp>AAAAAA+AA4E=</a:EngagementTimestamp>
            <a:LockStolenFromUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
         </PwsDeleteContractLineItemMilestoneResult>
      </PwsDeleteContractLineItemMilestoneResponse>
   </s:Body>
</s:Envelope>

Example 02 - lock stolen

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsDeleteContractLineItemMilestoneResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsDeleteContractLineItemMilestoneResult 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/">2019-01-09T20:03:39.9099733Z</ServerTimestampUtc>
            <a:ContractLineItemMilestoneIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:ContractLineItemMilestoneId i:nil="true"/>
               <b:ContractLineItemMilestoneUid>1152921504607122896</b:ContractLineItemMilestoneUid>
            </a:ContractLineItemMilestoneIdentity>
            <a:EngagementTimestamp>AAAAABGuIhI=</a:EngagementTimestamp>
            <a:LockStolenFromUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:UserDisplayName>PPSA Support User</b:UserDisplayName>
               <b:UserId i:nil="true"/>
               <b:UserReferenceSystemId>000</b:UserReferenceSystemId>
               <b:UserUid>1152921504606944261</b:UserUid>
            </a:LockStolenFromUserIdentity>
            <a:ContractLineItemTimestamp>AAAAABGuIhM=</a:ContractLineItemTimestamp>
            <a:StolenLocks xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:EntityIdentity>
                  <b:EntityCode>P001125-CL1</b:EntityCode>
                  <b:EntityId i:nil="true"/>
                  <b:EntityUid>1152921504607095656</b:EntityUid>
                  <b:LockType>C</b:LockType>
               </b:EntityIdentity>
               <b:EntityLockSummary>
                  <b:PwsEntityLockSummaryItem>
                     <b:LockCount>1</b:LockCount>
                     <b:LockHolderUserIdentity>
                        <b:UserDisplayName>PPSA Support User</b:UserDisplayName>
                        <b:UserId i:nil="true"/>
                        <b:UserReferenceSystemId>000</b:UserReferenceSystemId>
                        <b:UserUid>1152921504606944261</b:UserUid>
                     </b:LockHolderUserIdentity>
                     <b:MostRecentLockAcquisitionTimestamp>2019-01-09T20:00:23.147Z</b:MostRecentLockAcquisitionTimestamp>
                  </b:PwsEntityLockSummaryItem>
               </b:EntityLockSummary>
            </a:StolenLocks>
         </PwsDeleteContractLineItemMilestoneResult>
      </PwsDeleteContractLineItemMilestoneResponse>
   </s:Body>
</s:Envelope>

PwsDeleteContractLineItemMilestone - Common Errors and Warnings

For all errors and warnings please refer to the Complete List of Errors and Warnings

Error Number	ErrorCode	ErrorText
105	AtLeastOneItemNotFound	At least one requested item was not found. The remaining items, if any, were returned.
50024	EntityNotFound	Entity PwsContractLineItemMilestoneRef was not found.
50469	EntityAlreadyLocked	One or more existing locks prevent acquisition of requested lock.
50472	LockReleased	Lock xxxxx of type P has been released.
50473	InvalidLock	Invalid lock specified.
54233	NoPermissionToDeleteContractLineItem	You do not have permission to delete this contract line item.
54247	CannotDeleteInvoicedOrAchievedMilestones	A contract line item milestone may not be deleted if it contains invoiced or achieved milestones.
54260	ContractLineItemMilestoneNotFound	Specified contract line item milestone not found.