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


"When you reset the begin and end dates of a project using this web service, the start and end dates of the roles, as well as the allocation dates, are also adjusted accordingly. For instance, if you delay the project end date by 5 days, the following changes will occur:

  • Role start date: Delayed by 5 days
  • Role end date: Delayed by 5 days
  • Allocation in daily mode: Delayed by 5 days
  • Allocation in weekly mode: Delayed by the number of weeks between the original and new project begin date. This could be one week or zero weeks depending on the case.

Request Format


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

2023-12-31z

NewProjectCloseDateClearFlag

Boolean

No


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

true

NewProjectOpenDate

DateTime

Yes


The new begin date for the project.

2023-01-01z

ProjectIdentity

PwsProjectRef

Yes


This structure represents the unique key fields associated with identifying a project.


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 either the new begin or end date  will be in conflict with role start and end dates or allocation dates, the new 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 end date is Dec. 12, 2022, and the project end date is set to Nov. 30, 2022. If the boolean value is set to ‘true’, Projector will change the project end date to Dec. 12, 2022, to resolve the conflict. However, if the boolean value is set to ‘false’, error 55037 will be thrown.


Request Usage Example(s)


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

Response Format


PwsAdvanceDelayProject Response


Response Elements


Element

Data Type

Description

Messages

PwsMessage

The web service response status and message. Click here for more information.

ResponseId

Int32

Click here for more information.

Status

RequestStatus

Click here for more information.

ServerTimestampUtc

DateTime

Click here for more information.

NewProjectCloseDate

DateTime

The new end date of the project

NewProjectOpenDate

DateTime

The new begind date of the project

ProjectTimestamp

String

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.

Response Usage Example(s)


Example 01 - simple update
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <PwsAdvanceDelayProjectResponse xmlns="http://projectorpsa.com/PwsProjectorServices/">
         <PwsAdvanceDelayProjectResult 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/">2023-10-11T19:29:06.3237023Z</ServerTimestampUtc>
            <a:NewProjectCloseDate>2022-10-29T00:00:00</a:NewProjectCloseDate>
            <a:NewProjectOpenDate>2022-01-01T00:00:00</a:NewProjectOpenDate>
            <a:ProjectTimestamp>AAAAADHlsuY=</a:ProjectTimestamp>
         </PwsAdvanceDelayProjectResult>
      </PwsAdvanceDelayProjectResponse>
   </s:Body>
</s:Envelope>

PwsAdvanceDelayProject - Common Errors and Warnings

ErrorNumber

ErrorCode

ErrorText

55263NoPermissionToAdvanceDelayProject

No permission to advance or delay project

55037AdvanceDelayDateAdjustmentInvalidRequested date adjustment would result in activity outside of role or project date range.
  • No labels