XUND API Documentation

DayFilter

DayFilter extends FilterBase

DayFilter is a filter type that can be used to filter Medical Services by opening hours. It is used as sub-filter of OpeningHoursFilter, as it only contains filter definition for a single day.

DayFilter type describes a multiselect input, where user can select the searched opening part of the day. Its values are of type DayFilterValue.

Property name

Property type

Property description

text

string

Localised name of the day

shortText

string

Localized short name of the day

type

FilterType = ‘MULTISELECT’

Type of the Filter

values

[DayFilterValue, DayFilterValue]

Values to select the opening sections from (will be exactly 2 options)

Example response

An example of a DayFilter within OpeningHoursFilter retrieved from GET /v1/services/filters endpoint looks like:

This filter is not usable in its own, it is a sub-filter of OpeningHoursFilter

JSON
{
  "mon": {
      "text": "Monday",
      "type": "MULTISELECT",
      "shortText": "Mon",
      "values": [
          {
              "text": "Forenoon",
              "value": "9f609b60-ab5a-42f9-8038-b1b8291f54db",
              "code": "FORENOON"
          },
          {
              "text": "Afternoon",
              "value": "a806eb0f-8746-4b9c-a930-98e10efa7dfd",
              "code": "AFTERNOON"
          }
      ]
  }
}

Example request

This filter is a sub-filter of OpeningHoursFilter, see usage and example request there.