Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview


This web service deletes a specified project role (PwsProjectRoleRef) and returns the identity of the deleted project role (PwsProjectRoleRef)

...

Panel
titlePwsDeleteProjectRole Request


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

LocksToStealPwsEntityLockSummaryNo
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.

ProjectRoleIdentity

PwsProjectRoleRef

Yes


This is the identity of the project role to be deleted. Click here for more information.


ProjectRoleTimestampStringNo
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.
ProjectorLockSetIdInt32No
A projector lock set id is an identifier for a group of one or more locks held as a unit.

...

Panel
titlePwsDeleteProjectRole Response


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 deleted. Click here for more information.


StolenLocksPwsEntityLockSummaryThis 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
languagexml
titleExample 01
collapsetrue
<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

...

Specified project role does not exist.
ErrorNumberErrorCodeErrorText
54074RoleHasHoursBookedOrRequestedThis project role cannot be deleted because it has hours booked or requested to it.
54080ProjectRoleNotFound