IShiftAssignmentService1

Operations

NameSignatureDescription
BulkDeleteShiftAssignmentBulkDeleteResults1 BulkDelete(Uri[] shiftAssignmentUris)Delete specified shift assignments.
BulkGetMostRecentValidationResultsObjectValidationBulkGetResult1[] BulkGetMostRecentValidationResults(Uri[] shiftAssignmentUris)Get latest validation results for the specified assignments
BulkGetShiftAssignmentDetailsShiftAssignmentDetails1[] BulkGetShiftAssignmentDetails(Uri[] shiftAssignmentUris)Bulk get details of a shift assignments.
BulkGetShiftDetailsBulkGetShiftDetailsResult1[] BulkGetShiftDetails(Uri[] shiftUris)Bulk get shift details.
BulkGetShiftSummarySeriesShiftSummarySeries2[] BulkGetShiftSummarySeries(Uri[] userUris, DateRangeParameter1 dateRange)Bulk retrieve shift assignment details for users over a time period
BulkGetShiftUserAvailabilityBulkGetShiftUserAvailabilityResult1 BulkGetShiftUserAvailability(Uri[] userUris, DateRangeParameter1 dateRange)Bulk retrieve shift user availability details over a time period
BulkGetTimeOffAndHolidaysForShiftUsersShiftUserBulkGetTimeOffAndHolidaySummaryResults1[] BulkGetTimeOffAndHolidaysForShiftUsers(Uri[] userUris, DateRangeParameter1 dateRange, Uri holidayTimeOffTypeOptionUri)Get the timeoffs and holidays in a given daterange for group of users
BulkGetUserRoleAssignmentDetailsForShiftUsersUserProjectRoleAssignmentBulkGetResult1[] BulkGetUserRoleAssignmentDetailsForShiftUsers(Uri[] userUris)Retrieve all role assignment details for the users
BulkGetUserRoleSkillRequirementsBulkGetJobRoleSkillResult1 BulkGetUserRoleSkillRequirements(ShiftJobTargetParameter1 shiftJob, Uri[] userRoleUris)Retrieve skills for a job filtered by user role
BulkPutShiftAssignmentsShiftAssignmentReference1[] BulkPutShiftAssignments(ShiftAssignmentParameter1[] assignments, String unitOfWorkId)Bulk put shift assignments.
CreateCopyFromBatchUri CreateCopyFromBatch(Uri[] shiftAssignmentUris, DateRangeParameter1 sourceWindow, Date1 targetDate)Create a batch for copying shift assignments from sourceWindow starting at targetDate. Copied assignments will be offset from startDate of the sourceWindow, and must fall within the sourceWindow. Use BatchManagementService1.ExecuteInBackground to begin executing the batch.
CreateDeleteBatchUri CreateDeleteBatch(Uri[] shiftAssignmentUris)Create a batch operation to delete the specified shift assignments
CreateEditDraftUri CreateEditDraft(Uri shiftAssignmentUri)Create a draft of an existing shift assignment.
CreateNewDraftUri CreateNewDraft()Create new draft.
CreateOrModifyShiftAssignmentBatchUri CreateOrModifyShiftAssignmentBatch(CreateOrModifyShiftAssignmentParameter1 modifications)Create a batch to make the same updates to multiple assignments
CreateShiftAssignmentBatchUri CreateShiftAssignmentBatch(ShiftAssignmentBatchParameter1 shiftAssignments)Create a batch to add multiple shift assignments
CreateShiftAssignmentModificationsBatchUri CreateShiftAssignmentModificationsBatch(Uri[] shiftAssignmentUris, ShiftAssignmentModificationsParameter1 modifications)Create a batch to make the same modification to multiple shift assignments
Deletevoid Delete(Uri shiftAssignmentUri)Delete shift assignment.
GetCopyFromBatchResultsShiftAssignmentCopyFromBatchResults1 GetCopyFromBatchResults(Uri shiftAssignmentCopyFromBatchUri)Get the results of the specified ShiftAssignmentCopyFromBatch. Returns null if the batch has not completed. Use BatchManagementService1.GetStatus to get the progress information of an existing batch
GetCountOfMostRecentValidationResultsShiftAssignmentObjectValidationCountResult1 GetCountOfMostRecentValidationResults(ShiftAssignmentValidationFilterParameter1 validationObjectFilter)Get total count of latest validation results by filter
GetCountOfUserRolesInt32 GetCountOfUserRoles(DateRangeParameter1 dateRange, ShiftUserRoleFilterParameter1 shiftUserRoleFilter)Get total count of employee roles used in the shift schedule creation
GetCreateOrModifyShiftAssignmentBatchResultCreateOrModifyShiftAssignmentBatchResult1 GetCreateOrModifyShiftAssignmentBatchResult(Uri batchUri)Operation GetCreateOrModifyShiftAssignmentBatchResult
GetDeleteBatchResultsShiftAssignmentDeleteBatchResults1 GetDeleteBatchResults(Uri shiftAssignmentDeleteBatchUri)Retrieve results of a completed ShiftAssignmentDeleteBatch operation. Returns null if the batch has not completed.
GetMostRecentValidationResultObjectValidationResult1 GetMostRecentValidationResult(Uri shiftAssignmentUri)Get last shift assignment validation result. Will be null if shift assignment was never validated.
GetMostRecentValidationSummaryForAssignmentsShiftAssignmentValidationSummaryResults1[] GetMostRecentValidationSummaryForAssignments(ShiftAssignmentValidationSummaryFilterParameter1 validationObjectFilter)Get summary of most recent validation results for shift assignments by user search
GetPageOfMostRecentValidationResultsObjectValidationBulkGetResult1[] GetPageOfMostRecentValidationResults(Int32 page, Int32 pageSize, ShiftAssignmentValidationFilterParameter1 validationObjectFilter)Get paged latest validation results by filters
GetPageOfProjectsFilteredByDateRangeAndTextSearchProjectReference1[] GetPageOfProjectsFilteredByDateRangeAndTextSearch(Int32 pageIndex, Int32 pageSize, DateRangeParameter1 dateRange, ProjectTextSearchParameter1 textSearch)Get page of Projects viewable for the user filtered by date range and text search
GetPageOfShiftsByTextSearchShiftSearchResult1[] GetPageOfShiftsByTextSearch(Int32 page, Int32 pageSize, ShiftSearchParameter1 shiftSearch)Get page of shifts by category optionally search by shift text search
GetPageOfSkillsByCategoryFilteredBySkillSearchSkillSearchResult1[] GetPageOfSkillsByCategoryFilteredBySkillSearch(Int32 page, Int32 pageSize, SkillSearchParameter1 skillSearch)Get page of skills by category optionally search by skill text search
GetPageOfUserRolesProjectRoleReference1[] GetPageOfUserRoles(Int32 page, Int32 pageSize, DateRangeParameter1 dateRange, ShiftUserRoleFilterParameter1 shiftUserRoleFilter)Get page of employee roles used in the shift schedule creation
GetShiftAssignmentCreationBatchResultsShiftAssignmentCreationBatchResults1 GetShiftAssignmentCreationBatchResults(Uri shiftAssignmentCreationBatchUri)Retrieve results of a ShiftAssignmentCreationBatch. Returns null if the batch has not completed
GetShiftAssignmentDetailsShiftAssignmentDetails1 GetShiftAssignmentDetails(Uri shiftAssignmentUri)Get details of a shift.
GetShiftAssignmentModificationsBatchResultsShiftAssignmentModificationsBatchResults1 GetShiftAssignmentModificationsBatchResults(Uri shiftAssignmentModificationsBatchUri)Retrieve results of a ShiftAssignmentModificationsBatch. Returns null if the batch has not completed
GetShiftAssignmentTotalsByDateShiftAssignmentTotalsByDateSummary1 GetShiftAssignmentTotalsByDate(ShiftAssignmentUserSearchParameter1 userSearch, ShiftAssignmentShiftSearchParameter1 shiftSearch, ObjectExtensionFieldSearchParameter1[] objectExtensionFieldSearches, DateRangeParameter1 dateRange)Retrieve shift assignment summary that match the specified search criteria. Any omitted search parameter will result in no filtering on that dimension.
GetShiftAssignmentTotalsByDate2ShiftAssignmentTotalsByDateSummary1 GetShiftAssignmentTotalsByDate2(ShiftAssignmentSearchParameter1 search, DateRangeParameter1 dateRange)Retrieve shift assignment summary that match the specified search criteria. Any omitted search parameter will result in no filtering on that dimension.
GetShiftDetailsShiftDetails1 GetShiftDetails(Uri shiftUri)Get details of a shift.
GetShiftRequirementDetailsSeriesShiftRequirementDetailsDataPoint1[] GetShiftRequirementDetailsSeries(Uri userRoleFilterOption, DateRangeParameter1 dateRange, ShiftRequirementFilterParameter1 shiftRequirementFilter)Retrieve shift requirements for a date range
GetShiftRequirementSummaryShiftRequirementSummary1 GetShiftRequirementSummary(Uri userRoleFilterOption, DateRangeParameter1 dateRange, ShiftRequirementSummaryFilter1 shiftRequirementSummaryFilter)Retrieve shift requirement summary for a date range
GetShiftRequirementSummarySeriesRequirementSummarySeriesDataPoint1[] GetShiftRequirementSummarySeries(Uri userRoleFilterOption, DateRangeParameter1 dateRange, ShiftRequirementSummaryFilter1 shiftRequirementSummaryFilter)Retrieve shift requirement summary for a date range
GetShiftScheduleSummaryShiftScheduleSummary1[] GetShiftScheduleSummary(ShiftAssignmentUserSearchParameter1 userSearch, ShiftAssignmentShiftSearchParameter1 shiftSearch, ObjectExtensionFieldSearchParameter1[] objectExtensionFieldSearches, DateRangeParameter1 dateRange)Retrieve shift assignment details that match the specified search criteria. Any omitted search parameter will result in no filtering on that dimension.
GetShiftSummarySeriesShiftSummarySeries2 GetShiftSummarySeries(Uri userUri, DateRangeParameter1 dateRange)Retrieve shift assignment details for a user over a time period
PublishDraftShiftAssignmentReference1 PublishDraft(Uri shiftAssignmentDraftUri)Persist draft.
PutShiftAssignmentShiftAssignmentReference1 PutShiftAssignment(ShiftAssignmentParameter1 assignment, String unitOfWorkId)Put a shift assignment.
PutShiftAssignment2ShiftAssignmentReference1 PutShiftAssignment2(ShiftAssignmentParameter1 assignment, String unitOfWorkId)Put a shift assignment With Validations.
UpdateDatevoid UpdateDate(Uri shiftAssignmentUri, Date1 date)Change date on a shift assignment.
UpdateEndTimevoid UpdateEndTime(Uri shiftAssignmentUri, ShiftTime1 endTime)Change shift end time at the assignment level.
UpdateNotevoid UpdateNote(Uri shiftAssignmentUri, String note)Change note on a shift assignment.
UpdatePublishedStatevoid UpdatePublishedState(Uri shiftAssignmentUri, Uri publishStateUri)Change published state on a shift assignment.
UpdateShiftvoid UpdateShift(Uri shiftAssignmentUri, Uri shiftUri)Change shift on an assignment.
UpdateStartTimevoid UpdateStartTime(Uri shiftAssignmentUri, ShiftTime1 startTime)Change shift start time at the assignment level.
UpdateUservoid UpdateUser(Uri shiftAssignmentUri, Uri userUri)Change user on a shift assignment.