POST api/v1/departments
Creates a new Department
Request Information
URI Parameters
None.
Body Parameters
CreateDepartmentModel| Name | Description | Type | Additional information |
|---|---|---|---|
| FacilityId | integer |
Required |
|
| Code | string |
Required String length: inclusive between 0 and 10 |
|
| Description | string |
Required String length: inclusive between 0 and 40 |
|
| ScheduleFormatId | integer |
None. |
|
| Disabled | boolean |
Required |
|
| AutoRelease | boolean |
Required |
|
| AutoReleaseHours | integer |
Required |
|
| AutoConfirm | boolean |
None. |
|
| DisableSelfSchedule | boolean |
Required |
|
| LimitSelfScheduleToTarget | boolean |
Required |
|
| IncludeInMORReport | boolean |
Required |
|
| HRDepartmentCode | string |
Required String length: inclusive between 0 and 10 |
|
| KronosExportEnabled | boolean |
Required |
|
| KronosImportEnabled | boolean |
Required |
|
| IsasStaffingGridStatusId | integer |
Required Range: inclusive between 1 and 4 |
|
| IsasVolumeForecastStatusId | integer |
Required Range: inclusive between 1 and 4 |
|
| UnitOfServiceLabel | string |
Required String length: inclusive between 0 and 15 |
|
| CredentialTrackingStatusId | integer |
None. |
|
| DaysBeforeCredExpToBlock | integer |
Range: inclusive between 0 and 14 |
|
| DefaultPatientClassificationRating | decimal number |
Required |
|
| AccountingUnit | string |
Required String length: inclusive between 0 and 10 |
|
| ClusterId | globally unique identifier |
None. |
|
| DepartmentStaffingGroupId | globally unique identifier |
None. |
|
| CensusInterface | boolean |
Required |
|
| UseFacilitySchedulePhaseAutomationTime | boolean |
None. |
|
| SchedulePhaseAutomationTime | date |
None. |
Request Formats
application/json, text/json
Sample:
{
"FacilityId": 1,
"Code": "sample string 2",
"Description": "sample string 3",
"ScheduleFormatId": 1,
"Disabled": true,
"AutoRelease": true,
"AutoReleaseHours": 6,
"AutoConfirm": true,
"DisableSelfSchedule": true,
"LimitSelfScheduleToTarget": true,
"IncludeInMORReport": true,
"HRDepartmentCode": "sample string 10",
"KronosExportEnabled": true,
"KronosImportEnabled": true,
"IsasStaffingGridStatusId": 13,
"IsasVolumeForecastStatusId": 14,
"UnitOfServiceLabel": "sample string 15",
"CredentialTrackingStatusId": 1,
"DaysBeforeCredExpToBlock": 1,
"DefaultPatientClassificationRating": 16.0,
"AccountingUnit": "sample string 17",
"ClusterId": "9f9530dd-5140-4162-885f-6f1e12aa96fd",
"DepartmentStaffingGroupId": "e2cb3820-9b9b-40f3-9f65-23394773c174",
"CensusInterface": true,
"UseFacilitySchedulePhaseAutomationTime": true,
"SchedulePhaseAutomationTime": "2026-01-03T23:15:19.1800916-06:00"
}
Response Information
Resource Description
ApiResponseModelOfCreateDepartmentModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | ApiResponseDataModelOfCreateDepartmentModel |
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": {
"FacilityId": 1,
"Code": "sample string 2",
"Description": "sample string 3",
"ScheduleFormatId": 1,
"Disabled": true,
"AutoRelease": true,
"AutoReleaseHours": 6,
"AutoConfirm": true,
"DisableSelfSchedule": true,
"LimitSelfScheduleToTarget": true,
"IncludeInMORReport": true,
"HRDepartmentCode": "sample string 10",
"KronosExportEnabled": true,
"KronosImportEnabled": true,
"IsasStaffingGridStatusId": 13,
"IsasVolumeForecastStatusId": 14,
"UnitOfServiceLabel": "sample string 15",
"CredentialTrackingStatusId": 1,
"DaysBeforeCredExpToBlock": 1,
"DefaultPatientClassificationRating": 16.0,
"AccountingUnit": "sample string 17",
"ClusterId": "aeb08e16-33d7-4910-a134-1f9d956e1af1",
"DepartmentStaffingGroupId": "8bda91fb-a7ff-4e0e-a131-f693443a8933",
"CensusInterface": true,
"UseFacilitySchedulePhaseAutomationTime": true,
"SchedulePhaseAutomationTime": "2026-01-03T23:15:19.1957089-06:00"
}
},
"Errors": [
"sample string 1",
"sample string 2"
],
"Warnings": [
"sample string 1",
"sample string 2"
]
}