Overview

This web service deletes a specified project task role and returns the identity of the deleted project task role (PwsProjectTaskRoleRef). A project task role is the association of a role on a project with a task that the role is assigned to. Deleting a project task role is essentially removing the role from the task. The web service returns the identity of the deleted project task role (PwsProjectTaskRoleRef).

Request Format

PwsDeleteProjectTaskRoleRq

PwsDeleteProjectTaskRoleRq
- RequestId: Int32
- SessionTicket: String
- DeallocateIfInuseFlag: Boolean
- ProjectTaskRoleIdentity: PwsProjectTaskRoleRef
- StealLockFlag: Boolean **deprecated**
- EngagementTimestamp: String **deprecated**
- LocksToSteal: PwsEntityLockSummary[1.100]
- ProjectorLockSetId: Int32
- RateTaskTimestamp: String

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==
DeallocateIfInuseFlag	Boolean	No	false	Applies only to situations when time has been reported against the role and task combination. If set to 'true', the task role's effort will be zeroed out. If set to 'false', this request will fail.	false
ProjectTaskRoleIdentity	PwsProjectTaskRoleRef	Yes		This is the identity of the project task role 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.
ProjectorLockSetId	Int32	No		A projector lock set id is an identifier for a group of one or more locks held as a unit.
RateTaskTimestamp	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.

Request Usage Example(s)

Example 01

<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:PwsDeleteProjectTaskRole>
         <pws:serviceRequest>
            <req:SessionTicket>AZ2QD+hg1Hm7vSa7Y3Lm3w==</req:SessionTicket>
            <sch:DeallocateIfInuseFlag>true</sch:DeallocateIfInuseFlag>
            <sch:ProjectTaskRoleIdentity>
               <com:ProjectRoleIdentity>
                  <com:ProjectRoleUid>1152921504609594610</com:ProjectRoleUid>
               </com:ProjectRoleIdentity>
               <com:ProjectTaskIdentity>
                  <com:ProjectTaskUid>1152921504608735153</com:ProjectTaskUid>
               </com:ProjectTaskIdentity>
               <com:ProjectTaskRoleUid>1152921504608652849</com:ProjectTaskRoleUid>
            </sch:ProjectTaskRoleIdentity>
            <sch:StealLockFlag>true</sch:StealLockFlag>
         </pws:serviceRequest>
      </pws:PwsDeleteProjectTaskRole>
   </soapenv:Body>
</soapenv:Envelope>

Example 02

<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:PwsDeleteProjectTaskRole>
         <pws:serviceRequest>
            <req:SessionTicket>AZ2QD+hg1Hm7vSa7Y3Lm3w==</req:SessionTicket>
            <sch:DeallocateIfInuseFlag>true</sch:DeallocateIfInuseFlag>
            <sch:ProjectTaskRoleIdentity>
               <com:ProjectRoleIdentity>
                  <com:ProjectRoleUid>1152921504609594610</com:ProjectRoleUid>
               </com:ProjectRoleIdentity>
               <com:ProjectTaskIdentity>
                  <com:ProjectTaskUid>1152921504608735153</com:ProjectTaskUid>
               </com:ProjectTaskIdentity>
            </sch:ProjectTaskRoleIdentity>
            <sch:StealLockFlag>true</sch:StealLockFlag>
         </pws:serviceRequest>
      </pws:PwsDeleteProjectTaskRole>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsDeleteProjectTaskRoleRs

PwsDeleteProjectTaskRoleRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- ProjectTaskRoleIdentity: PwsProjectTaskRoleRef
- EngagementTimestamp: String **deprecated**
- LockStolenFromUserIdentity: PwsUserRef **deprecated**
- RateTaskTimestamp: 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.	0
Status	RequestStatus	Click here for more information.	Ok
ServerTimestampUtc	DateTime	Click here for more information.	2018-02-28T20:46:37.5975698Z
ProjectTaskRoleIdentity	PwsProjectTaskRoleRef	This is the identity of the project task role that was deleted. Click here for more information.
EngagementTimestamp	String	deprecated
LockStolenFromUserIdentity	PwsUserRef	deprecated
RateTaskTimestamp	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.

PwsDeleteProjectTaskRole - Response Usage Example(s)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsDeleteProjectTaskRoleResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsDeleteProjectTaskRoleResult 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:46:37.5975698Z</ServerTimestampUtc>
            <a:ProjectTaskRoleIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:ProjectRoleIdentity>
                  <b:ExternalSystemIdentifier i:nil="true"/>
                  <b:ProjectRoleId i:nil="true"/>
                  <b:ProjectRoleUid>1152921504609594610</b:ProjectRoleUid>
               </b:ProjectRoleIdentity>
               <b:ProjectTaskIdentity>
                  <b:ExternalSystemIdentifier i:nil="true"/>
                  <b:ProjectTaskId i:nil="true"/>
                  <b:ProjectTaskUid>1152921504608735153</b:ProjectTaskUid>
               </b:ProjectTaskIdentity>
               <b:ProjectTaskRoleId i:nil="true"/>
               <b:ProjectTaskRoleUid>1152921504608652849</b:ProjectTaskRoleUid>
            </a:ProjectTaskRoleIdentity>
            <a:EngagementTimestamp>AAAAAA+vpyM=</a:EngagementTimestamp>
            <a:LockStolenFromUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
         </PwsDeleteProjectTaskRoleResult>
      </PwsDeleteProjectTaskRoleResponse>
   </s:Body>
</s:Envelope>

Example 02

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsDeleteProjectTaskRoleResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsDeleteProjectTaskRoleResult 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 106: {oldestSurvivingTimeCardWorkDateString}</b:AdditionalErrorText>
                  <b:ErrorCode>TaskRoleDeallocated</b:ErrorCode>
                  <b:ErrorNumber>106</b:ErrorNumber>
                  <b:ErrorText>The project task role could not be removed because time has been reported against it. The effort was zeroed out 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-03-01T16:14:24.0638561Z</ServerTimestampUtc>
            <a:ProjectTaskRoleIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:ProjectRoleIdentity>
                  <b:ExternalSystemIdentifier i:nil="true"/>
                  <b:ProjectRoleId i:nil="true"/>
                  <b:ProjectRoleUid>1152921504609594610</b:ProjectRoleUid>
               </b:ProjectRoleIdentity>
               <b:ProjectTaskIdentity>
                  <b:ExternalSystemIdentifier i:nil="true"/>
                  <b:ProjectTaskId i:nil="true"/>
                  <b:ProjectTaskUid>1152921504608735153</b:ProjectTaskUid>
               </b:ProjectTaskIdentity>
               <b:ProjectTaskRoleId i:nil="true"/>
               <b:ProjectTaskRoleUid>1152921504608653387</b:ProjectTaskRoleUid>
            </a:ProjectTaskRoleIdentity>
            <a:EngagementTimestamp>AAAAAA+xdSs=</a:EngagementTimestamp>
            <a:LockStolenFromUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
         </PwsDeleteProjectTaskRoleResult>
      </PwsDeleteProjectTaskRoleResponse>
   </s:Body>
</s:Envelope>

PwsDeleteProjectTaskRole - Common Errors and Warnings

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

ErrorNumber	ErrorCode	ErrorText
106	TaskRoleDeallocated	The project task role could not be removed because time has been reported against it. The effort was zeroed out instead.
54242	ProjectTaskRoleHasTimeReported	This project task role cannot be deleted because time has been reported against it.
54274	ProjectTaskRoleNotFound	The specified project task role does not exist.