IDepartmentService1
Operations
Name
Signature
Description
BulkDelete
DepartmentBulkDeleteResults1 BulkDelete(Uri[] departmentUris, Uri departmentBulkDeleteOptionUri)
Delete the specified departments
BulkGetDepartments
DepartmentReference1[] BulkGetDepartments(Uri[] departmentUris)
Retrieves references for the specified departments. If the specified department cannot be found, it will be omitted from the results
CreateEditDraft
Uri CreateEditDraft(Uri departmentUri)
Create a draft of an existing department.
CreateNewDraft
Uri CreateNewDraft(Uri parentDepartmentUri)
Create a new department draft.
Delete
void Delete(Uri departmentUri)
Delete a department. A department can only be deleted if it has no users assigned to it.
Disable
void 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.
Enable
void Enable(Uri departmentUri)
Enable the department so it can have users assigned to it.
GetAllDepartmentHierarchyDetails
DepartmentHierarchyDetails1 GetAllDepartmentHierarchyDetails()
Retrieves all departments.
GetChildrenDepartmentDetails
DepartmentDetails1[] GetChildrenDepartmentDetails(Uri parentDepartmentUri)
Get the details for all the first level children of the provided department
GetCompanyDepartment
DepartmentReference1 GetCompanyDepartment()
Retrieves the top-level company department.
GetCompanyDepartmentDetails
DepartmentDetails1 GetCompanyDepartmentDetails()
Retrieves the top-level company department.
GetDepartmentAncestry
DepartmentAncestryReference1 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
GetDepartmentDetails
DepartmentDetails1 GetDepartmentDetails(Uri departmentUri)
Retrieves a single department's details.
GetDepartmentForUser
DepartmentReference1 GetDepartmentForUser(Uri userUri)
Get the department of a user or user draft.
GetDepartmentHierarchyDetails
DepartmentHierarchyDetails1 GetDepartmentHierarchyDetails(Uri rootDepartmentUri)
Get the details for the entire department hierarchy below the provided department
GetDepartmentHierarchyLocationDetails
DepartmentHierachyLocationDetails1 GetDepartmentHierarchyLocationDetails(Uri departmentUri)
Get the details of the location of the given department within the department hierarchy
GetEnabledDepartmentDetails
DepartmentDetails1[] GetEnabledDepartmentDetails()
Retrieves all enabled departments
GetEnabledDepartmentHierarchyDetails
DepartmentHierarchyDetails1 GetEnabledDepartmentHierarchyDetails()
Retrieves all enabled departments.
GetEnabledDepartments
DepartmentReference1[] GetEnabledDepartments()
Retrieves all enabled departments
GetIsLegacyDepartmentEnabled
Boolean GetIsLegacyDepartmentEnabled()
Returns legacy department policy is enabled
GetPageOfDepartmentsByTextSearch
DepartmentSearchResult1[] GetPageOfDepartmentsByTextSearch(Int32 page, Int32 pageSize, DepartmentTextSearchParameter1 textSearch)
Searches for departments matching a given text search parameter along with its parent dapartments
MoveDepartment
void MoveDepartment(Uri departmentUri, Uri targetUri)
Move a department from its current location to the target location.
PublishDraft
DepartmentReference1 PublishDraft(Uri draftUri)
Publish the department draft into a persisted department.
PutDepartment
DepartmentReference1 PutDepartment(DepartmentParameter1 department)
Put the specified department.
PutDepartmentHierarchy
DepartmentHierarchyPutResults1 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
UpdateCode
void UpdateCode(Uri departmentUri, String code)
Modify the code of a department or department draft.
UpdateComments
void UpdateComments(Uri departmentUri, String comments)
Modify the comments of a department or department draft.
UpdateDepartmentForUser
void UpdateDepartmentForUser(Uri userUri, Uri departmentUri)
Modify the department of a user or user draft.
UpdateName
void UpdateName(Uri departmentUri, String name)
Modify the name of a department or department draft.