Overview
This web service deletes a specified project role (PwsProjectRoleRef) and returns the identity of the deleted project role (PwsProjectRoleRef)
Request Format
| Panel | ||
|---|---|---|
| ||
|
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
RequestId | Int32 | Click here for more information. | |||
SessionTicket | String | Yes | Click here for more information. | AZ2QD+hg1Hm7vSa7Y3Lm3w== | |
ProjectRoleIdentity | Yes | This is the identity of the project role to be deleted. Click here for more information. | |||
StealLockFlag | 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 |
ZeroOutHoursFlag | Boolean | No | false | If set to 'true', requested or allocated hours are cleared before deletion. If it is set to 'false' and there are either requested or allocated hours, the request 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+vLyM= |
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:PwsDeleteProjectRole>
<pws:serviceRequest>
<req:SessionTicket>AZ2QD+hg1Hm7vSa7Y3Lm3w==</req:SessionTicket>
<sch:ProjectRoleIdentity>
<com:ExternalSystemIdentifier>Role-301</com:ExternalSystemIdentifier>
<com:ProjectRoleUid>1152921504609594607</com:ProjectRoleUid>
</sch:ProjectRoleIdentity>
<sch:StealLockFlag>true</sch:StealLockFlag>
<sch:ZeroOutHoursFlag>true</sch:ZeroOutHoursFlag>
</pws:serviceRequest>
</pws:PwsDeleteProjectRole>
</soapenv:Body>
</soapenv:Envelope> |
Response Format
| 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 | Click here for more information. | 2018-02-28T16:41:27.5122259Z |
ProjectRoleIdentity | This is the identity of the project role that was deleted. Click here for more information. | ||
EngagementTimestamp | String | See EngagementTimestamp above in Request Elements table. | AAAAAA+vLyM= |
LockStolenFromUserIdentity | If a lock is stolen in the process of updating an engagement, this identifies the user from whom the lock was stole. Click here for more information. |
Response Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PwsDeleteProjectRoleResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsDeleteProjectRoleResult 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-28T16:41:27.5122259Z</ServerTimestampUtc>
<a:ProjectRoleIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:ExternalSystemIdentifier i:nil="true"/>
<b:ProjectRoleId i:nil="true"/>
<b:ProjectRoleUid>1152921504609594607</b:ProjectRoleUid>
</a:ProjectRoleIdentity>
<a:EngagementTimestamp>AAAAAA+vLyM=</a:EngagementTimestamp>
<a:LockStolenFromUserIdentity i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
</PwsDeleteProjectRoleResult>
</PwsDeleteProjectRoleResponse>
</s:Body>
</s:Envelope>
|
PwsDeleteProjectRole Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
| ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 54074 | RoleHasHoursBookedOrRequested | This project role cannot be deleted because it has hours booked or requested to it. |
| 54080 | ProjectRoleNotFound | Specified project role does not exist. |