Overview
This web service deletes a specified project role (PwsProjectRoleRef) and returns the identity of the deleted project role (PwsProjectRoleRef)
...
| 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**deprecated** | |||
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 | **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 | 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. Thisdata 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. | ||||
| ProjectRoleTimestamp | String | No | This is an optimistic locking timestamp that, if provided on update request, will cause the request to fail | if any change has been made between the two invocations.AAAAAA+vLyM=when the timestamp stored in the database does not match the provided value. | ||||
| ProjectorLockSetId | Int32 | No | A projector lock set id is an identifier for a group of one or more locks held as a unit. |
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> |
...
| 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 | StringSee EngagementTimestamp above in Request Elements table. | **deprecated** | AAAAAA+vLyM= |
LockStolenFromUserIdentity | PwsUserRefIf 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 | **deprecated** | |
| 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. |
Response Usage Example(s)
...