Overview

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

...

Panel

title	PwsSaveContractLineItem Request

PwsSaveContractLineItem
- serviceRequest: PwsSaveContractLineItemRq
  - RequestId: Int32
  - SessionTicket: String
  - ContractLineItem: PwsContractLineItemDetail
  - EngagementCurrencyIdentity: PwsCurrencyRef
  - EngagementTimestamp: String **deprecated**
  - StealLockFlag: Boolean **deprecated**
  - ContractTypeClearFlag: Boolean
  - OverageProjectClearFlag: Boolean
  - NewContractLineItemCode: String (27)
  - LocksToSteal: PwsEntityLockSummary[1.100]
  - ProjectorLockSetId: Int32

...

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==
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 under.
EngagementTimestamp	String	deprecated
StealLockFlag	Boolean	deprecated
ContractTypeClearFlag	Boolean	No	false	If set to 'true', the contract type associated with the contract line item will be set to null. This is equivalent to using a 'custom' contract type.	false
OverageProjectClearFlag	Boolean	No	false	If set to 'true', the overage project associated with the contract line item will be set to null.	false
NewContractLineItemCode	String (27)	No		The new contract item code after update or create/insert.
LocksToSteal	PwsEntityLockSummary[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 part 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.
ProjectorLockSetId	Int32	No		A projector lock set id is an identifier for a group of one or more locks held as a unit.

...

Code Block

language	xml
title	Example 02 - 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:PwsSaveContractLineItem>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>Ade8vXDjCIr0kcDpdVTbCwSessionTicket>ATQ16iJ8SpUnyYfRDdqPsA==</req:SessionTicket>
            <sch:ContractLineItem>
            	<com:ContractLineItemCode>P001125-CL2<CL2-2</com:ContractLineItemCode>
               <com:ContractLineItemName>P001125-CL2 Name<-2N</com:ContractLineItemName>
               <com:EngagementIdentity>
                  <com:EngagementCode>P001125</com:EngagementCode>
               </com:EngagementIdentity>
               <com:ContractTypeIdentity>
                  <com:ContractTypeName>Time and Materials</com:ContractTypeName>
               </com:ContractTypeIdentity>
               <com:InheritPurchaseOrderNumberFlag>false</com:InheritPurchaseOrderNumberFlag>
               <com:ModelContractedHoursAndOveragesFlag>false</com:ModelContractedHoursAndOveragesFlag>
               <com:PurchaseOrderNumber>P001125-PO</com:PurchaseOrderNumber>
            </sch:ContractLineItem>
            <sch:EngagementCurrencyIdentity>
               <com:CurrencyCode>USD</com:CurrencyCode>
            </sch:EngagementCurrencyIdentity>
            <sch:ContractTypeClearFlag>false</sch:ContractTypeClearFlag>
            <sch:OverageProjectClearFlag>false</sch:OverageProjectClearFlag>
            <sch:NewContractLineItemCode>P001125-CL2-2<3</sch:NewContractLineItemCode>
         </pws:serviceRequest>   <sch:LocksToSteal>
           </pws:PwsSaveContractLineItem>    </soapenv:Body>
</soapenv:Envelope>

Response Format

Panel

title	PwsSaveContractLineItem Response

PwsSaveContractLineItemResponse
- PwsSaveContractLineItemResult: PwsSaveContractLineItemRs
  - Messages: PwsMessage []
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - ContractLineItemIdentity: PwsContractLineItemRef
  - EngagementTimestamp: String **deprecated**
  - LockStolenFromUserIdentity: PwsUserRef **deprecated**
  - ContractLineItemTimestamp: String
  - StolenLocks: PwsEntityLockSummary

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

...

Status

...

RequestStatus

...

Click here for more information

...

Ok

...

ServerTimestampUtc

...

DateTime

...

Click here for more information

...

2018-01-22T15:02:41.6835065Z

...

ContractLineItemIdentity

...

PwsContractLineItemRef

...

The unique keys used to identify the contract line item.

...

EngagementTimestamp

...

String

...

**deprecated**

...

LockStolenFromUserIdentity

...

PwsUserRef

...

**deprecated**

...

Response Usage Example(s)

Code Block

language	xml
title	Example 01 - insert
collapse	true

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsSaveContractLineItemResponse!--Zero or more repetitions:-->
               <com:PwsEntityLockSummary>
                  <!--Optional:-->
                  <com:EntityIdentity>
                     <com:EntityCode>P001125-CL2-2</com:EntityCode>
                      <com:LockType>C</com:LockType>
                  </com:EntityIdentity>
                  <!--Optional:-->
                  <com:EntityLockSummary>
                     <!--Zero or more repetitions:-->
                     <com:PwsEntityLockSummaryItem>
                        <!--Optional:-->
                        <com:LockCount>1</com:LockCount>
                        <!--Optional:-->
                        <com:LockHolderUserIdentity>
                           <!--Optional:-->
                           <com:UserDisplayName>Krakauer, Larry</com:UserDisplayName>
                           <com:UserReferenceSystemId>097</com:UserReferenceSystemId>
                        </com:LockHolderUserIdentity>
                        <!--Optional:-->
                        <com:MostRecentLockAcquisitionTimestamp>2019-01-02T15:49:16.367Z</com:MostRecentLockAcquisitionTimestamp>
                     </com:PwsEntityLockSummaryItem>
                  </com:EntityLockSummary>
               </com:PwsEntityLockSummary>
            </sch:LocksToSteal>
         </pws:serviceRequest>
      </pws:PwsSaveContractLineItem>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

Panel

title	PwsSaveContractLineItem Response

PwsSaveContractLineItemResponse
- PwsSaveContractLineItemResult: PwsSaveContractLineItemRs
  - Messages: PwsMessage []
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - ContractLineItemIdentity: PwsContractLineItemRef
  - EngagementTimestamp: String **deprecated**
  - LockStolenFromUserIdentity: PwsUserRef **deprecated**
  - ContractLineItemTimestamp: String
  - StolenLocks: PwsEntityLockSummary

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-22T15:02:41.6835065Z
ContractLineItemIdentity	PwsContractLineItemRef	The unique keys used to identify the contract line item.
EngagementTimestamp	String	deprecated
LockStolenFromUserIdentity	PwsUserRef	deprecated
ContractLineItemTimestamp	String	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.
StolenLocks	PwsEntityLockSummary	This structure contains information about the locks that were stolen in order to complete this request, Will be included only when LocksToSteal is specified in the request.

Response Usage Example(s)

Code Block

language	xml
title	Example 01 - insert
collapse	true

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsSaveContractLineItemResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsSaveContractLineItemResult 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-22T15:02:41.6835065Z</ServerTimestampUtc>
            <a:ContractLineItemIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:ContractLineItemCode>P001320-CL2</b:ContractLineItemCode>
               <b:ContractLineItemId i:nil="true"/>
               <b:ContractLineItemUid>1152921504607083624</b:ContractLineItemUid>
            </a:ContractLineItemIdentity>
            <a:EngagementTimestamp>AAAAAA9/RYg=</a:EngagementTimestamp>
            <a:LockStolenFromUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:UserDisplayName>Betty Smith</b:UserDisplayName>
               <b:UserId i:nil="true"/>
               <b:UserReferenceSystemId>Partner - 01</b:UserReferenceSystemId>
               <b:UserUid>1152921504607011056</b:UserUid>
            </a:LockStolenFromUserIdentity>
         </PwsSaveContractLineItemResult>
      </PwsSaveContractLineItemResponse>
   </s:Body>
</s:Envelope>

Code Block

language	xml
title	Example 02 - update
collapse	true

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsSaveContractLineItemResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsSaveContractLineItemResult 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/PwsProjectorServicesCommonServices/">>1</ResponseId>
            <PwsSaveContractLineItemResult<Status xmlns:a="http://projectorpsa.com/DataContractsCommonServices/Shared/Scheduling/" xmlns:i">Ok</Status>
            <ServerTimestampUtc xmlns="http://www.w3.org/2001/XMLSchema-instance">projectorpsa.com/CommonServices/">2019-01-02T16:00:21.6805087Z</ServerTimestampUtc>
            <Messages xmlns="http://projectorpsa.com/CommonServices/"<a:ContractLineItemIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>>
               <b:ContractLineItemCode>P001125-CL2-3</b:ContractLineItemCode>
               <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId><b:ContractLineItemId i:nil="true"/>
              <Status xmlns="http<b:ContractLineItemUid>1152921504607095669<//projectorpsa.com/CommonServices/">Ok</Status>b:ContractLineItemUid>
            </a:ContractLineItemIdentity>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-01-22T15:02:41.6835065Z</ServerTimestampUtc><a:EngagementTimestamp>AAAAABFSqY4=</a:EngagementTimestamp>
            <a:ContractLineItemIdentityLockStolenFromUserIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:ContractLineItemCode>P001320-CL2<UserDisplayName>Krakauer, Larry</b:ContractLineItemCode>UserDisplayName>
               <b:ContractLineItemIdUserId i:nil="true"/>
               <b:UserReferenceSystemId>097</b:UserReferenceSystemId>
               <b:ContractLineItemUid>1152921504607083624<UserUid>1152921504606944254</b:ContractLineItemUid>UserUid>
            </a:ContractLineItemIdentity>LockStolenFromUserIdentity>
            <a:EngagementTimestamp>AAAAAA9/RYgContractLineItemTimestamp>AAAAABGd2U8=</a:EngagementTimestamp>ContractLineItemTimestamp>
            <a:LockStolenFromUserIdentityStolenLocks xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:UserDisplayName>Betty Smith<EntityIdentity>
                  <b:EntityCode>P001125-CL2-2</b:UserDisplayName>EntityCode>
                  <b:UserIdEntityId i:nil="true"/>
               <b:UserReferenceSystemId>Partner  - 01<<b:EntityUid>1152921504607095669</b:UserReferenceSystemId>EntityUid>
                  <b:UserUid>1152921504607011056<LockType>C</b:UserUid>LockType>
               </a:LockStolenFromUserIdentity>b:EntityIdentity>
            </PwsSaveContractLineItemResult>   <b:EntityLockSummary>
   </PwsSaveContractLineItemResponse>    </s:Body> </s:Envelope>

Code Block

language	xml
title	Example 02 - update
collapse	true

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">          <s:Body><b:PwsEntityLockSummaryItem>
         <PwsSaveContractLineItemResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">          <PwsSaveContractLineItemResult xmlns:a="http://projectorpsa.com/DataContracts/Shared/Scheduling/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"><b:LockCount>1</b:LockCount>
              <Messages xmlns="http://projectorpsa.com/CommonServices/" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>     <b:LockHolderUserIdentity>
       <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>               <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
  <b:UserDisplayName>Krakauer, Larry</b:UserDisplayName>
          <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-11-12T16:27:41.3088062Z</ServerTimestampUtc>             <a<b:ContractLineItemIdentityUserId xmlnsi:bnil="http://projectorpsa.com/DataContracts/Shared/Common/">
    "true"/>
          <b:ContractLineItemCode>P001125-CL2-2</b:ContractLineItemCode>                 <b:ContractLineItemId i:nil="true"/>:UserReferenceSystemId>097</b:UserReferenceSystemId>
                        <b:ContractLineItemUid>1152921504607095669<UserUid>1152921504606944254</b:ContractLineItemUid>UserUid>
             </a:ContractLineItemIdentity>        </b:LockHolderUserIdentity>
    <a:EngagementTimestamp>AAAAABE+AqI=</a:EngagementTimestamp>                <a:LockStolenFromUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/><b:MostRecentLockAcquisitionTimestamp>2019-01-02T15:49:16.367Z</b:MostRecentLockAcquisitionTimestamp>
                  <a:ContractLineItemTimestamp>AAAAABFCno4=</ab:ContractLineItemTimestamp>PwsEntityLockSummaryItem>
             <a:StolenLocks i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> </b:EntityLockSummary>
            </a:StolenLocks>
         </PwsSaveContractLineItemResult>
      </PwsSaveContractLineItemResponse>
   </s:Body>
</s:Envelope>

...

Versions Compared

Old Version 35

New Version 36

Key

Overview

Response Format

Response Elements

Response Usage Example(s)

Response Format

Response Elements

Response Usage Example(s)

Page Comparison

Versions Compared

Old Version 35

New Version 36

Key

Response Format

Response Elements

Response Usage Example(s)

Response Format

Response Elements

Response Usage Example(s)