GET api/v1/needsaggregationmetrics/departments/{departmentIds}/{startDateTime}/{endDateTime}
Get departments metrics the departmentids must be comma separated integers. This is an asynchronous service.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| departmentIds | string |
Required |
|
| startDateTime | date |
Required |
|
| endDateTime | date |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of NeedsAggregationMetricResult| Name | Description | Type | Additional information |
|---|---|---|---|
| DepartmentId | integer |
None. |
|
| FacilityId | integer |
None. |
|
| FacilityCoId | string |
None. |
|
| FacilityName | string |
None. |
|
| ClusterId | globally unique identifier |
None. |
|
| ClusterName | string |
None. |
|
| DeptCode | string |
None. |
|
| HRDeptCode | string |
None. |
|
| DepartmentName | string |
None. |
|
| DeptSummaryId | integer |
None. |
|
| Date | date |
None. |
|
| SummaryStartDateTime | date |
None. |
|
| SummaryEndDateTime | date |
None. |
|
| StaffTo | integer |
None. |
|
| ActualCensus | integer |
None. |
|
| ForecastCensus | integer |
None. |
|
| DeptSkillID | integer |
None. |
|
| FsSkillLevelID | integer |
None. |
|
| SkillLevelDesc | string |
None. |
|
| SkillCode | string |
None. |
|
| CensusLow | integer |
None. |
|
| CensusPeak | integer |
None. |
|
| Scheduled | decimal number |
None. |
|
| Target | decimal number |
None. |
|
| Difference | decimal number |
None. |
|
| PercentScheduled | decimal number |
None. |
|
| SchCensusLow | integer |
None. |
|
| SchCensusPeak | integer |
None. |
|
| SchTarget | decimal number |
None. |
|
| SchDifference | decimal number |
None. |
|
| SchPercentScheduled | decimal number |
None. |
|
| SortOrder | integer |
None. |
|
| CreatedDateUtc | date |
None. |
|
| LastModifiedUtc | date |
None. |
|
| Overtimes | integer |
None. |
|
| TargetCensusLow | integer |
None. |
|
| TargetCensusPeak | integer |
None. |
|
| PcsRangeName | string |
None. |
|
| PCSRating | decimal number |
None. |
|
| PCSTotalCensus | integer |
None. |
|
| PCSEnabled | boolean |
None. |
|
| DateChangedUTC | date |
None. |
|
| DayOfWeek | integer |
None. |
|
| PartOfDay | integer |
None. |
|
| SkillLevelCategoryId | integer |
None. |
|
| SkillLevelCategoryDesc | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"DepartmentId": 1,
"FacilityId": 2,
"FacilityCoId": "sample string 3",
"FacilityName": "sample string 4",
"ClusterId": "5a8b5e78-c1ae-4364-84e5-50ebe9bdf91b",
"ClusterName": "sample string 5",
"DeptCode": "sample string 6",
"HRDeptCode": "sample string 7",
"DepartmentName": "sample string 8",
"DeptSummaryId": 9,
"Date": "2026-01-02T08:37:34.1782316-06:00",
"SummaryStartDateTime": "2026-01-02T08:37:34.1782316-06:00",
"SummaryEndDateTime": "2026-01-02T08:37:34.1782316-06:00",
"StaffTo": 1,
"ActualCensus": 1,
"ForecastCensus": 13,
"DeptSkillID": 14,
"FsSkillLevelID": 15,
"SkillLevelDesc": "sample string 16",
"SkillCode": "sample string 17",
"CensusLow": 18,
"CensusPeak": 19,
"Scheduled": 20.1,
"Target": 21.1,
"Difference": 22.1,
"PercentScheduled": 23.1,
"SchCensusLow": 24,
"SchCensusPeak": 25,
"SchTarget": 26.1,
"SchDifference": 27.1,
"SchPercentScheduled": 28.1,
"SortOrder": 29,
"CreatedDateUtc": "2026-01-02T08:37:34.1782316-06:00",
"LastModifiedUtc": "2026-01-02T08:37:34.1782316-06:00",
"Overtimes": 32,
"TargetCensusLow": 33,
"TargetCensusPeak": 34,
"PcsRangeName": "sample string 35",
"PCSRating": 1.0,
"PCSTotalCensus": 1,
"PCSEnabled": true,
"DateChangedUTC": "2026-01-02T08:37:34.1782316-06:00",
"DayOfWeek": 37,
"PartOfDay": 38,
"SkillLevelCategoryId": 39,
"SkillLevelCategoryDesc": "sample string 40"
},
{
"DepartmentId": 1,
"FacilityId": 2,
"FacilityCoId": "sample string 3",
"FacilityName": "sample string 4",
"ClusterId": "5a8b5e78-c1ae-4364-84e5-50ebe9bdf91b",
"ClusterName": "sample string 5",
"DeptCode": "sample string 6",
"HRDeptCode": "sample string 7",
"DepartmentName": "sample string 8",
"DeptSummaryId": 9,
"Date": "2026-01-02T08:37:34.1782316-06:00",
"SummaryStartDateTime": "2026-01-02T08:37:34.1782316-06:00",
"SummaryEndDateTime": "2026-01-02T08:37:34.1782316-06:00",
"StaffTo": 1,
"ActualCensus": 1,
"ForecastCensus": 13,
"DeptSkillID": 14,
"FsSkillLevelID": 15,
"SkillLevelDesc": "sample string 16",
"SkillCode": "sample string 17",
"CensusLow": 18,
"CensusPeak": 19,
"Scheduled": 20.1,
"Target": 21.1,
"Difference": 22.1,
"PercentScheduled": 23.1,
"SchCensusLow": 24,
"SchCensusPeak": 25,
"SchTarget": 26.1,
"SchDifference": 27.1,
"SchPercentScheduled": 28.1,
"SortOrder": 29,
"CreatedDateUtc": "2026-01-02T08:37:34.1782316-06:00",
"LastModifiedUtc": "2026-01-02T08:37:34.1782316-06:00",
"Overtimes": 32,
"TargetCensusLow": 33,
"TargetCensusPeak": 34,
"PcsRangeName": "sample string 35",
"PCSRating": 1.0,
"PCSTotalCensus": 1,
"PCSEnabled": true,
"DateChangedUTC": "2026-01-02T08:37:34.1782316-06:00",
"DayOfWeek": 37,
"PartOfDay": 38,
"SkillLevelCategoryId": 39,
"SkillLevelCategoryDesc": "sample string 40"
}
]