...
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
RequestId | Int32 | Click here for more information. | |||
SessionTicket | String | Click here for more information. | |||
CascadeDeleteFlag | Boolean | No | false | If set to 'true', deleting a parent task deletes all children tasks. If set to 'false' and there is child task, this request will fail. | true |
CloseIfInuseFlag | Boolean | No | truefalse | If set to 'true', set task to not open closed for time entry if it is already being used (ex. time reported on this task). If set to 'false' and there is reported time, this request will fail. | true |
ProjectTaskIdentity | Yes | This is the identity of the project task to be deleted. Click here for more information. | |||
StealLockFlag | Boolean | No | false | If set to 'true', any locks on the project will be stolen if it is currently locked, otherwise, if it is set to 'false' and a lock is in place the service will fail. | false |
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 in a prior response. This will cause the request to fail if any change has been made between the two invocations. |
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<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:PwsDeleteProjectTask> <pws:serviceRequest> <req:SessionTicket>AZ2QD+hg1Hm7vSa7Y3Lm3w==</req:SessionTicket> <sch:CascadeDeleteFlag>true</sch:CascadeDeleteFlag> <sch:CloseIfInuseFlag>true</sch:CloseIfInuseFlag> <sch:ProjectTaskIdentity> <com:ProjectTaskUid>1152921504608735070</com:ProjectTaskUid> </sch:ProjectTaskIdentity> <sch:StealLockFlag>true</sch:StealLockFlag> </pws:serviceRequest> </pws:PwsDeleteProjectTask> </soapenv:Body> </soapenv:Envelope> |
Response Format
| Panel | ||
|---|---|---|
| ||
|
...
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. | 0 |
Status | RequestStatus | Click here for more information. | Ok |
ServerTimestampUtc | DateTime | Click here for more information. | |
ProjectTaskIdentity | This is the identity of the project task that was deleted. Click here for more information. | ||
EngagementTimestamp | String | See EngagementTimestamp above in Request Elements table | |
LockStolenFromUserIdentity | If a lock is stolen in the process of updating an engagement, this identifies the user from which the lock was stolen from. Click here for more information. |
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <PwsDeleteProjectTaskResponse xmlns="http://projectorpsa.com/PwsProjectorServices/"> <PwsDeleteProjectTaskResult 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/">0</ResponseId> <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status> <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018-02-28T19:52:42.4283848Z</ServerTimestampUtc> <a:ProjectTaskIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:ExternalSystemIdentifier i:nil="true"/> <b:ProjectTaskId i:nil="true"/> <b:ProjectTaskUid>1152921504608735070</b:ProjectTaskUid> </a:ProjectTaskIdentity> <a:EngagementTimestamp>AAAAAA+vif4=</a:EngagementTimestamp> <a:LockStolenFromUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> </PwsDeleteProjectTaskResult> </PwsDeleteProjectTaskResponse> </s:Body> </s:Envelope> |
Common Errors and Warnings
...
| ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 103 | TaskClosed | The project task is in use and cannot be deleted. It was closed for time instead. |
| 54201 | TaskHasTimeReported | This project task cannot be deleted because time has been reported against it or there has been invoicing activity involving the project. |
| 54202 | TaskHasChildTasks | This project task cannot be deleted because it has child tasks. Specify CascadeDeleteFlag to recursively delete child tasks. |
...