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.

Rate Limiting

In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm. When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate. Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly. For more information please visit: Projector Rate Limiting Behavior.

Request Format

PwsDeleteProjectEstimateRq

PwsDeleteProjectEstimateRq
- RequestId: Int32
- SessionTicket: String
- LocksToSteal: PwsEntityLockSummary
- ProjectEstimateIdentity: PwsProjectEstimateRef
- ProjectTimestamp: String
- ProjectorLockSetId: Int32

Request Elements

Element	Data Type	Required?	Description
RequestId	Int32	No	Click here for more information.
SessionTicket	String	Yes	Click here for more information.
LocksToSteal	PwsEntityLockSummary	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	PwsProjectEstimateRef	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)

Request Example

<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:PwsDeleteProjectEstimate>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>ASi0NoKANuaG9Enyvoo2QA==</req:SessionTicket>
            <sch:ProjectEstimateIdentity>
               <com:ProjectEstimateUid>1152921504606862535</com:ProjectEstimateUid>
               <com:ProjectIdentity>
                  <com:ProjectUid>1152921504607496128</com:ProjectUid>
               </com:ProjectIdentity>
            </sch:ProjectEstimateIdentity>
         </pws:serviceRequest>
      </pws:PwsDeleteProjectEstimate>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsDeleteProjectEstimateRs

PwsDeleteProjectEstimateRs
- Messages: PwsMessage
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- ProjectEstimateIdentity: PwsProjectEstimateRef
- ProjectTimestamp: 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.	2022-07-25T20:27:24.9852584Z
ProjectEstimateIdentity	PwsProjectEstimateRef	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)

Response Example

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsDeleteProjectEstimateResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsDeleteProjectEstimateResult 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/">
               <b:PwsMessage>
                  <b:AdditionalErrorText>Message 136: This request was executed against the Development [appdev.projectorpsa.com] environment.</b:AdditionalErrorText>
                  <b:ErrorCode>NonProductionEnvironment</b:ErrorCode>
                  <b:ErrorNumber>136</b:ErrorNumber>
                  <b:ErrorText>This web service request was executed against a non-production instance of Projector.</b:ErrorText>
                  <b:Type>Information</b:Type>
                  <b:ReferenceId1 i:nil="true"/>
                  <b:ReferenceId2 i:nil="true"/>
               </b:PwsMessage>
            </Messages>
            <ResponseId xmlns="http://projectorpsa.com/CommonServices/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2022-07-25T20:27:24.9852584Z</ServerTimestampUtc>
            <a:ProjectEstimateIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:ProjectEstimateId i:nil="true"/>
               <b:ProjectEstimateName>Web Service Estimate</b:ProjectEstimateName>
               <b:ProjectEstimateUid>1152921504606862324</b:ProjectEstimateUid>
               <b:ProjectIdentity>
                  <b:ProjectCode>Model 5</b:ProjectCode>
                  <b:ProjectId i:nil="true"/>
                  <b:ProjectUid>1152921504607496128</b:ProjectUid>
               </b:ProjectIdentity>
            </a:ProjectEstimateIdentity>
            <a:ProjectTimestamp>AAAAABxnRNk=</a:ProjectTimestamp>
            <a:StolenLocks i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
         </PwsDeleteProjectEstimateResult>
      </PwsDeleteProjectEstimateResponse>
   </s:Body>
</s:Envelope>

PwsDeleteProjectEstimate - Common Errors and Warnings

For all errors and warnings please refer to the Complete List of Errors and Warnings

API Documentation

PwsDeleteProjectEstimate

Analytics