Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Overview


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

Request Format


PwsDeleteProjectRole Request


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

PwsProjectRoleRef

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




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

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


Response Format


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


EngagementTimestamp

String

**deprecated**

AAAAAA+vLyM=

LockStolenFromUserIdentity

PwsUserRef

**deprecated**


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.

Response Usage Example(s)


Example 01 
<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


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



  • No labels