Overview
This structure represents the results of Save changes to a project estimate insertion or update. This operation can partially succeed, meaning some estimates were successfully saved while others triggered errors and could not be saved. The web service will report back details about each estimate, whether it succeeded or failed, by returning a collection of these structures. For failed estimates, ErrorDetail will provide more details about the nature of the failurecreate a new project estimate.
Estimates must have at least one line item, and as of now, may only have a single line item. Estimates that are managed by a CRM integration may not be modified by this service. Caller must have permission to update the project in order to add or update estimates.
Request Format
| Panel | ||
|---|---|---|
| ||
|
...
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
Int32 | No | Click here for more information. | 1 | ||
String | Yes | Click here for more information. | AaonOqOoU2Gb8IbysO8KXQ== | ||
FullDetailFlag | Boolean | No | false | If set to true, include full detailed project estimate element PwsProjectEstimateElement in response. | true |
LocksToSteal | 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. | |||
ProjectEstimate | Yes | This structure contains the complete set of information about a project estimate. | |||
ProjectTimestamp | String | No | This is an optimistic locking timestamp that, if provided on update request, will cause the request to fail when if the timestamp stored in the database does not match the provided value. | ||
ProjectorLockSetId | Int32 | No | If stealing existing locks, specify lock holders from PwsFault response. | ||
SetActiveEstimateFlag | Boolean | No | false | If set to true the estimate will be set us the active estimate on the projectthe estimate will be set to the active estimate for the project. A project may only have one active estimate, so this may result in removing this designation from another estimate. If a project has any estimates at all, one must be designated active. Therefore, if saving the first estimate on a project, it will become the active estimate, regardless of this setting. | true |
Request Usage Example(s)
...
Element | Data Type | Description | |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
Int32 | Click here for more information | 1 | |
Status | Click here for more information. | Ok | |
| ServerTimestampUtc | DateTime | Click here for more information | 2022-07-25T20:17:05.545186Z |
ProjectEstimate | This structure contains a project estimate detail structure (PwsProjectEstimateDetail). It is also where additional related information about the project estimate, that is not directly an attribute of the project estimate itself would be found. This will only be populated if FullDetailFlag was specified on input. | ||
ProjectEstimateIdentity | This structure represents the unique key fields associated with identifying a project estimate. | ||
ProjectTimestamp | 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. This will reflect that the estimate was updated as part of this request (it should differ from the timestamp provided on input (if any), or from the timestamp returned by a prior web service request. | AAAAABxnQ9o= |
StolenLocks | 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)
...