Overview
This structure is used when saving scheduling changes for one or more project roles. It represents multiple scheduling elements associated with a project role, including the candidate identity, hours and allocation notes.
...
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
CandidateResourceClearFlag | Boolean | No |
| If 'true', the resource candidate will be cleared. | false |
CandidateResourceIdentity | No |
| The resource candidate that will be associated with the role. | ||
ClearExistingHoursFlag | Boolean | No |
| If 'true', the existing hours will be cleared. Whether this will be requested or booked hours will depend on whether or not the user is acting as a requester or scheduler. | true |
ClearPeriodEndDate | DateTime | No |
| The last date in the period for which the hours will be cleared. This is only applicable if 'ClearExisthingHoursFlag' is set to 'true'. | |
ClearPeriodStartDate | DateTime | No |
| The first date in the period for which the hours will be cleared. This is only applicable if 'ClearExisthingHoursFlag' is set to 'true'. | |
CopyRequestedHoursFlag | Boolean | No |
| If set to 'true', the requested hours will be copied over as scheduled hours. Note: this is only applicable if the authenticated user is acting as a scheduler. | |
HoursBuckets | No |
| This structure defines the number of hours that will be requested or scheduled for a role as well as the pattern in which they will be distributed. | ||
LeaveRequestOpenFlag | Boolean | No | false | If set to 'true', the role will be flagged as having an open request. | true |
NotesBuckets | No |
| This structure defines the allocation notes for a role as well as the pattern in which they will be distributed. | ||
ProjectRoleIdentity | Yes |
| The role identity. | ||
Timestamp | String | No |
| This is a Base64 encoded timestamp optionally utilized for cost card lockinglocking. The value returned by a previous web service call that retrieved data from the database should be echoed back here. Specify null to skip lock checking. |
Usage Example(s)
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<com:PwsProjectRoleHours>
<com:CandidateResourceClearFlag>false</com:CandidateResourceClearFlag>
<com:CandidateResourceIdentity>
<com:ResourceDisplayName>Matt</com:ResourceDisplayName>
<com:ResourceReferenceSystemId>IT (USA) - 01</com:ResourceReferenceSystemId>
</com:CandidateResourceIdentity>
<com:ClearExistingHoursFlag>true</com:ClearExistingHoursFlag>
<com:HoursBuckets>
<com:PwsProjectRoleHoursBucket>
<com:BucketStartDate>2020-01-06T00:00:00.000Z</com:BucketStartDate>
<com:SchedulingMode>W</com:SchedulingMode>
<com:WeeklyMinutes>2400</com:WeeklyMinutes>
</com:PwsProjectRoleHoursBucket>
</com:HoursBuckets>
<com:LeaveRequestOpenFlag>true</com:LeaveRequestOpenFlag>
<com:NotesBuckets>
<com:PwsProjectRoleNotesBucket>
<com:BucketStartDate>2020-01-06T00:00:00.000Z</com:BucketStartDate>
<com:Notes>
<arr:string>Monday</arr:string>
<arr:string>Tuesday</arr:string>
<arr:string>Wednesday</arr:string>
<arr:string>Thursday</arr:string>
<arr:string>Friday</arr:string>
<arr:string>Saturday</arr:string>
<arr:string>Sunday</arr:string>
</com:Notes>
</com:PwsProjectRoleNotesBucket>
</com:NotesBuckets>
<com:ProjectRoleIdentity>
<com:ProjectRoleUid>1152921504609839438</com:ProjectRoleUid>
</com:ProjectRoleIdentity>
</com:PwsProjectRoleHours> |
...