PUT api/v1/departments
Updates the department information
Request Information
URI Parameters
None.
Body Parameters
UpdateDepartmentModel| Name | Description | Type | Additional information |
|---|---|---|---|
| DepartmentId | integer |
Required |
|
| 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:
{
"DepartmentId": 1,
"FacilityId": 2,
"Code": "sample string 3",
"Description": "sample string 4",
"ScheduleFormatId": 1,
"Disabled": true,
"AutoRelease": true,
"AutoReleaseHours": 7,
"AutoConfirm": true,
"DisableSelfSchedule": true,
"LimitSelfScheduleToTarget": true,
"IncludeInMORReport": true,
"HRDepartmentCode": "sample string 11",
"KronosExportEnabled": true,
"KronosImportEnabled": true,
"IsasStaffingGridStatusId": 14,
"IsasVolumeForecastStatusId": 15,
"UnitOfServiceLabel": "sample string 16",
"CredentialTrackingStatusId": 1,
"DaysBeforeCredExpToBlock": 1,
"DefaultPatientClassificationRating": 17.0,
"AccountingUnit": "sample string 18",
"ClusterId": "83d03a5d-6cd6-4987-baea-8e7064da50ec",
"DepartmentStaffingGroupId": "cd43aac7-c98c-432d-82b5-b9edd5fdcbc4",
"CensusInterface": true,
"UseFacilitySchedulePhaseAutomationTime": true,
"SchedulePhaseAutomationTime": "2026-01-03T23:34:05.9792481-06:00"
}
Response Information
Resource Description
ApiResponseModelOfDepartmentModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | ApiResponseDataModelOfDepartmentModel |
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": "7048de20-ec59-4388-a5f1-402a03016cd6",
"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": "6d73f571-4872-40de-9f4e-1d63226a7aff",
"DepartmentStaffingGroupId": "f2552cfc-9f87-4bbc-9df6-a600f068accf",
"CensusInterface": true,
"HrCompany": 1,
"ProcessLevel": 1,
"EffectiveDaysBeforeCredentialExpiresToBlock": 23,
"UseShiftTradeAutoApprovalRules": true,
"UseFacilitySchedulePhaseAutomationTime": true,
"SchedulePhaseAutomationTime": "2026-01-03T23:34:05.9948586-06:00"
}
},
"Errors": [
"sample string 1",
"sample string 2"
],
"Warnings": [
"sample string 1",
"sample string 2"
]
}