Overview
This web service deletes reverses the deletion of a specified project role (PwsProjectRoleRef) and returns the identity of the un-deleted project role (PwsProjectRoleRef)
Request Format
| 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==ProjectRoleIdentity | Yes | This is the identity of the project role to be deleted. Click here for more information. | StealLockFlag | Boolean | **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 data 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. | |||||
| MakeRoleNameUniqueFlag | Boolean | No | false | If set to "false", the request will fail if there is an existing un-deleted role with the same name; if set to "true", the request will rename the newly un-deleted role in order to avoid the name conflict. Ex. "Project Manager" is renamed as "Project Manager 2". | |||||||
ProjectRoleIdentity | Yes | This is the identity of the project role to be un-deleted. Click here for more information. | |||||||||
| ProjectRoleTimestamp | String | No | This is an optimistic locking timestamp that, if provided on update request, will cause the request to fail 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. |
...
| 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>PwsUndeleteProjectRole>
<pws:serviceRequest>
<req:SessionTicket>AZ2QD+hg1Hm7vSa7Y3Lm3w==<RequestId>1</req:SessionTicket>RequestId>
<sch:ProjectRoleIdentity><req:SessionTicket>AfqS+uJ4ssIz+5Cl+5Jatg==</req:SessionTicket>
<com:ExternalSystemIdentifier>Role-301</com:ExternalSystemIdentifier><sch:MakeRoleNameUniqueFlag>true</sch:MakeRoleNameUniqueFlag>
<com:ProjectRoleUid>1152921504609594607</com:ProjectRoleUid><sch:ProjectRoleIdentity>
</sch:ProjectRoleIdentity> <sch:StealLockFlag>true</sch:StealLockFlag><com:ProjectRoleUid>1152921504609982291</com:ProjectRoleUid>
<sch:ZeroOutHoursFlag>true<</sch:ZeroOutHoursFlag>ProjectRoleIdentity>
</pws:serviceRequest>
</pws:PwsDeleteProjectRole>PwsUndeleteProjectRole>
</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 un-deleted. Click here for more information. | EngagementTimestamp | String | **deprecated** | AAAAAA+vLyM= | LockStolenFromUserIdentity | **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. |
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<PwsDeleteProjectRoleResponse<PwsUndeleteProjectRoleResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
<PwsDeleteProjectRoleResult<PwsUndeleteProjectRoleResult 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>Message 136: This request was executed against the Staging [appst.projectorpsa.com] environment.</b:AdditionalErrorText>
<b:ErrorCode>NonProductionEnvironment</b:ErrorCode>
<b:ErrorNumber>136</b:ErrorNumber>
<b:ErrorText>This web service request was executed against a non-production instance of Projector.</b:ErrorText>
<b:Type>Information</b:Type>
<b:ReferenceId1 i:nil="true"/>
<b:ReferenceId2 i:nil="true"/>
</b:PwsMessage>
</Messages>
<ResponseId xmlns="http://projectorpsa.com/CommonServices/">0<>1</ResponseId>
<Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
<ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2018>2021-0206-28T1601T18:4111:2736.5122259Z<3763411Z</ServerTimestampUtc>
<a:ProjectRoleIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
<b:ExternalSystemIdentifier i:nil="true"/>
<b:ProjectRoleId i:nil="true"/>
<b:ProjectRoleUid>1152921504609594607<ProjectRoleUid>1152921504609982291</b:ProjectRoleUid>
</a:ProjectRoleIdentity>
<a:EngagementTimestamp>AAAAAA+vLyM=</a:EngagementTimestamp>
<a:LockStolenFromUserIdentity StolenLocks i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
</PwsDeleteProjectRoleResult>PwsUndeleteProjectRoleResult>
</PwsDeleteProjectRoleResponse>PwsUndeleteProjectRoleResponse>
</s:Body>
</s:Envelope>
</s:Envelope> |
...
PwsUnDeleteProjectRole Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
| ErrorNumber | ErrorCode | ErrorText |
|---|
| 50024 |
| EntityNotFound | Project Role was not found. Another user may have deleted it. |
| 54743 |
| RoleNameAlreadyInUse | Specified role name is already in use. | |
| 54879 | ProjectRoleNotDeleted | The specified project role |
| is not |
| deleted. |