GET api/v1/schedule?StartDateTime={StartDateTime}&EndDateTime={EndDateTime}&DepartmentId={DepartmentId}&StaffId={StaffId}&ShowAll={ShowAll}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| StartDateTime | date |
Required |
|
| EndDateTime | date |
Required |
|
| DepartmentId | integer |
None. |
|
| StaffId | integer |
None. |
|
| ShowAll | boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
ApiResponseModelOfListOfScheduleAssignmentModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | ApiResponseDataModelOfListOfScheduleAssignmentModel |
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": [
{
"Id": "sample string 1",
"TypeId": 2,
"Status": "sample string 3",
"AssignmentId": "d7ba1086-9526-4158-95d5-9545aeb34a4a",
"NeedId": "159b439f-9e49-48c6-a58d-1492a5c1c283",
"RequestId": "7e162ad0-b75b-4c2a-b6de-f81b8267c13a",
"RequestShiftId": 1,
"FacilityId": 4,
"FacilityName": "sample string 5",
"FacilityCoId": "sample string 6",
"DepartmentId": 7,
"DepartmentName": "sample string 8",
"DepartmentCode": "sample string 9",
"DepartmentShiftId": 1,
"ShiftCode": "sample string 10",
"ShiftDescription": "sample string 11",
"SkillId": 12,
"Skill": "sample string 13",
"ProductiveTypeId": 14,
"ProductiveType": "sample string 15",
"Date": "2026-11-18T09:00:49.6317239-06:00",
"StartTime": "2026-11-18T09:00:49.6317239-06:00",
"EndTime": "2026-11-18T09:00:49.6317239-06:00",
"ActualStartTime": "2026-11-18T09:00:49.6317239-06:00",
"ActualEndTime": "2026-11-18T09:00:49.6317239-06:00",
"Hours": 1,
"Minutes": 1,
"StaffId": 19,
"UserName": "sample string 20",
"StaffFirstName": "sample string 21",
"StaffLastName": "sample string 22",
"Comment": "sample string 23"
},
{
"Id": "sample string 1",
"TypeId": 2,
"Status": "sample string 3",
"AssignmentId": "d7ba1086-9526-4158-95d5-9545aeb34a4a",
"NeedId": "159b439f-9e49-48c6-a58d-1492a5c1c283",
"RequestId": "7e162ad0-b75b-4c2a-b6de-f81b8267c13a",
"RequestShiftId": 1,
"FacilityId": 4,
"FacilityName": "sample string 5",
"FacilityCoId": "sample string 6",
"DepartmentId": 7,
"DepartmentName": "sample string 8",
"DepartmentCode": "sample string 9",
"DepartmentShiftId": 1,
"ShiftCode": "sample string 10",
"ShiftDescription": "sample string 11",
"SkillId": 12,
"Skill": "sample string 13",
"ProductiveTypeId": 14,
"ProductiveType": "sample string 15",
"Date": "2026-11-18T09:00:49.6317239-06:00",
"StartTime": "2026-11-18T09:00:49.6317239-06:00",
"EndTime": "2026-11-18T09:00:49.6317239-06:00",
"ActualStartTime": "2026-11-18T09:00:49.6317239-06:00",
"ActualEndTime": "2026-11-18T09:00:49.6317239-06:00",
"Hours": 1,
"Minutes": 1,
"StaffId": 19,
"UserName": "sample string 20",
"StaffFirstName": "sample string 21",
"StaffLastName": "sample string 22",
"Comment": "sample string 23"
}
]
},
"Errors": [
"sample string 1",
"sample string 2"
],
"Warnings": [
"sample string 1",
"sample string 2"
]
}