POST api/v1/staffpreferences/schedule

Returns the preferences of staff in a given schedule date range

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DepartmentId	integer	None.
ScheduleStartDate	date	None.
ScheduleEndDate	date	None.
ScheduleEmployeeStaffId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "DepartmentId": 1,
  "ScheduleStartDate": "2026-01-02T20:10:55.3435726-06:00",
  "ScheduleEndDate": "2026-01-02T20:10:55.3435726-06:00",
  "ScheduleEmployeeStaffId": 4
}

Response Information

Resource Description

ApiResponseModelOfScheduleStaffPreferenceModel

Name	Type	Additional information
Data	ApiResponseDataModelOfScheduleStaffPreferenceModel	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": {
      "ScheduleInfo": {
        "DepartmentId": 1,
        "ScheduleStartDate": "2026-01-02T20:10:55.3435726-06:00",
        "ScheduleEndDate": "2026-01-02T20:10:55.3435726-06:00",
        "ScheduleEmployeeStaffId": 4
      },
      "StaffPreferences": [
        {
          "StaffPreferenceId": 1,
          "StaffId": 1,
          "EmployeeName": "sample string 2",
          "DaysOfWeek": [
            {
              "DayOfWeekId": 1,
              "DayOfWeek": "sample string 2",
              "Preference": true,
              "EffectiveDate": "2026-01-02T20:10:55.3435726-06:00",
              "ExpiryDate": "2026-01-02T20:10:55.3435726-06:00"
            },
            {
              "DayOfWeekId": 1,
              "DayOfWeek": "sample string 2",
              "Preference": true,
              "EffectiveDate": "2026-01-02T20:10:55.3435726-06:00",
              "ExpiryDate": "2026-01-02T20:10:55.3435726-06:00"
            }
          ],
          "PartsOfDay": [
            {
              "PartOfDayId": 1,
              "PartOfDay": "sample string 2",
              "StartTime": "sample string 3",
              "EndTime": "sample string 4",
              "Preference": true,
              "EffectiveDate": "2026-01-02T20:10:55.3435726-06:00",
              "ExpiryDate": "2026-01-02T20:10:55.3435726-06:00"
            },
            {
              "PartOfDayId": 1,
              "PartOfDay": "sample string 2",
              "StartTime": "sample string 3",
              "EndTime": "sample string 4",
              "Preference": true,
              "EffectiveDate": "2026-01-02T20:10:55.3435726-06:00",
              "ExpiryDate": "2026-01-02T20:10:55.3435726-06:00"
            }
          ]
        },
        {
          "StaffPreferenceId": 1,
          "StaffId": 1,
          "EmployeeName": "sample string 2",
          "DaysOfWeek": [
            {
              "DayOfWeekId": 1,
              "DayOfWeek": "sample string 2",
              "Preference": true,
              "EffectiveDate": "2026-01-02T20:10:55.3435726-06:00",
              "ExpiryDate": "2026-01-02T20:10:55.3435726-06:00"
            },
            {
              "DayOfWeekId": 1,
              "DayOfWeek": "sample string 2",
              "Preference": true,
              "EffectiveDate": "2026-01-02T20:10:55.3435726-06:00",
              "ExpiryDate": "2026-01-02T20:10:55.3435726-06:00"
            }
          ],
          "PartsOfDay": [
            {
              "PartOfDayId": 1,
              "PartOfDay": "sample string 2",
              "StartTime": "sample string 3",
              "EndTime": "sample string 4",
              "Preference": true,
              "EffectiveDate": "2026-01-02T20:10:55.3435726-06:00",
              "ExpiryDate": "2026-01-02T20:10:55.3435726-06:00"
            },
            {
              "PartOfDayId": 1,
              "PartOfDay": "sample string 2",
              "StartTime": "sample string 3",
              "EndTime": "sample string 4",
              "Preference": true,
              "EffectiveDate": "2026-01-02T20:10:55.3435726-06:00",
              "ExpiryDate": "2026-01-02T20:10:55.3435726-06:00"
            }
          ]
        }
      ],
      "IsCurrentUser": true
    }
  },
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Warnings": [
    "sample string 1",
    "sample string 2"
  ]
}