Overview
This web service deletes a specified project estimate. The service will return the identity of the deleted project estimate.
If the estimate is currently identified as the active estimate for the project, the most recently created remaining estimate will be set as the new active estimate. If this was the only estimate on the project, the project will not have an active estimate.
Project estimates that are managed by a CRM integration may not be deleted using this service.
Request Format
- PwsDeleteProjectEstimateRq
- RequestId: Int32
- SessionTicket: String
- LocksToSteal: PwsEntityLockSummary
- ProjectEstimateIdentity: PwsProjectEstimateRef
- ProjectTimestamp: String
- ProjectorLockSetId: Int32
Request Elements
Element | Data Type | Required? | Default | Description |
---|---|---|---|---|
RequestId | Int32 | No | Click here for more information. | |
SessionTicket | String | Yes | Click here for more information. | |
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. | ||
ProjectEstimateIdentity | Yes | This structure represents the unique key fields associated with identifying a project estimate. | ||
ProjectTimestamp | String | No | This is an optimistic locking timestamp that, if provided, will cause the request to fail when the timestamp stored in the database does not match the provided value. | |
ProjectorLockSetId | Int32 | No | A Projector lock set id is an identifier for a group of one or more locks held as a unit. |
Request Usage Example(s)
Response Format
- PwsDeleteProjectEstimateRs
- Messages: PwsMessage
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- ProjectEstimateIdentity: PwsProjectEstimateRef
- ProjectTimestamp: String
- StolenLocks: PwsEntityLockSummary
Response Elements
Element | Data Type | Description | Sample Data |
---|---|---|---|
Messages | The web service response status and message. Click here for more information | ||
ResponseId | Int32 | Click here for more information. | 1 |
Status | Click here for more information. | Ok | |
ServerTimestampUtc | DateTime | Click here for more information. | 2022-07-25T20:27:24.9852584Z |
ProjectEstimateIdentity | The identity of the estimate that was deleted. | ||
ProjectTimestamp | String | This is the new timestamp (for optimistic locking) of the project that contained the estimate that was deleted. | AAAAABxnRNk= |
StolenLocks | PwsEntityLockSummary [1..100] | 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)
PwsDeleteProjectEstimate - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings