PUT api/v1/Census/GetCensusForSummaryPeriod
Returns the department summaries for display for the time interval of daily roster. This is an asynchronous service.
Request Information
URI Parameters
None.
Body Parameters
CensusEditRequestModel| Name | Description | Type | Additional information |
|---|---|---|---|
| DeptId | integer |
Required |
|
| StartTime | date |
Required |
|
| EndTime | date |
Required |
Request Formats
application/json, text/json
Sample:
{
"DeptId": 1,
"StartTime": "2026-01-02T14:06:45.419961-06:00",
"EndTime": "2026-01-02T14:06:45.419961-06:00"
}
Response Information
Resource Description
ApiResponseModelOfListOfFsCensusEditReturnModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | ApiResponseDataModelOfListOfFsCensusEditReturnModel |
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": [
{
"DailyRosterStartTime": "2026-01-02T14:06:45.419961-06:00",
"DailyRosterEndTime": "2026-01-02T14:06:45.419961-06:00",
"Department": {
"FsFacilityID": 1,
"FacilityName": "sample string 2",
"FsDeptID": 3,
"CodeDescription": "sample string 4",
"PcsEnabled": true,
"CensusInterface": true,
"PCSClassificationLevels": 7
},
"Summaries": [
{
"StartDate": "2026-01-02T14:06:45.419961-06:00",
"PatientClassifications": [
{
"Level": 1,
"Volume": 2
},
{
"Level": 1,
"Volume": 2
}
],
"Census": {
"DeptId": 1,
"StartTime": "2026-01-02T14:06:45.419961-06:00",
"StaffTo": 1,
"ForecastCensus": 1.1,
"ActualCensus": 1,
"Note": "sample string 3",
"AveragePatientClassificationRating": 1.0,
"CensusId": 4
},
"FsDeptSummaryID": 2,
"FsDeptID": 3,
"DeptDescription": "sample string 4",
"StartTime": "2026-01-02T14:06:45.419961-06:00",
"EndTime": "2026-01-02T14:06:45.419961-06:00",
"ShiftType": "sample string 7",
"EffectiveDate": "2026-01-02T14:06:45.419961-06:00",
"ExpiresDate": "2026-01-02T14:06:45.419961-06:00"
},
{
"StartDate": "2026-01-02T14:06:45.419961-06:00",
"PatientClassifications": [
{
"Level": 1,
"Volume": 2
},
{
"Level": 1,
"Volume": 2
}
],
"Census": {
"DeptId": 1,
"StartTime": "2026-01-02T14:06:45.419961-06:00",
"StaffTo": 1,
"ForecastCensus": 1.1,
"ActualCensus": 1,
"Note": "sample string 3",
"AveragePatientClassificationRating": 1.0,
"CensusId": 4
},
"FsDeptSummaryID": 2,
"FsDeptID": 3,
"DeptDescription": "sample string 4",
"StartTime": "2026-01-02T14:06:45.419961-06:00",
"EndTime": "2026-01-02T14:06:45.419961-06:00",
"ShiftType": "sample string 7",
"EffectiveDate": "2026-01-02T14:06:45.419961-06:00",
"ExpiresDate": "2026-01-02T14:06:45.419961-06:00"
}
]
},
{
"DailyRosterStartTime": "2026-01-02T14:06:45.419961-06:00",
"DailyRosterEndTime": "2026-01-02T14:06:45.419961-06:00",
"Department": {
"FsFacilityID": 1,
"FacilityName": "sample string 2",
"FsDeptID": 3,
"CodeDescription": "sample string 4",
"PcsEnabled": true,
"CensusInterface": true,
"PCSClassificationLevels": 7
},
"Summaries": [
{
"StartDate": "2026-01-02T14:06:45.419961-06:00",
"PatientClassifications": [
{
"Level": 1,
"Volume": 2
},
{
"Level": 1,
"Volume": 2
}
],
"Census": {
"DeptId": 1,
"StartTime": "2026-01-02T14:06:45.419961-06:00",
"StaffTo": 1,
"ForecastCensus": 1.1,
"ActualCensus": 1,
"Note": "sample string 3",
"AveragePatientClassificationRating": 1.0,
"CensusId": 4
},
"FsDeptSummaryID": 2,
"FsDeptID": 3,
"DeptDescription": "sample string 4",
"StartTime": "2026-01-02T14:06:45.419961-06:00",
"EndTime": "2026-01-02T14:06:45.419961-06:00",
"ShiftType": "sample string 7",
"EffectiveDate": "2026-01-02T14:06:45.419961-06:00",
"ExpiresDate": "2026-01-02T14:06:45.419961-06:00"
},
{
"StartDate": "2026-01-02T14:06:45.419961-06:00",
"PatientClassifications": [
{
"Level": 1,
"Volume": 2
},
{
"Level": 1,
"Volume": 2
}
],
"Census": {
"DeptId": 1,
"StartTime": "2026-01-02T14:06:45.419961-06:00",
"StaffTo": 1,
"ForecastCensus": 1.1,
"ActualCensus": 1,
"Note": "sample string 3",
"AveragePatientClassificationRating": 1.0,
"CensusId": 4
},
"FsDeptSummaryID": 2,
"FsDeptID": 3,
"DeptDescription": "sample string 4",
"StartTime": "2026-01-02T14:06:45.419961-06:00",
"EndTime": "2026-01-02T14:06:45.419961-06:00",
"ShiftType": "sample string 7",
"EffectiveDate": "2026-01-02T14:06:45.419961-06:00",
"ExpiresDate": "2026-01-02T14:06:45.419961-06:00"
}
]
}
]
},
"Errors": [
"sample string 1",
"sample string 2"
],
"Warnings": [
"sample string 1",
"sample string 2"
]
}