Overview

This web service deletes a specified contract line item (PwsContractLineItemRef). The service will return the identity of the deleted contract line item (PwsContractLineItemRef). Note, contract line items that are associated with one or more projects cannot be deleted.

Request Format

PwsDeleteContractLineItem Request

PwsDeleteContractLineItem
- serviceRequest: PwsDeleteContractLineItemRq
  - RequestId: Int32
  - SessionTicket: String
  - ContractLineItemIdentity: PwsContractLineItemRef
  - EngagementTimestamp: String
  - StealLockFlag: Boolean

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.	ARKG+qjBuMq+YMu7gEYnoA==
ContractLineItemIdentity	PwsContractLineItemRef	Yes		This is the identity of the contract line item to be deleted
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 PwsGetEngagement. This will cause the request to fail if any change has been made between invocations of PwsGetEngagement and PwsDeleteContractLineItem.
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

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:PwsDeleteContractLineItem>
         <pws:serviceRequest>
            <req:SessionTicket>ARKG+qjBuMq+YMu7gEYnoA==</req:SessionTicket>
            <sch:ContractLineItemIdentity>
               <com:ContractLineItemCode>P001320-CL10</com:ContractLineItemCode>
            </sch:ContractLineItemIdentity>
            <sch:StealLockFlag>true</sch:StealLockFlag>
         </pws:serviceRequest>
      </pws:PwsDeleteContractLineItem>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsDeleteContractLineItem Response

PwsDeleteContractLineItemResponse
- PwsDeleteContractLineItemResult: PwsDeleteContractLineItemRs
  - Messages: PwsMessage[]
  - ResponseId: Int32
  - RequestStatus: RequestStatus
  - ServerTimestampUtc: DateTime
  - ContractLineItemIdentity: PwsContractLineItemRef
  - 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.	0
Status	RequestStatus	Click here for more information.	Ok
ServerTimestampUtc	DateTime	Click here for more information.	2018-01-23T18:23:31.9905096Z
ContractLineItemIdentity	PwsContractLineItemRef	The identity of the deleted contract line item
EngagementTimestamp	String	This is a Base64 encoded timestamp utilized for engagement locking.	AAAAAA+AxuM=
LockStolenFromUserIdentity	PwsUserRef	If a lock is stolen in the process of deleteing the contract line item, this identifies the user from which the lock was stolen from. Click here for more information.

Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsDeleteContractLineItemResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsDeleteContractLineItemResult 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/">0</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-01-23T18:23:31.9905096Z</ServerTimestampUtc>
            <a:ContractLineItemIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:ContractLineItemCode>P001320-CL10</b:ContractLineItemCode>
               <b:ContractLineItemId i:nil="true"/>
               <b:ContractLineItemUid>1152921504607083717</b:ContractLineItemUid>
            </a:ContractLineItemIdentity>
            <a:EngagementTimestamp>AAAAAA+AxuM=</a:EngagementTimestamp>
            <a:LockStolenFromUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
         </PwsDeleteContractLineItemResult>
      </PwsDeleteContractLineItemResponse>
   </s:Body>
</s:Envelope>

PwsDeleteContractLineItem - Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText
54233	NoPermissionToDeleteContractLineItem	You do not have permission to delete this contract line item.
54235	ContractLineItemContainsInvoicedOrAchievedMilestones	A contract line item may not be deleted if it contains invoiced or achieved milestones.
54948	SpecifiedContractLineItemNotFound	Specified contract line item not found.
54949	ContractLineItemMustBeSpecified	A contract line item identity must be specified.
54962	ContractLineItemInUse	A contract line item may not be deleted if it has projects related to it.