Versions Compared

Key

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

Overview

...

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

...

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

No 

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 PwsSaveContractLineItem). This will cause the request to fail if any change has been made between invocations of PwsGetContractLineItem and PwsSaveContractLineItem.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
NewContractLineItemCodeString (27)No
The new contract item code after update or create/insert.
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.

...

Panel
titlePwsSaveContractLineItem Response

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

This is a Base64 encoded timestamp utilized for engagement locking. To protect against overwriting other changes. See Request Elements above for more details.

AAAAAA9/RYg=

LockStolenFromUserIdentity

PwsUserRef

If a lock is stolen in the process of updating an contract line item, this identifies the user from whom the lock was stolen.**deprecated**


LockStolenFromUserIdentity

PwsUserRef

**deprecated**


Response Usage Example(s)

...