POST api/v1/workforceplans/getstaffingeffectiveness
Get Staffing Effectiveness. This is an asynchronous service.
Request Information
URI Parameters
None.
Body Parameters
WorkForceMetricsFilter| Name | Description | Type | Additional information |
|---|---|---|---|
| DashboardId | globally unique identifier |
None. |
|
| Facilities | Collection of integer |
None. |
|
| Clusters | Collection of integer |
None. |
|
| Departments | Collection of integer |
None. |
|
| CurrentShiftStartDateTime | date |
None. |
|
| CurrentShiftEndDateTime | date |
None. |
|
| NextShiftStartDateTime | date |
None. |
|
| NextShiftEndDateTime | date |
None. |
|
| CurrentDateTime | date |
None. |
|
| UserId | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"DashboardId": "7bd7d5a4-64ca-4929-a300-3bd4e7eca54f",
"Facilities": [
1,
2
],
"Clusters": [
1,
2
],
"Departments": [
1,
2
],
"CurrentShiftStartDateTime": "2026-01-02T20:17:58.1782387-06:00",
"CurrentShiftEndDateTime": "2026-01-02T20:17:58.1782387-06:00",
"NextShiftStartDateTime": "2026-01-02T20:17:58.1782387-06:00",
"NextShiftEndDateTime": "2026-01-02T20:17:58.1782387-06:00",
"CurrentDateTime": "2026-01-02T20:17:58.1782387-06:00",
"UserId": 1
}
Response Information
Resource Description
ApiResponseModelOfIEnumerableOfStaffingEffectivenessModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | ApiResponseDataModelOfIEnumerableOfStaffingEffectivenessModel |
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": [
{
"FacilityName": "sample string 1",
"DepartmentName": "sample string 2",
"CombinedForecast": "sample string 3",
"CombinedOtClPrn": "sample string 4",
"RNMax": 5.1,
"RNMin": 6.1,
"RN": 7.1,
"ChgRN": 8.1,
"SMax": 9.1,
"SMin": 10.1,
"PCTCNA": 11.1,
"ClinTech": 12.1,
"Clerical": 13.1
},
{
"FacilityName": "sample string 1",
"DepartmentName": "sample string 2",
"CombinedForecast": "sample string 3",
"CombinedOtClPrn": "sample string 4",
"RNMax": 5.1,
"RNMin": 6.1,
"RN": 7.1,
"ChgRN": 8.1,
"SMax": 9.1,
"SMin": 10.1,
"PCTCNA": 11.1,
"ClinTech": 12.1,
"Clerical": 13.1
}
]
},
"Errors": [
"sample string 1",
"sample string 2"
],
"Warnings": [
"sample string 1",
"sample string 2"
]
}