GET api/v1/staffpreferences/{staffId}

Retrieves the staff's preference for the specified staff Id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
staffId

integer

None.

Body Parameters

None.

Response Information

Resource Description

ApiResponseModelOfStaffPreferenceRequestModel
NameDescriptionTypeAdditional information
Data

ApiResponseDataModelOfStaffPreferenceRequestModel

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": {
      "StaffPreferenceId": 1,
      "StaffId": 1,
      "EmployeeName": "sample string 2",
      "DaysOfWeek": [
        {
          "DayOfWeekId": 1,
          "DayOfWeek": "sample string 2",
          "Preference": true,
          "EffectiveDate": "2026-01-02T21:48:47.150449-06:00",
          "ExpiryDate": "2026-01-02T21:48:47.150449-06:00"
        },
        {
          "DayOfWeekId": 1,
          "DayOfWeek": "sample string 2",
          "Preference": true,
          "EffectiveDate": "2026-01-02T21:48:47.150449-06:00",
          "ExpiryDate": "2026-01-02T21:48:47.150449-06:00"
        }
      ],
      "PartsOfDay": [
        {
          "PartOfDayId": 1,
          "PartOfDay": "sample string 2",
          "StartTime": "sample string 3",
          "EndTime": "sample string 4",
          "Preference": true,
          "EffectiveDate": "2026-01-02T21:48:47.150449-06:00",
          "ExpiryDate": "2026-01-02T21:48:47.150449-06:00"
        },
        {
          "PartOfDayId": 1,
          "PartOfDay": "sample string 2",
          "StartTime": "sample string 3",
          "EndTime": "sample string 4",
          "Preference": true,
          "EffectiveDate": "2026-01-02T21:48:47.150449-06:00",
          "ExpiryDate": "2026-01-02T21:48:47.150449-06:00"
        }
      ]
    }
  },
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Warnings": [
    "sample string 1",
    "sample string 2"
  ]
}