IDivisionService1

Operations

NameSignatureDescription
BulkGetDivisionDetailsDivisionDetails1[] BulkGetDivisionDetails(Uri[] divisionUris)Retrieves a set of divisions' details.
BulkGetDivisionsDivisionReference1[] BulkGetDivisions(Uri[] divisionUris)Bulk get divisions from their URI. If a URI is not found, it will be omitted from the results.
BulkGetDivisions2BulkGetDivisionsResult1[] BulkGetDivisions2(Uri[] divisionUris)Bulk get divisions from their URI
BulkGetDivisionScheduleForUsersBulkGetDivisionScheduleResult1[] BulkGetDivisionScheduleForUsers(Uri[] userUris)Bulk Get the Division assignment schedule for the specified users
BulkGetDivisionsInPolicyDataAccessScopeDivisionBulkGetResult1[] BulkGetDivisionsInPolicyDataAccessScope(Uri[] divisionUris, Uri policyUri)Retrieves a set of divisions, filtered to those which are accessible in the given policy. Divisions which are not accessible are not returned. Contextual ancestors are included in the result.
CreateDivisionDeleteBatchUri CreateDivisionDeleteBatch(DivisionTargetParameter2[] divisions, Uri divisionBulkDeleteOptionUri)Create a batch operation for bulk deleting divisions by target
CreateDivisionHierarchyOrApplyModificationsDivisionHierarchyModificationResult1[] CreateDivisionHierarchyOrApplyModifications(DivisionHierarchyModificationParameter1[] hierarchy, Uri modificationOptionUri, String unitOfWorkId)Create new Division or apply modification to existing Division
CreateDivisionOrApplyModificationDivisionReference1 CreateDivisionOrApplyModification(DivisionTargetParameter2 division, DivisionModificationsParameter1 modifications, String unitOfWorkId)Create Division or apply modifications to an existing Division
CreateEditDraftUri CreateEditDraft(Uri divisionUri)Create a draft of an existing division.
CreateNewDraftUri CreateNewDraft(Uri parentDivisionUri)Create a new division draft.
Deletevoid Delete(Uri divisionUri)Delete a division. A division can only be deleted if it has no users assigned to it (past, present, or future).
Disablevoid Disable(Uri divisionUri)Disables the division so it can no longer have any additional users assigned to it.
Enablevoid Enable(Uri divisionUri)Enable the division so it can have additional users assigned to it.
GetAllDivisionsDivisionReference1[] GetAllDivisions()Retrieves all divisions.
GetDivisionDeleteBatchResultsDivisionDeleteBatchResults1 GetDivisionDeleteBatchResults(Uri divisionDeleteBatchUri)Retrieve results of a completed DivisionDeleteBatch operation. Returns null if the batch has not completed.
GetDivisionDetailsDivisionDetails1 GetDivisionDetails(Uri divisionUri)Retrieves a single division's details.
GetDivisionScheduleForUserDivisionScheduleEntryDetails1[] GetDivisionScheduleForUser(Uri userUri)Get the Division assignment schedule for the specified user
GetDivisionsSystemSettingsDivisionSystemSettingsDetails1 GetDivisionsSystemSettings()Gets all settings for the system-wide divisions feature, including language settings for all supported languages.
GetDivisionsSystemSettingsLanguageDetailsDivisionSystemSettingsLanguageDetails1 GetDivisionsSystemSettingsLanguageDetails()Retrieves the language settings for the current user's language.
GetEnabledDivisionsDivisionReference1[] GetEnabledDivisions()Retrieves all enabled divisions
GetJsonKeyValueForDivisionJsonKeyValue1 GetJsonKeyValueForDivision(DivisionTargetParameter1 division, String jsonKey)get division json key value for key
GetPageOfAvailableDivisionsByTextSearchDivisionSearchResult1[] GetPageOfAvailableDivisionsByTextSearch(Int32 page, Int32 pageSize, DivisionTextSearchParameter1 textSearch)Searches for Divisions matching a given text search parameter which users can be assigned to
GetPageOfDivisionsInPolicyDataAccessScopeDivisionSearchResult1[] GetPageOfDivisionsInPolicyDataAccessScope(Int32 pageIndex, Int32 pageSize, Uri policyUri, DivisionSearchParameter1 divisionSearch)Get a page of Divisions which are accessable for the given policy
MoveDivisionvoid MoveDivision(DivisionTargetParameter2 division, DivisionTargetParameter2 target)Move Division from its current location to the target location.
PublishDraftDivisionReference1 PublishDraft(Uri draftUri)Publish the division draft into a persisted division.
PutDivisionScheduleForUservoid PutDivisionScheduleForUser(Uri userUri, DivisionScheduleEntryParameter1[] scheduleEntries)Put the entire Division assignment schedule for the specified user
PutDivisionsSystemSettingsvoid PutDivisionsSystemSettings(Boolean isEnabled, DivisionSystemSettingsLanguageParameter1[] languageSettings)Puts all settings for the system-wide divisions feature, any supported languages not specified will be reverted to their default settings.
PutJsonKeyValueForDivisionvoid PutJsonKeyValueForDivision(DivisionTargetParameter1 division, JsonKeyValue1 jsonKeyValue)put division json key value
UpdateCodevoid UpdateCode(Uri divisionUri, String code)Modify the code of a division.
UpdateDescriptionvoid UpdateDescription(Uri divisionUri, String description)Modify the description of a division.
UpdateNamevoid UpdateName(Uri divisionUri, String name)Modify the name of a division.