Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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).

...

Panel
titlePwsDeleteProjectTaskRoleRq

...

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**




LocksToStealPwsEntityLockSummaryNo
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.
ProjectorLockSetIdInt32No
A projector lock set id is an identifier for a group of one or more locks held as a unit.
RateTaskTimestampStringNo
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.

...

Panel
titlePwsDeleteProjectTaskRoleRs


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**


RateTaskTimestampStringThis 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.
StolenLocksPwsEntityLockSummaryThis 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)


Code Block
languagexml
titleExample 01
collapsetrue
<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>

...