...
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 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 |
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 by 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> |
...
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 | RequestStatus | 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 which the lock was stolen from. Click here for more information. |
Response Usage Example(s)
...