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
| Panel | ||
|---|---|---|
| ||
|
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
Int32 | No | Click here for more information | 1 | ||
String | Yes | Click here for more information | AdDMw48w49OxnEUPGUuMSw== | ||
ContractLineItemMilestoneIdentity | Yes | This is the identity of the contract line item milestone 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 PwsDeleteContractLineItemMilestone. | 1152921504607106677 | |
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)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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> |
Response Format
| Panel | ||
|---|---|---|
| ||
|
Response Elements
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information | ||
ResponseId | Int32 | Click here for more information. | 1 |
Status | Click here for more information. | Ok | |
DateTime | Click here for more information. | 2018-01-22T20:26:16.4306882Z | |
ContractLineItemMilestoneIdentity | The identity of the deleted contract line item milestone | ||
EngagementTimestamp | String | This is a Base64 encoded timestamp utilized for engagement locking | AAAAAA+AA4E= |
LockStolenFromUserIdentity | 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)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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> |
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. |
| 54233 | NoPermissionToDeleteContractLineItem | You do not have permission to delete this contract line item. |
| 54260 | ContractLineItemMilestoneNotFound | Specified contract line item milestone not found. |