IDepartmentService1

Operations

NameSignatureDescription
BulkDeleteDepartmentBulkDeleteResults1 BulkDelete(Uri[] departmentUris, Uri departmentBulkDeleteOptionUri)Delete the specified departments
BulkGetDepartmentsDepartmentReference1[] BulkGetDepartments(Uri[] departmentUris)Retrieves references for the specified departments. If the specified department cannot be found, it will be omitted from the results
CreateEditDraftUri CreateEditDraft(Uri departmentUri)Create a draft of an existing department.
CreateNewDraftUri CreateNewDraft(Uri parentDepartmentUri)Create a new department draft.
Deletevoid Delete(Uri departmentUri)Delete a department. A department can only be deleted if it has no users assigned to it.
Disablevoid Disable(Uri departmentUri)Disables the department so it cannot have users assigned to it. This operation requires that no enabled users are present in that department.
Enablevoid Enable(Uri departmentUri)Enable the department so it can have users assigned to it.
GetAllDepartmentHierarchyDetailsDepartmentHierarchyDetails1 GetAllDepartmentHierarchyDetails()Retrieves all departments.
GetChildrenDepartmentDetailsDepartmentDetails1[] GetChildrenDepartmentDetails(Uri parentDepartmentUri)Get the details for all the first level children of the provided department
GetCompanyDepartmentDepartmentReference1 GetCompanyDepartment()Retrieves the top-level company department.
GetCompanyDepartmentDetailsDepartmentDetails1 GetCompanyDepartmentDetails()Retrieves the top-level company department.
GetDepartmentAncestryDepartmentAncestryReference1 GetDepartmentAncestry(Uri departmentUri)Get the ancestry (i.e. the parent departments) of the specified department. Will return null if this is the root-level (i.e. company) department
GetDepartmentDetailsDepartmentDetails1 GetDepartmentDetails(Uri departmentUri)Retrieves a single department's details.
GetDepartmentForUserDepartmentReference1 GetDepartmentForUser(Uri userUri)Get the department of a user or user draft.
GetDepartmentHierarchyDetailsDepartmentHierarchyDetails1 GetDepartmentHierarchyDetails(Uri rootDepartmentUri)Get the details for the entire department hierarchy below the provided department
GetDepartmentHierarchyLocationDetailsDepartmentHierachyLocationDetails1 GetDepartmentHierarchyLocationDetails(Uri departmentUri)Get the details of the location of the given department within the department hierarchy
GetEnabledDepartmentDetailsDepartmentDetails1[] GetEnabledDepartmentDetails()Retrieves all enabled departments
GetEnabledDepartmentHierarchyDetailsDepartmentHierarchyDetails1 GetEnabledDepartmentHierarchyDetails()Retrieves all enabled departments.
GetEnabledDepartmentsDepartmentReference1[] GetEnabledDepartments()Retrieves all enabled departments
GetIsLegacyDepartmentEnabledBoolean GetIsLegacyDepartmentEnabled()Returns legacy department policy is enabled
GetPageOfDepartmentsByTextSearchDepartmentSearchResult1[] GetPageOfDepartmentsByTextSearch(Int32 page, Int32 pageSize, DepartmentTextSearchParameter1 textSearch)Searches for departments matching a given text search parameter along with its parent dapartments
MoveDepartmentvoid MoveDepartment(Uri departmentUri, Uri targetUri)Move a department from its current location to the target location.
PublishDraftDepartmentReference1 PublishDraft(Uri draftUri)Publish the department draft into a persisted department.
PutDepartmentDepartmentReference1 PutDepartment(DepartmentParameter1 department)Put the specified department.
PutDepartmentHierarchyDepartmentHierarchyPutResults1 PutDepartmentHierarchy(DepartmentHierarchyParameter1 departmentHierarchy)Put the entire department hierarchy. Any departments that are specified as targets by name that do not already exist will be created
UpdateCodevoid UpdateCode(Uri departmentUri, String code)Modify the code of a department or department draft.
UpdateCommentsvoid UpdateComments(Uri departmentUri, String comments)Modify the comments of a department or department draft.
UpdateDepartmentForUservoid UpdateDepartmentForUser(Uri userUri, Uri departmentUri)Modify the department of a user or user draft.
UpdateNamevoid UpdateName(Uri departmentUri, String name)Modify the name of a department or department draft.