...
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
RequestId | Int32 | Click here for more information. | |||
SessionTicket | String | Yes | Click here for more information. | ||
InactivateIfInuseFlag | Boolean | No | false | If In the case that this task type is in use (associated with a task), if set to 'true', this request will set the task type to inactive; if set to 'false', this request will fail. | false |
ProjectTaskTypeIdentity | Yes | This is the identity of the project task type 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: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 | ||
|---|---|---|
| ||
|
...
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. | 2018-02-28T20:15:05.2972291Z |
ProjectTaskTypeIdentity | This is the identity of the project task type that was deleted. Click here for more information. | ||
EngagementTimestamp | String | See EngagementTimestamp above in Request Elements table | AAAAAA+vlRE= |
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> <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/"> <b:PwsMessage> <b:AdditionalErrorText>Warning 102: {oldestSurvivingTimeCardWorkDateString}</b:AdditionalErrorText> <b:ErrorCode>TaskTypeInactivated</b:ErrorCode> <b:ErrorNumber>102</b:ErrorNumber> <b:ErrorText>The project task type is in use and cannot be deleted. It was marked inactive instead.</b:ErrorText> <b:Type>Warning</b:Type> </b:PwsMessage> </Messages> <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> |
Common Errors and Warnings
...