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 | ||
|---|---|---|
| ||
|
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 | Yes | This is the identity of the project task role to be deleted. | Int32 | No | Click here for more information. | ||||||
SessionTicket | String | Yes | Click here for more information.StealLockFlag | AZ2QD+hg1Hm7vSa7Y3Lm3w== | |||||||
DeallocateIfInuseFlag | Boolean | No | false | If set to 'true', any locks on the engagement 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= 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 | Yes | This is the identity of the project task role to be deleted. Click here for more information. | |||||||||
StealLockFlag | Boolean | **deprecated** | |||||||||
EngagementTimestamp | String | **deprecated** |
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: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> |
...
| Panel | ||
|---|---|---|
| ||
|
Response Elements
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 | Click here for more information. | Ok | ||||||
ServerTimestampUtc | DateTime | 2018-02-28T20:46:37.5975698Z | ||||||
ProjectTaskRoleIdentity | This is the identity of the project task role that was deleted. ResponseId | Int32 | Click here for more information. | EngagementTimestamp0 | 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 | If a lock is stolen in the process of deleting the project task role, this identifies the user from whom the lock was stole. Click here for more information.Status | Click here for more information. | Ok | |||||
ServerTimestampUtc | DateTime | Click here for more information. | 2018-02-28T20:46:37.5975698Z | |||||
ProjectTaskRoleIdentity | This is the identity of the project task role that was deleted. Click here for more information. | |||||||
EngagementTimestamp | String | **deprecated** | AAAAAA+vpyM= | |||||
LockStolenFromUserIdentity | **deprecated** |
Response Usage Example(s)
...