...
This web service is used to request and/or schedule hours on an existing role. This web service also allows users to specify a candidate retrieve scheduling data for an existing role as either a requester or a scheduler depending on the authenticated user's permissions and specified mode.
Request Format
| Panel | ||
|---|---|---|
| ||
|
...
Element | Data Type | Required? | Default | Description | Sample Data | |||
|---|---|---|---|---|---|---|---|---|
Int32 | No |
| Click here for more information. | 1 | ||||
String | Yes |
| Click here for more information. | AYWldorWOTDGpNGsIme5tA== | ||||
IncludeActualTimeDataFlag | Boolean | No | false | If set to 'true', actual time that has been approved against this role data will be returned included in the response. | true | |||
IncludeConcurrentRolesFlag | Boolean | No | false | If set to 'true', data associated with concurrent roles will be returned, roles that are not specifically requested, but are associated with the same resource as a requested role over the specified time frame are included in the response. | true | |||
IncludeTaskDataFlag | Boolean | No | false | If set to 'true', task data associated with the role will be returned. | true | |||
MinimumWeekCount | Int32 | No |
| The minimum If specified, the response will include at minimum the specified number of weeks worth of data that will be returneddata, even if the specified roles have no scheduling data over some or all of the date range, | 10 | |||
ProjectIdentity | Either a ProjectIdentity or ProjectRoleIdentities must be specified |
| The project identity, to retrieve scheduling data for the roles on a project, | |||||
ProjectRoleIdentities | Either a ProjectIdentity or ProjectRoleIdentities must be specified |
|
| must be specified |
| The role identities, to retrieve scheduling data for a set of roles (that may or may not be on the same project). | ||
RequestOrScheduleMode | String | Yes |
| "R" for Requester – retrieve requested data. "A" for Scheduler – retrieve booked data. | A | |||
StartDate | DateTime | Yes |
| Only data from this point forward will be returned. The data will extend indefinitely into the future so as to include all forward-looking scheduling data. | 2020-01-06T00:00:00.000Z |
Request Usage Example(s)
...
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
Int32 | Click here for more information. | 1 | |
Status | Click here for more information. | Ok | |
DateTime | Click here for more information. | 2020-02-06T19:56:39.3674096Z | |
EndDate | DateTime | The last date in the time period for which data will be returned. | 2020-03-15T00:00:00Z |
ProjectRoles | This structure contains the complete set of information about the project roleroles' s schedule schedules within the specified time period. | ||
RequestOrScheduleMode | String | "R" for Requester. "A" for Scheduler. | R |
Resources | This structure contains the complete set of information about the resource's schedule resources' schedules (such as standard working hours, holidays, vacation time, etc) within the specified time period. All resources represented by the included project roles will be represented – including the effective resources on the roles as well as the identified candidates. This includes unnamed resources. | ||
StartDate | DateTime | The first date in the time period for which data will be returned. | 2020-01-06T00:00:00Z |
WeekCount | Int32 | The number of weeks within the specified time period. | 10 |
Response Usage Example(s)
...