POST api/v1/departments/DepartmentsSearch

Get All Departments by Search criteria This is an asynchronous service.

Request Information

URI Parameters

None.

Body Parameters

DepartmentsSearchRequestModel
NameDescriptionTypeAdditional information
FacilityIds

Collection of integer

None.

Code

string

None.

Disabled

boolean

None.

AutoRelease

boolean

None.

DisableTieredScheduling

boolean

None.

StaffAssignmentToSecondaryDepartments

integer

None.

StaffSelfScheduleInSecondaryDepartments

integer

None.

StaffRequestOpenNeedsInSecondaryDepartments

integer

None.

StaffReceiveTradeAssignmentsInSecondaryDepartments

integer

None.

SecondaryStaffAssignmentToThisDepartment

integer

None.

SecondaryStaffSelfScheduleInThisDepartment

integer

None.

SecondaryStaffRequestOpenNeedsInThisDepartment

integer

None.

SecondaryStaffReceiveTradeAssignmentsInThisDepartment

integer

None.

IsOpenNeedsByShift

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "FacilityIds": [
    1,
    2
  ],
  "Code": "sample string 1",
  "Disabled": true,
  "AutoRelease": true,
  "DisableTieredScheduling": true,
  "StaffAssignmentToSecondaryDepartments": 1,
  "StaffSelfScheduleInSecondaryDepartments": 1,
  "StaffRequestOpenNeedsInSecondaryDepartments": 1,
  "StaffReceiveTradeAssignmentsInSecondaryDepartments": 1,
  "SecondaryStaffAssignmentToThisDepartment": 1,
  "SecondaryStaffSelfScheduleInThisDepartment": 1,
  "SecondaryStaffRequestOpenNeedsInThisDepartment": 1,
  "SecondaryStaffReceiveTradeAssignmentsInThisDepartment": 1,
  "IsOpenNeedsByShift": true
}

Response Information

Resource Description

ApiResponseModelOfListOfDepartmentModel
NameDescriptionTypeAdditional information
Data

ApiResponseDataModelOfListOfDepartmentModel

None.

Errors

Collection of string

None.

Warnings

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "PageSize": 1,
    "Page": 2,
    "TotalPages": 3,
    "TotalResults": 4,
    "Results": [
      {
        "DepartmentId": 1,
        "FacilityId": 2,
        "FacilityName": "sample string 3",
        "FacilityCoId": "sample string 4",
        "Code": "sample string 5",
        "Description": "sample string 6",
        "ScheduleFormatId": 1,
        "Disabled": true,
        "Version": "QEA=",
        "RowGuid": "0d46b82d-789f-446b-bad0-0d0fd853f8e8",
        "AutoRelease": true,
        "AutoReleaseHours": 10,
        "AutoConfirm": true,
        "DisableSelfSchedule": true,
        "LimitSelfScheduleToTarget": true,
        "IncludeInMORReport": true,
        "HRDepartmentCode": "sample string 14",
        "TAExportEnabled": true,
        "TAImportEnabled": true,
        "IsasStaffingGridStatusId": 17,
        "IsasVolumeForecastStatusId": 18,
        "UnitOfServiceLabel": "sample string 19",
        "CredentialTrackingStatusId": 1,
        "DaysBeforeCredExpToBlock": 1,
        "DefaultPatientClassificationRating": 20.0,
        "AccountingUnit": "sample string 21",
        "ClusterId": "12873a0a-a3a6-4629-bda4-c7c09670ae81",
        "DepartmentStaffingGroupId": "d8a97a38-2d5a-4a69-be26-155c0894d278",
        "CensusInterface": true,
        "HrCompany": 1,
        "ProcessLevel": 1,
        "EffectiveDaysBeforeCredentialExpiresToBlock": 23,
        "UseShiftTradeAutoApprovalRules": true,
        "UseFacilitySchedulePhaseAutomationTime": true,
        "SchedulePhaseAutomationTime": "2026-01-02T21:51:23.4585128-06:00"
      },
      {
        "DepartmentId": 1,
        "FacilityId": 2,
        "FacilityName": "sample string 3",
        "FacilityCoId": "sample string 4",
        "Code": "sample string 5",
        "Description": "sample string 6",
        "ScheduleFormatId": 1,
        "Disabled": true,
        "Version": "QEA=",
        "RowGuid": "0d46b82d-789f-446b-bad0-0d0fd853f8e8",
        "AutoRelease": true,
        "AutoReleaseHours": 10,
        "AutoConfirm": true,
        "DisableSelfSchedule": true,
        "LimitSelfScheduleToTarget": true,
        "IncludeInMORReport": true,
        "HRDepartmentCode": "sample string 14",
        "TAExportEnabled": true,
        "TAImportEnabled": true,
        "IsasStaffingGridStatusId": 17,
        "IsasVolumeForecastStatusId": 18,
        "UnitOfServiceLabel": "sample string 19",
        "CredentialTrackingStatusId": 1,
        "DaysBeforeCredExpToBlock": 1,
        "DefaultPatientClassificationRating": 20.0,
        "AccountingUnit": "sample string 21",
        "ClusterId": "12873a0a-a3a6-4629-bda4-c7c09670ae81",
        "DepartmentStaffingGroupId": "d8a97a38-2d5a-4a69-be26-155c0894d278",
        "CensusInterface": true,
        "HrCompany": 1,
        "ProcessLevel": 1,
        "EffectiveDaysBeforeCredentialExpiresToBlock": 23,
        "UseShiftTradeAutoApprovalRules": true,
        "UseFacilitySchedulePhaseAutomationTime": true,
        "SchedulePhaseAutomationTime": "2026-01-02T21:51:23.4585128-06:00"
      }
    ]
  },
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Warnings": [
    "sample string 1",
    "sample string 2"
  ]
}