Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Overview

This web service deletes a specified project task role and returns the identity of the deleted project task role.

Request Format

PwsDeleteProjectTaskRoleRq

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 there is reported time by the task role. If set to 'true', 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

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.

AAAAAA+vpyM=

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


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

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.

AAAAAA+vpyM=

LockStolenFromUserIdentity

PwsUserRef

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.


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>

Common Errors and Warnings


ErrorNumberErrorCodeErrorText
106TaskRoleDeallocatedThe project task role could not be removed because time has been reported against it. The effort was zeroed out instead.
54242ProjectTaskRoleHasTimeReportedThis project task role cannot be deleted because time has been reported against it.
54274ProjectTaskRoleNotFoundThe specified project task role does not exist.



  • No labels