Versions Compared

Key

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

...


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

The date the contract line item milestone was achieved

false

ContractLineItemMilestone

PwsContractLineItemMilestoneDetail

Yes


The detailed contract line item milestone information to be inserted or updated. Click here for more information.


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. Click here for more information.


EngagementTimestamp

String

No


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


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

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>

...

Panel
titlePwsSaveContractLineItemMilestone Response

Response Elements


Element

Data Type

Description

Sample Data

Messages

PwsMessage

 

 



ResponseId

Int32

Click here for more information.

 


Status

RequestStatus

Click here for more information.

 


ServerTimestampUtc

DateTime

Click here for more information.

 


ContractLineItemMilestoneIdentity

PwsContractLineItemMilestoneRef

 

 



EngagementTimestamp

String

 

 



LockStolenFromUserIdentity

PwsUserRef

 

 



Response Usage Example(s)

...