Versions Compared

Version Old Version 22 New Version 23
Changes made by

Luke Wright

Min Zeng

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

This web service inserts or updates a single contract line item milestone based on a detailed contract line item milestone structure (PwsContractLineItemMilestoneDetail). The service returns the identity (PwsContractLineItemMilestoneRef) of the contract line item milestone that has been inserted or updated. 

Request Format

Panel
titlePwsSaveContractLineItemMilestone Request
  • PwsSaveContractLineItemMilestone
    • serviceRequest: PwsSaveContractLineItemMilestoneRq

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.

...

AdDMw48w49OxnEUPGUuMSw==

...

Overview


This web service inserts or updates a single contract line item milestone based on a detailed contract line item milestone structure (PwsContractLineItemMilestoneDetail). The service returns the identity (PwsContractLineItemMilestoneRef) of the contract line item milestone that has been inserted or updated. 

Request Format


Panel
titlePwsSaveContractLineItemMilestone Request
  • PwsSaveContractLineItemMilestone

Request Elements


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 PwsGetContractLineItem (or a prior call to PwsSaveContractLineItemMilestone). This will cause the request to fail if any change has been made between invocations of PwsGetContractLineItemand PwsSaveContractLineItemMilestone.

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.

AdDMw48w49OxnEUPGUuMSw==

AchievedDateClearFlag

Boolean

No

false

If 'true', the milestone's achieved date will be cleared.

false

ContractLineItemMilestone

PwsContractLineItemMilestoneDetail

Yes


The detailed contract line item milestone information to be inserted or updated.


DescriptionClearFlag

Boolean

No

false

If set to 'true', the contract line item milestone description will be set to null.

false

EngagementCurrencyIdentity

PwsCurrencyRef

Yes


The currency of the engagement this contract line item milestone resides under.


EngagementTimestamp

String

**deprecated**




PlannedDateClearFlag

Boolean

No

false

If set to 'true', the milestone 's achieved planned date will be clearedset to null.

false

ContractLineItemMilestoneProjectClearFlag

Boolean

PwsContractLineItemMilestoneDetailNo

Yes

The detailed false

If set to 'true', the project associated with the contract line item milestone information to be inserted or updated.DescriptionClearFlagwill be set to null.

false

ProjectTaskClearFlag

Boolean

No

false

If set to 'true', the project task associated with the contract line item milestone description will be set to null.

false

EngagementCurrencyIdentity

PwsCurrencyRef

Yes

The currency of the engagement this contract line item milestone resides under.

EngagementTimestamp

String

No

PlannedDateClearFlag

Boolean

No

false

If set to 'true', the milestone planned date will be set to null.

false

ProjectClearFlag

Boolean

No

false

If set to 'true', the project associated with the contract line item milestone will be set to null.

false

ProjectTaskClearFlag

Boolean

No

false

If set to 'true', the project task associated with the contract line item milestone will be set to null.

false

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

StealLockFlag

Boolean

**deprecated**




ContractLineItemTimestampStringNo
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.
LocksToStealPwsEntityLockSummary[1.100]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.
ProjectorLockSetIdInt32No
A projector lock set id is an identifier for a group of one or more locks held as a unit.

Request Usage Example(s)


Code Block
languagexml
titleExample 01 - insert - not associated with a project
collapsetrue
<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:PwsSaveContractLineItemMilestone>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AdDMw48w49OxnEUPGUuMSw==</req:SessionTicket>
            <sch:AchievedDateClearFlag>false</sch:AchievedDateClearFlag>
            <sch:ContractLineItemMilestone>
               <com:ContractLineItemIdentity>
                  <com:ContractLineItemCode>P001320-CL8</com:ContractLineItemCode>
               </com:ContractLineItemIdentity>
               <com:ContractLineItemMilestoneName>P001320-CL8-M1</com:ContractLineItemMilestoneName>
               <com:MilestoneAmount>1551.50</com:MilestoneAmount>
               <com:PlannedDate>2018-01-30T00:00:00.000Z</com:PlannedDate>
               <com:Description>Milestone 1</com:Description>
               <com:ForegoneFlag>false</com:ForegoneFlag>
            </sch:ContractLineItemMilestone>
            <sch:DescriptionClearFlag>false</sch:DescriptionClearFlag>
            <sch:EngagementCurrencyIdentity>
               <com:CurrencyCode>USD</com:CurrencyCode>
            </sch:EngagementCurrencyIdentity>
            <sch:PlannedDateClearFlag>false</sch:PlannedDateClearFlag>
            <sch:ProjectClearFlag>false</sch:ProjectClearFlag>
            <sch:ProjectTaskClearFlag>false</sch:ProjectTaskClearFlag>
            <sch:StealLockFlag>true</sch:StealLockFlag>
         </pws:serviceRequest>
      </pws:PwsSaveContractLineItemMilestone>
   </soapenv:Body>
</soapenv:Envelope>

...