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

title	PwsSaveContractLineItemMilestone Request

PwsSaveContractLineItemMilestone
- serviceRequest: PwsSaveContractLineItemMilestoneRq
  - RequestId: Int32
  - SessionTicket: String
  - AchievedDateClearFlag: Boolean
  - ContractLineItemMilestone: PwsContractLineItemMilestoneDetail
  - DescriptionClearFlag: Boolean
  - EngagementCurrencyIdentity: PwsCurrencyRef
  - EngagementTimestamp: String
  - PlannedDateClearFlag: Boolean
  - ProjectClearFlag: Boolean
  - ProjectTaskClearFlag: Boolean
  - StealLockFlag: Boolean

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==
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

language	xml
title	Example 01 - insert - not associated with a project
collapse	true

<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>

Code Block

language	xml
title	Example 02 - insert - associated with a project and task
collapse	true

<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:Description>Milestone 1</com:Description>
               <com:ForegoneFlag>false</com:ForegoneFlag>
               <com:ProjectIdentity>
                  <com:ProjectCode>P001320-004</com:ProjectCode>
               </com:ProjectIdentity>
               <com:ProjectTaskIdentity>
                  <com:ProjectTaskUid>1152921504608716773</com:ProjectTaskUid>
               </com:ProjectTaskIdentity>
            </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>

Code Block

language	xml
title	Example 03 - update
collapse	true

<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:ContractLineItemMilestoneUid>1152921504607106677</com:ContractLineItemMilestoneUid>
               <com:ContractLineItemIdentity>
                  <com:ContractLineItemCode>P001320-CL8</com:ContractLineItemCode>
               </com:ContractLineItemIdentity>
               <com:ContractLineItemMilestoneName>P001320-CL8-M2</com:ContractLineItemMilestoneName>
               <com:MilestoneAmount>2000.00</com:MilestoneAmount>
               <com:Description>Milestone 1A</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>

Response Format

Panel

title	PwsSaveContractLineItemMilestone Response

PwsSaveContractLineItemMilestoneResponse
- PwsSaveContractLineItemMilestoneResult: PwsSaveContractLineItemMilestoneRs
  - Messages: PwsMessage
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - ContractLineItemMilestoneIdentity: PwsContractLineItemMilestoneRef
  - 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.	1
Status	RequestStatus	Click here for more information.	Ok
ServerTimestampUtc	DateTime	Click here for more information.	2018-01-22T19:30:03.4141326Z
ContractLineItemMilestoneIdentity	PwsContractLineItemMilestoneRef	The unique keys used to identify the contract line item milestone
EngagementTimestamp	String	This is a Base64 encoded timestamp utilized for engagement locking. For internal use only.	AAAAAA9/798=
LockStolenFromUserIdentity	PwsUserRef	If a lock is stolen in the process of updating an engagement, this identifies the user from which the lock was stolen from. Click here for more information.

Response Usage Example(s)

Code Block

language	xml
title	Example 01
collapse	true

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsSaveContractLineItemMilestoneResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsSaveContractLineItemMilestoneResult 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-22T19:30:03.4141326Z</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>AAAAAA9/798=</a:EngagementTimestamp>
            <a:LockStolenFromUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
         </PwsSaveContractLineItemMilestoneResult>
      </PwsSaveContractLineItemMilestoneResponse>
   </s:Body>
</s:Envelope>

PwsSaveContractLineItemMilestone - Common Errors and Warnings

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

Version	Old Version 12	New Version 13
Changes made by	Bettina Borces	Bettina Borces
Saved on	Jan 22, 2018	Jan 22, 2018

Versions Compared

Key

Overview

Request Format

Request Elements

Usage Example(s)

Response Format

Response Elements

Response Usage Example(s)

PwsSaveContractLineItemMilestone - Common Errors and Warnings

Page Comparison

Versions Compared

Key

Overview

Request Format

Request Elements

Usage Example(s)

Response Format

Response Elements

Response Usage Example(s)

PwsSaveContractLineItemMilestone - Common Errors and Warnings