ITimeOffService1

Operations

NameSignatureDescription
BulkDeleteTimeOffTypeTimeOffTypeBulkDeleteResults1 BulkDeleteTimeOffType(Uri[] timeOffTypeUris, Uri timeOffTypeBulkDeleteOptionUri)Delete many time off types
BulkGetTimeOffSummaryForUserAndDateRangeUserTimeOffBulkGetSummaryResults1[] BulkGetTimeOffSummaryForUserAndDateRange(Uri[] userUris, DateRangeParameter1 dateRange)Get all time off bookings for users, which overlap with a date range.
BulkGetTimeOffTypeAssignmentsForUsersUserTimeOffTypeBulkGetAssignmentDetailsResults1[] BulkGetTimeOffTypeAssignmentsForUsers(Uri[] userUris)Get the list of time off types assigned to specified users
BulkGetTimeOffTypeDetailsTimeOffTypeDetails1[] BulkGetTimeOffTypeDetails(Uri[] timeOffTypeUris)Retrieve details of a set of time off types
BulkGetTimeOffTypesTimeOffTypeReference1[] BulkGetTimeOffTypes(Uri[] timeOffTypeUris)Bulk get time off types from their URI. If a URI is not found, it will be omitted from the results.
BulkGetUserTimeOffTypeBalanceSummariesUserTimeOffTypeBalanceSummary1[] BulkGetUserTimeOffTypeBalanceSummaries(Uri[] userUris, Uri[] timeOffTypeUris, Date1 asOfDate)Get the balance summary information for a set of users over a set of time off types, as of a certain date. Optionally, exclude certain planned or unplanned time offs from the calculation.
ConfigureMultiDayTimeOffvoid ConfigureMultiDayTimeOff(Uri timeOffUri, TimeOffDateParameter1 startDate, TimeOffDateParameter1 endDate)Configure a time off which spans multiple days and may be full or partial days on the start and end dates.
ConfigureSingleDayTimeOffvoid ConfigureSingleDayTimeOff(Uri timeOffUri, TimeOffDateParameter1 date)Configure a time off for a single full or partial day
ConfigureTimeOffUsingUserExplicitEntriesvoid ConfigureTimeOffUsingUserExplicitEntries(Uri timeOffUri, TimeOffUserExplicitEntryParameter1[] userExplicitEntries)Configure a time off booking using explicit daily entries.
ConfigureUserTimeOffICalFeedvoid ConfigureUserTimeOffICalFeed(Uri userUri, Uri timeOffICalFeedOptionUri)Set up a new time off calendar feed for a user
CreateEditTimeOffDraftUri CreateEditTimeOffDraft(Uri timeOffUri)Creates a draft of an existing time off object
CreateEditTimeOffTypeDraftUri CreateEditTimeOffTypeDraft(Uri timeOffTypeUri)Creates a draft of an existing time off type object
CreateNewTimeOffDraftUri CreateNewTimeOffDraft(Uri ownerUri)Creates a draft of a new time off object
CreateNewTimeOffTypeDraftUri CreateNewTimeOffTypeDraft()Create a draft object for a new time off type.
CreateTimeOffDeleteBatchUri CreateTimeOffDeleteBatch(Uri[] timeOffUris)Create a batch for bulk deleting TimeOff.
DeleteTimeOffvoid DeleteTimeOff(Uri timeOffUri)Delete a time off
DeleteTimeOffTypevoid DeleteTimeOffType(Uri timeOffTypeUri)Delete a time off type
DeleteUserTimeOffICalFeedvoid DeleteUserTimeOffICalFeed(Uri userUri)Set up a new time off calendar feed for a user
DisableTimeOffTypevoid DisableTimeOffType(Uri timeOffTypeUri)Disable a time off type
EnableTimeOffTypevoid EnableTimeOffType(Uri timeOffTypeUri)Enable a time off type
ExecuteTimeOffDeleteBatchTimeOffDeleteBatchResults1 ExecuteTimeOffDeleteBatch(Uri timeOffDeleteBatchUri)Delete the specified TimeOff.
GetAllowedTimeOffDateParameterDetailsAllowedTimeOffDateOptionsDetails1 GetAllowedTimeOffDateParameterDetails(Uri timeOffTypeUri)Get the allowed options for specifying the duration and timing of a time off booking, for a specific time off type.
GetAllTimeOffTypesTimeOffTypeReference1[] GetAllTimeOffTypes()Retrieve a list of all time off types in the system
GetBalanceEstimateSummaryForProposedTimeOff2UserTimeOffTypeBalanceEstimateSummary1 GetBalanceEstimateSummaryForProposedTimeOff2(TimeOffParameter2 timeOff, Date1[] asOfDates)Returns the estimated balance summary for a proposed new time off or modification of an existing time off for the passed dates
GetBalanceSummaryForProposedTimeOff2TimeOffBalanceSummary1 GetBalanceSummaryForProposedTimeOff2(TimeOffParameter2 timeOff)Returns the balance summary for a proposed new time off or modification of an existing time off
GetBankableTimeSummaryBankableTimeSummary1 GetBankableTimeSummary(Uri userUri, DateRangeParameter1 dateRange)Get the available bankable detail for each pay codes
GetBankedTimePolicyForUserUserBankedTimePolicyDetails1 GetBankedTimePolicyForUser(Uri userUri)Get the banked time settings for the specified user
GetCountOfEligibleTimeOffOwnersByTextSearch3Int32 GetCountOfEligibleTimeOffOwnersByTextSearch3(Uri[] dataAccessLevelUris, UserTextSearchParameter1 textSearch)Gets the number of users that can have time off booked on their behalf.
GetDefaultTimeOffTypeForBookingsForUserTimeOffTypeReference1 GetDefaultTimeOffTypeForBookingsForUser(Uri userUri)Get the default time off type for new bookings for a given user
GetEffectivePolicyValuesForTimeOffPolicyKeyValue2[] GetEffectivePolicyValuesForTimeOff(Uri timeOffUri)Gets the effective policy values for the given time off
GetEffectiveTimeOffInLieuPolicyValuesForUserPolicyKeyValue2[] GetEffectiveTimeOffInLieuPolicyValuesForUser(Uri userUri, DateTimeParameter1 asOf)Get the effective Time Off In Lieu policy values for a specific user for asOf date, Get the Current policy if date is null.
GetEligiblePayCodesForTimeOffTypePayCodeReference1[] GetEligiblePayCodesForTimeOffType(Uri timeOffTypeUri)Get the list of pay codes eligible for time off type
GetEligibleTimeOffTypesForBookingTimeOffTimeOffTypeReference1[] GetEligibleTimeOffTypesForBookingTimeOff(Uri userUri)Get eligible list of time off types for booking, e.g. which should be assigned to the user and enabled and non holiday type
GetEnabledTimeOffTypesTimeOffTypeReference1[] GetEnabledTimeOffTypes()Retrieve a list of all time off types in the system that are enabled
GetHolidayTimeOffPolicyTimeOffHolidayTimeOffPolicyDetails1 GetHolidayTimeOffPolicy()Get holiday time off policy
GetManualAccrualAdjustmentDetailsForDateRangeManualAccrualAdjustmentDetails1[] GetManualAccrualAdjustmentDetailsForDateRange(Uri userUri, Uri timeOffTypeUri, DateRangeParameter1 dateRange)Gets the total of all manual accrual adjustments for the given user, timeoff type and date.
GetMostRecentValidationResultObjectValidationResult1 GetMostRecentValidationResult(Uri timeOffUri)Get last time off validation result. Will be null if time off was never validated.
GetObjectExtensionDefinitionsForTimeOffTypeObjectExtensionDefinitionReference1[] GetObjectExtensionDefinitionsForTimeOffType(Uri timeOffTypeUri)Get all object extension definitions configured for time off type
GetPageOfEligibleTimeOffOwnersByTextSearch2UserReference1[] GetPageOfEligibleTimeOffOwnersByTextSearch2(Int32 page, Int32 pageSize, Uri[] dataAccessLevelUris, UserTextSearchParameter1 textSearch)Gets users that can have time off booked on their behalf.
GetPageOfTimeOffTypesFilteredBySearchTimeOffTypeReference1[] GetPageOfTimeOffTypesFilteredBySearch(Int32 page, Int32 pageSize, TimeOffTypeSearchParameter1 timeOffTypeSearch)Retrieve a list of all time off types search by include/exclude holiday time off type, time off type status and text search
GetScheduleReferenceForTimeOffTimeOffScheduleReferenceDetails1[] GetScheduleReferenceForTimeOff(Uri timeOffUri, DateRangeParameter1 dateRange)Get the reference expected cost overlapping a specific time off or over a range of dates for the time off user, based on the user's scheduled hours.
GetScheduleReferenceForTimeOffInDateRangeTimeOffScheduleReferenceDetails1[] GetScheduleReferenceForTimeOffInDateRange(Uri userUri, DateRangeParameter1 dateRange)Get the reference expected cost of taking time off over a range of dates, based on the user's scheduled hours.
GetTimeOffAccrualTransactionsForUserAndTimeOffTypeTimeOffTransactionSummary1 GetTimeOffAccrualTransactionsForUserAndTimeOffType(Uri userUri, Uri timeOffTypeUri, DateRangeParameter1 dateRange)Gets the series of time off transactions for a given user and time off type, over a particular date range. If the date range is blank, we assume from the last reset until today or the last future time off
GetTimeOffBalanceSummaryForUserAndTimeOffTypeTimeOffBalanceSummaryForDate1 GetTimeOffBalanceSummaryForUserAndTimeOffType(Uri userUri, Uri timeOffTypeUri, Date1 asOfDate)Get the balance summary information for a user for a given time off type, as of a certain date. No past or future aggregations (relative to the as-of date) are included.
GetTimeOffDeleteBatchResultsTimeOffDeleteBatchResults1 GetTimeOffDeleteBatchResults(Uri timeOffDeleteBatchUri)Retrieve results of a completed ExecuteTimeOffDeleteBatch operation. Returns null if the batch has not completed.
GetTimeOffDetails2TimeOffDetails2 GetTimeOffDetails2(Uri timeOffUri)Get the details of a given time off
GetTimeOffDetailsForUserAndDateRange2TimeOffDetails2[] GetTimeOffDetailsForUserAndDateRange2(Uri userUri, DateRangeParameter1 dateRange)Get all time off bookings for a user, which overlap with a date range.
GetTimeOffEstimateTransactionSummaryPriorToProposedTimeOffTimeOffEstimateTransactionSummary1 GetTimeOffEstimateTransactionSummaryPriorToProposedTimeOff(TimeOffParameter2 timeOff)Returns transaction summary information leading up to the proposed time off booking changes.
GetTimeOffInLieuRequestsForUserAndDateRangeTimeOffInLieuRequestDetails1[] GetTimeOffInLieuRequestsForUserAndDateRange(UserTargetParameter1 user, DateRangeParameter1 dateRange)Get TOIL requests
GetTimeOffOwnerUserReference1 GetTimeOffOwner(Uri timeOffUri)Get the owner of a given time off
GetTimeOffPolicyForTimeOffTypeForUserUserTimeOffPolicyForTimeOffTypeDetails1 GetTimeOffPolicyForTimeOffTypeForUser(Uri userUri, Uri timeOffTypeUri)Get the time off settings for the specified user and time off type
GetTimeOffPolicyForUser2UserTimeOffPolicyDetails1 GetTimeOffPolicyForUser2(Uri userUri)Get the time off settings for the specified user
GetTimeOffScriptCalculationStatusTimeOffScriptCalculationStatusDetails1 GetTimeOffScriptCalculationStatus(Uri userUri, Uri timeOffTypeUri)Gets the Script Out of Date status for a respective user and timeoff type
GetTimeOffTakenSeriesForUserUserTimeOffTakenTimeSeries1 GetTimeOffTakenSeriesForUser(Uri userUri, DateRangeParameter1 dateRange, Uri periodResolutionUri, Uri timeOffTypeUri)Get the data series summarizing the amount of time off taken by a user over a timespan
GetTimeOffTransactionSummaryForUserAndDateRangeUserTimeOffTransactionsInDateRangeSummary1 GetTimeOffTransactionSummaryForUserAndDateRange(Uri userUri, Uri timeOffTypeUri, DateRangeParameter1 dateRange)Returns user balance summary for a time off within a date range
GetTimeOffTypeAssignmentsForUserTimeOffTypeReference1[] GetTimeOffTypeAssignmentsForUser(Uri userUri)Get the list of time off types assigned to a given user
GetTimeOffTypeDetailsTimeOffTypeDetails1 GetTimeOffTypeDetails(Uri timeOffTypeUri)Retrieve details of a time off type
GetTimeOffTypesAvailableForTimeOffTimeOffTypeReference1[] GetTimeOffTypesAvailableForTimeOff(Uri timeOffUri)Get the list of time off types available for a given timeoff
GetTimeOffTypeUriFromSlugUri GetTimeOffTypeUriFromSlug(String timeOffTypeSlug)Convert a time off type slug to a URI
GetTimeOffUriFromSlugUri GetTimeOffUriFromSlug(String timeOffSlug)Convert a time off slug into a URI
GetUserTimeOffICalFeedDetailsUserTimeOffICalFeedDetails GetUserTimeOffICalFeedDetails(Uri userUri)Get the URL of the iCal feed for a given user's time off, if one exists
GetUserTimeOffTypeBalanceSummaryUserTimeOffTypeBalanceSummary1 GetUserTimeOffTypeBalanceSummary(Uri userUri, Uri timeOffTypeUri, Date1 asOfDate)Get the balance summary information for a user for a given time off type, as of a certain date. Optionally, exclude certain planned or unplanned time offs from the calculation.
GetUserTimeOffTypeHistoryDetailsUserTimeOffHistoryByTimeOffTypeDetails1 GetUserTimeOffTypeHistoryDetails(Uri userUri, Uri timeOffTypeUri, DateRangeParameter1 dateRange)Gets the series of time off events for a given user and time off type, over a particular date range. If the date range is blank, we assume from the last reset until today or the last future time off
GetUserTimeOffTypePolicyDetailsUserTimeOffTypePolicyScheduleEntryDetails1 GetUserTimeOffTypePolicyDetails(Uri userUri, Uri timeOffTypeUri, Date1 asOfDate)Gets the details of a user's time off policy for a given time off type, as of some date.
PublishTimeOffDraftTimeOffReference1 PublishTimeOffDraft(Uri timeOff)Publish a draft time off
PublishTimeOffTypeDraftTimeOffTypeReference1 PublishTimeOffTypeDraft(Uri timeOffType)Publish time off type draft
PutBankedTimeOffPolicyForUservoid PutBankedTimeOffPolicyForUser(Uri userUri, UserBankedTimePolicyParameter1 policy)Put the banked time settings for the specified user
PutDefaultTimeOffTypeForBookingsForUservoid PutDefaultTimeOffTypeForBookingsForUser(Uri userUri, Uri timeOffTypeUri)Set the default time off type for new bookings for a given user
PutManualAccrualAdjustmentvoid PutManualAccrualAdjustment(Uri userUri, Uri timeOffTypeUri, Date1 date, CalendarDayDuration1 timeToAccrue)Creates a manual accural adjustment for the given user, timeoff type and date. Note that any pre-existing manual accruals for the given user, timeoff type and date will be deleted and replaced with the new duration.
PutTimeOff2TimeOffReference1 PutTimeOff2(TimeOffParameter2 timeOff)Put the specified time off. The time off must exist already: you cannot create a new one with this service.
PutTimeOffExtensionFieldValuesvoid PutTimeOffExtensionFieldValues(Uri timeOffUri, ObjectExtensionFieldValueParameter1[] extensionFieldValues)Put Extension Field values on the Time Off booking
PutTimeOffPolicyForTimeOffTypeForUservoid PutTimeOffPolicyForTimeOffTypeForUser(Uri userUri, Uri timeOffTypeUri, Boolean isTimeOffAllowed, UserTimeOffTypePolicyScheduleEntryParameter1[] policySchedule)Put the time off settings for the specified user and time off type
PutTimeOffPolicyForUservoid PutTimeOffPolicyForUser(Uri userUri, UserTimeOffPolicyParameter1 policy)Put the time off settings for the specified user
PutTimeOffTypeTimeOffTypeReference1 PutTimeOffType(TimeOffTypeParameter1 timeOffType)Configure a new or existing time off type.
PutTimeOffTypeAssignmentsForUservoid PutTimeOffTypeAssignmentsForUser(Uri userUri, Uri[] timeOffTypeUris)Update time off type assignments for user
RecalculateTimeOffTransactionsForUserAndTimeOffTypevoid RecalculateTimeOffTransactionsForUserAndTimeOffType(Uri userUri, Uri timeOffTypeUri, Date1 invalidationDate)Recalculate the transactions for the specified user and time off type, from the invalidation date forward.
UpateTimeOffCommentsvoid UpateTimeOffComments(Uri timeOffUri, String comments)Change the user comment of a time off
UpdateHolidayTimeOffPolicyToAllowForTimeOffTypevoid UpdateHolidayTimeOffPolicyToAllowForTimeOffType(Uri timeOffTypeUri)Update holiday time off to allow bookings against specified time off type
UpdateHolidayTimeOffPolicyToNotAllowTimeOffOnHolidaysvoid UpdateHolidayTimeOffPolicyToNotAllowTimeOffOnHolidays()Update holiday time off policy to prevent time off on holidays
UpdateHolidayTimeOffPolicyToPrepopulateAgainstTimeOffTypevoid UpdateHolidayTimeOffPolicyToPrepopulateAgainstTimeOffType(Uri timeOffTypeUri)Update holiday time off to prepopulate bookings against specified time off type
UpdateICalFeedDateRangeForAllUsersvoid UpdateICalFeedDateRangeForAllUsers(Int32 daysBeforeToday, Int32 daysAfterToday)Set the date bounds of the iCal feeds. This is a system-wide setting.
UpdateTimeOffCommentsvoid UpdateTimeOffComments(Uri timeOffUri, String comments)Change the user comment of a time off
UpdateTimeOffTypevoid UpdateTimeOffType(Uri timeOffUri, Uri timeOffTypeUri)Change the time off type describing this time off
UpdateTimeOffTypeMinimumTimeOffIncrementPolicyvoid UpdateTimeOffTypeMinimumTimeOffIncrementPolicy(Uri timeOffType, Uri timeOffMinimumIncrementUri)Change default time off minimum increment policy for all time off entered
UpdateTimeOffTypeStartEndTimeSpecificationRequirementPolicyvoid UpdateTimeOffTypeStartEndTimeSpecificationRequirementPolicy(Uri timeOffType, Uri timeOffStartEndTimeSpecificationRequirementUri)Set time off start/end time policy for all time off entered
ValidateValidationResultsSummary1 Validate(Uri timeOffUri)Validate the time off
ValidateDeleteTimeOffForUserValidationResultsSummary1 ValidateDeleteTimeOffForUser(Uri timeOffUri, Uri userUri)Ensure whether or not it would be valid for the given user to delete the specified time off.