| Info |
|---|
We recommend using the newer version of this request PwsSaveProjectTaskTypes. |
Overview
This web service deletes a specified project task type (PwsProjectTaskTypeRef) and returns the identity of the deleted project task type (PwsProjectTaskTypeRef).
Request Format
| Panel | ||
|---|---|---|
| ||
|
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
RequestId | Int32 |
No |
Click here for more information. |
SessionTicket | String |
Yes |
Click here for more information. |
AZ2QD+hg1Hm7vSa7Y3Lm3w== | |
InactivateIfInuseFlag | Boolean |
EngagementTimestamp
String
No |
ProjectTaskTypeIdentity
Yes
StealLockFlag
Boolean
false | If set to 'true' and this task type is in use (associated with a task), this request will set the task type to inactive instead of deleting it; if set to 'false', this request will fail if the task type is in use. | false | |||
ProjectTaskTypeIdentity | Yes | This is the identity of the project task type to be deleted. Click here for more information. | |||
StealLockFlag | Boolean | **deprecated** | |||
EngagementTimestamp | String | **deprecated** | |||
| 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. | ||
| ProjectTaskTypeTimestamp | String | No | 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. | ||
| 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)
| 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:PwsDeleteProjectTaskType> <pws:serviceRequest> <req:SessionTicket>AZ2QD+hg1Hm7vSa7Y3Lm3w==</req:SessionTicket> <sch:InactivateIfInuseFlag>true</sch:InactivateIfInuseFlag> <sch:ProjectTaskTypeIdentity> <com:ProjectTaskTypeUid>1152921504608111306</com:ProjectTaskTypeUid> </sch:ProjectTaskTypeIdentity> <sch:StealLockFlag>true</sch:StealLockFlag> </pws:serviceRequest> </pws:PwsDeleteProjectTaskType> </soapenv:Body> </soapenv:Envelope> |
Response Format
| Panel | ||
|---|---|---|
| ||
|
Response Elements
Element | Data Type |
|---|
Required?
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 |
Click here for more information. |
Ok | |
ServerTimestampUtc | DateTime |
Click here for more information. |
2018-02-28T20:15:05.2972291Z | |
ProjectTaskTypeIdentity |
LockStolenFromUserIdentity
This is the identity of the project task type that was deleted. Click here for more information. | |
EngagementTimestamp | String |
**deprecated** | |||
LockStolenFromUserIdentity | **deprecated** | ||
| ProjectTaskTypeTimestamp | 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. | |
| StolenLocks | PwsEntityLockSummary | 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)
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <PwsDeleteProjectTaskTypeResponse xmlns="http://projectorpsa.com/PwsProjectorServices/"> <PwsDeleteProjectTaskTypeResult 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-28T20:15:05.2972291Z</ServerTimestampUtc> <a:ProjectTaskTypeIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"> <b:ExternalSystemIdentifier i:nil="true"/> <b:ProjectTaskTypeId i:nil="true"/> <b:ProjectTaskTypeUid>1152921504608111306</b:ProjectTaskTypeUid> </a:ProjectTaskTypeIdentity> <a:EngagementTimestamp>AAAAAA+vlRE=</a:EngagementTimestamp> <a:LockStolenFromUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/> </PwsDeleteProjectTaskTypeResult> </PwsDeleteProjectTaskTypeResponse> |
PwsDeleteProjectTaskType - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
...
| ErrorNumber | ErrorCode | ErrorText | 103|
|---|---|---|---|
| 102 | TaskTypeInactivated | The project task type is in use and cannot be deleted. It was marked inactive instead. | |
| 54099 | ProjectTaskTypeAssignedToTask | This project task type cannot be deleted because it is referenced by at least one project task. |