Versions Compared

Key

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

Overview


This web service inserts or updates a single client based on a detailed contract line item structure (PwsContractLineItemDetail). The service returns the identity (PwsClientRef) of the client that has been inserted or updated. The caller can optionally request that the full client detail (PwsClientDetail) be included in the response.

Request Format


Panel
titlePwsSaveContractLineItem Request

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.


ContractLineItem

PwsContractLineItemDetail

Yes 


The detailed contract line item information to be inserted or updated 


EngagementCurrencyIdentity

PwsCurrencyRef

Yes 


The currency of the engagement this contract line item resides udner


EngagementTimestamp

String

No 


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


StealLockFlag

Boolean

Yes 

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 


ContractTypeClearFlag

Boolean

Yes 

false 

If set to 'true', the contract type associated with the contract line item will be set to null


OverageProjectClearFlag

Boolean

Yes 

false 

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


Request Usage Example(s)


Code Block
languagexml
titleExample 01
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:PwsSaveContractLineItem>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AdDMw48w49OxnEUPGUuMSw==</req:SessionTicket>
            <sch:ContractLineItem>
               <com:ContractLineItemName>Phase 2</com:ContractLineItemName>
               <com:EngagementIdentity>
                  <com:EngagementCode>P001320</com:EngagementCode>
               </com:EngagementIdentity>
               <com:HoldbackAmount>5000</com:HoldbackAmount>
               <com:HoldbackType>A</com:HoldbackType>
               <com:MaxTimeContractAmount>50000</com:MaxTimeContractAmount>
               <com:MinTimeContractAmount>50000</com:MinTimeContractAmount>
               <com:RevenueEarnedByDate>2017-06-30T00:00:00.000Z</com:RevenueEarnedByDate>
               <com:RevenueRecognitionMethod>P</com:RevenueRecognitionMethod>
               <com:ContractTypeIdentity>
                  <com:ContractTypeName>Fixed Price Plus Expenses</com:ContractTypeName>
               </com:ContractTypeIdentity>
               <com:InheritPurchaseOrderNumberFlag>false</com:InheritPurchaseOrderNumberFlag>
               <com:ModelContractedHoursAndOveragesFlag>false</com:ModelContractedHoursAndOveragesFlag>
               <com:PurchaseOrderNumber>WS1320-P1</com:PurchaseOrderNumber>
            </sch:ContractLineItem>
            <sch:EngagementCurrencyIdentity>
               <com:CurrencyCode>USD</com:CurrencyCode>
            </sch:EngagementCurrencyIdentity>
            <sch:StealLockFlag>true</sch:StealLockFlag>
            <sch:ContractTypeClearFlag>false</sch:ContractTypeClearFlag>
            <sch:OverageProjectClearFlag>false</sch:OverageProjectClearFlag>
         </pws:serviceRequest>
      </pws:PwsSaveContractLineItem>
   </soapenv:Body>
</soapenv:Envelope>