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
- serviceRequest: PwsAdvanceDelayProjectRq
- RequestId: Int32
- SessionTicket: String
- LocksToSteal: PwsEntityLockSummary[]
- NewProjectCloseDate: DateTime
- NewProjectCloseDateClearFlag: Boolean
- NewProjectOpenDate: DateTime
- ProjectIdentity: PwsProjectRef
- ProjectTimestamp: String
- ProjectorLockSetId: Int32
- AllowProjectDatesToStretchFlag: Boolean
- serviceRequest: PwsAdvanceDelayProjectRq
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
---|---|---|---|---|---|
Int32 | No | Click here for more information. | 1 | ||
String | Yes | Click here for more information. | AWXKNmZlvR5xkqVh6PAXqQ== | ||
LocksToSteal | 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 | 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)
Response Format
- PwsAdvanceDelayProjectResponse
- PwsAdvanceDelayProjectResult: PwsAdvanceDelayProjectRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- NewProjectCloseDate: DateTime
- NewProjectOpenDate: DateTime
- ProjectTimestamp: String
- PwsAdvanceDelayProjectResult: PwsAdvanceDelayProjectRs
Response Elements
Element | Data Type | Description |
---|---|---|
Messages | The web service response status and message. Click here for more information. | |
ResponseId | Int32 | Click here for more information. |
Status | Click here for more information. | |
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)
PwsAdvanceDelayProject - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
---|---|---|
55263 | NoPermissionToAdvanceDelayProject | No permission to advance or delay project |
55037 | AdvanceDelayDateAdjustmentInvalid | Requested date adjustment would result in activity outside of role or project date range. |