Versions Compared

Key

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

Overview

PwsAdvanceDelayProject can be used to shift a specified project in time. Advancing the project (by specifying a NewProjectOpenDate prior to the existing begin date) causes all dates to be shifted earlier (project is starting ahead of schedule); delaying the project (by specifying a NewProjectOpenDate after the existing begin date) causes all dates to be shifted later (project is starting behind schedule).

...

Panel
titlePwsAdvanceDelayProject Request

Request Elements


Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information.

1

SessionTicket

String

Yes


Click here for more information.

AWXKNmZlvR5xkqVh6PAXqQ==

LocksToSteal

PwsEntityLockSummary[]

No


This structure represents the locked state of a Projector entity such as an engagement or a project


NewProjectCloseDate

DateTime

No


The new end date for the project, if any.

2023-12-31z

NewProjectCloseDateClearFlag

Boolean

No


If set to 'true', the project end date, if currently set, will be cleared.

true

NewProjectOpenDate

DateTime

Yes


The new begin date for the project.

2023-01-01z

ProjectIdentity

PwsProjectRef

Yes


This structure identifies the project to be advanced or delayed.


ProjectTimestamp

String

No


*** This field has been deprecated ***


ProjectorLockSetId

Int32



A projector lock set id is an identifier for a group of one or more locks held as a unit.


AllowProjectDatesToStretchFlag

Boolean

No

false

When the new begin date would be in conflict with role start dates or allocation dates after the operation is completed, the project begin date will be adjusted to resolve the conflict if this boolean value is set to 'true'.   Otherwise, error 55037 will be thrown. 

For instance, suppose a role’s begin date after the operation is completed is Nov. 30, 2022, and the project begin date is currently set to Dec. 12, 2022. If the boolean value is set to ‘true’, Projector will change the project begin date to Nov. 30, 2022, to resolve the conflict. However, if the boolean value is set to ‘false’, error 55037 will be thrown.

Note that the project end date is automatically stretched as necessary, regardless of this setting.


Request Usage Example(s)


Code Block
languagexml
titleExample 01 - simple update
collapsetrue
<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:PwsAdvanceDelayProject>
         <!--Optional:-->
         <pws:serviceRequest>
            <req:SessionTicket>AWXKNmZlvR5xkqVh6PAXqQ==</req:SessionTicket>
            <sch:NewProjectCloseDate>2023-12-31z</sch:NewProjectCloseDate>
            <!--Optional:-->
            <!--sch:NewProjectCloseDateClearFlag>?</sch:NewProjectCloseDateClearFlag-->
            <sch:NewProjectOpenDate>2022-01-01z</sch:NewProjectOpenDate>
            <sch:ProjectIdentity>
               <!--Optional:-->
               <com:ProjectCode>LUCIA-001</com:ProjectCode>
            </sch:ProjectIdentity>
            <sch:AllowProjectDatesToStretchFlag>true</sch:AllowProjectDatesToStretchFlag>
         </pws:serviceRequest>
      </pws:PwsAdvanceDelayProject>
   </soapenv:Body>
</soapenv:Envelope>

...