Overview

This web service reverses the deletion of a specified project role (PwsProjectRoleRef) and returns the identity of the un-deleted project role (PwsProjectRoleRef)

Request Format

PwsUnDeleteProjectRole Request

PwsUnDeleteProjectRole
- serviceRequest: PwsDeleteProjectRoleRq
  - RequestId: Int32
  - SessionTicket: String
  - LocksToSteal: PwsEntityLockSummary[1.100]
  - MakeRoleNameUniqueFlag: Boolean
  - ProjectRoleIdentity: PwsProjectRoleRef
  - ProjectRoleTimestamp: String
  - ProjectorLockSetId: Int32

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==
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	PwsProjectRoleRef	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.

Request Usage Example(s)

Example 01

<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:PwsUndeleteProjectRole>
         <pws:serviceRequest>
            <req:RequestId>1</req:RequestId>
            <req:SessionTicket>AfqS+uJ4ssIz+5Cl+5Jatg==</req:SessionTicket>
            <sch:MakeRoleNameUniqueFlag>true</sch:MakeRoleNameUniqueFlag>
            <sch:ProjectRoleIdentity>
               <com:ProjectRoleUid>1152921504609982291</com:ProjectRoleUid>
            </sch:ProjectRoleIdentity>
         </pws:serviceRequest>
      </pws:PwsUndeleteProjectRole>
   </soapenv:Body>
</soapenv:Envelope>

Response Format

PwsUnDeleteProjectRole Response

PwsUnDeleteProjectRoleResponse
- PwsDeleteProjectRoleResult: PwsDeleteProjectRoleRs
  - Messages: PwsMessage []
  - ResponseId: Int32
  - Status: RequestStatus
  - ServerTimestampUtc: DateTime
  - ProjectRoleIdentity: PwsProjectRoleRef
  - StolenLocks: PwsEntityLockSummary

Response Elements

Element	Data Type	Description	Sample Data
Messages	PwsMessage []	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	PwsProjectRoleRef	This is the identity of the project role that was un-deleted. Click here for more information.
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)

Example 01

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsUndeleteProjectRoleResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <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/">1</ResponseId>
            <Status xmlns="http://projectorpsa.com/CommonServices/">Ok</Status>
            <ServerTimestampUtc xmlns="http://projectorpsa.com/CommonServices/">2021-06-01T18:11:36.3763411Z</ServerTimestampUtc>
            <a:ProjectRoleIdentity xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/">
               <b:ExternalSystemIdentifier i:nil="true"/>
               <b:ProjectRoleId i:nil="true"/>
               <b:ProjectRoleUid>1152921504609982291</b:ProjectRoleUid>
            </a:ProjectRoleIdentity>
            <a:StolenLocks i:nil="true" xmlns:b="http://projectorpsa.com/DataContracts/Shared/Common/"/>
         </PwsUndeleteProjectRoleResult>
      </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.