POST /v1/services/filters/apply | XUND API Documentation

Apply filters endpoint is used to filter Medical Services by filters requested from GET /v1/services/filters endpoint. The result of the request is the filtered Medical Service list.

Not all service properties are supported in this view. See GET /v1/services/features/:countryCode endpoint to get information about accessible Service properties.

The maximal result count is 250, except when radius filtering is applied. The maximum filterable radius is 10 KM or M.

Request

Request Header additional fields

Parameter name	Parameter type	Parameter description
`language`	ClientLanguage	The expected language of the response

Request body parameters

All the parameters are optional, except location.

Specialization values differ between countries. See POST /v1/services/filters/borderChange endpoint for details.

Parameter name	Parameter type	Parameter description
`name`	string?	Medical Service name filter value
`genders`	Gender[]?	Medical Service gender filter values Only filters doctors, all other services will be displayed
`specializations`	string[]?	Medical Service specializations filter Array can include maximum 15 elements
`insurers`	string[]?	Filter Medical Services by supported insurers
`openingHours`	TypeScript `{ mon?: string[] tue?: string[] wed?: string[] thu?: string[] fri?: string[] sat?: string[] sun?: string[] }`	Optional filtering of Medical Services by opening hours, see Filters documentation for details.
`location`	Location	An object of latitude-longitude pair This endpoint, unlike others, does not support `CountryCode` parameter, since exact location is mandatory.
`limit`	`{ results: number }` \| `{ radius: number, unit: 'KM' \| 'MI' }`	Limit result by number or radius. When limiting by radius, a radius unit of KM (kilometers) or MI (milestones) is required. Maximal result count is 250, except when radius filtering is applied. The maximum filterable radius is 10 KM or MI.
`skip`	number?	Number of elements to skip from the beginning of the results – usable for pagination.
`top`	number?	Number of elements to return – usable for pagination.
`selector`	TypeScript `{ root: Array<keyof Services> location: Array<keyof Service['location']> specializations: Array<keyof Specialization> }`	Optional selector parameter to reduce the returned data size. `root` array can be used to select Service properties to return, `location` to select properties of Service location, `specializations` to select properties of Service specializations. See Service documentation for the field details.

Response

Response Body data structure

Property name	Property type	Property description
`count`	number	Number of total results, without `skip` and `top` request parameters.
`items`	ServiceWithDetailedOpeningHours[]	The Medical Service result array, that can be limited by `skip` and `top` request parameters. When `selector` is used, the not selected properties of the Services will be omitted.
`serviceDetailState`	`{ isAllFeaturesAvailable: true} \| { isAllFeaturesAvailable: false text: string affectedFields: Array<keyof Service> }`	Marks whether all features are available in the response. If not, a localised text that can be shown to the user containing the action to be taken, and affected field list is sent.

Property name

Property type

Property description

count

number

Number of total results, without skip and top request parameters.

items

ServiceWithDetailedOpeningHours[]

The Medical Service result array, that can be limited by skip and top request parameters.

When selector is used, the not selected properties of the Services will be omitted.

serviceDetailState

{ isAllFeaturesAvailable: true} 
  |
{
  isAllFeaturesAvailable: false
  text: string
  affectedFields: Array<keyof Service>
}

Marks whether all features are available in the response.

If not, a localised text that can be shown to the user containing the action to be taken, and affected field list is sent.

The items property is an array of Services. See Service model for documentation.

Items property data structure

When selector parameter is used, only selected properties of Service model will be returned.

Example response

Click to expand...

JSON

{
    "count": 2,
    "items": [
        {
            "id": "002f31d5-7x5c-4076-ba36-9cfc35c7e106",
            "name": "Dr. Reinald Mankowski",
            "type": "DOCTOR",
            "gender": "MALE",
            "phone": "013694040",
            "email": "email@aon.at",
            "location": {
                "country": "AT",
                "zip": "1190",
                "city": "Wien",
                "address": "Hauptstr.44",
                "province": "Wien",
                "latitude": 48.1363602,
                "longitude": 16.3538516
            },
            "specializations": [
                {
                    "id": "f44e9011-26e7-4480-b4de-f29234148f1f",
                    "name": "Neurosurgery",
                    "type": "DOCTOR"
                }
            ],
            "insurers": [],
            "openingHours": {
                "0": [],
                "1": [
                    {
                        "start": "09:00",
                        "finish": "13:00"
                    }
                ],
                "2": [
                    {
                        "start": "14:00",
                        "finish": "20:00"
                    }
                ],
                "3": [
                    {
                        "start": "14:00",
                        "finish": "20:00"
                    }
                ],
                "4": [],
                "5": [],
                "6": [],
                "detailedData": {
                    "type": "CLOSED_TODAY",
                    "isOpen": false,
                    "text": "Closed today"
                }
            },
            "monogram": "RB"
        },
        {
            "id": "e6d452f3-32c3-4738-a820-b3812b75583e",
            "name": "Dr. Mirella Foster",
            "type": "DOCTOR",
            "gender": "FEMALE",
            "phone": "014800934",
            "email": "info@mirr.at",
            "location": {
                "country": "AT",
                "zip": "1170",
                "city": "Wien",
                "address": "Mozenbacher Str.125/1",
                "province": "Wien",
                "latitude": 48.253652,
                "longitude": 16.39089
            },
            "specializations": [
                {
                    "id": "56                                  ",
                    "name": "Dentist",
                    "type": "DOCTOR"
                }
            ],
            "insurers": [],
            "openingHours": {
                "0": [
                    {
                        "start": "09:00",
                        "finish": "18:00"
                    }
                ],
                "1": [
                    {
                        "start": "08:00",
                        "finish": "20:00"
                    }
                ],
                "2": [
                    {
                        "start": "10:00",
                        "finish": "18:00"
                    }
                ],
                "3": [],
                "4": [
                    {
                        "start": "08:00",
                        "finish": "15:00"
                    }
                ],
                "5": [],
                "6": [],
                "detailedData": {
                    "type": "CLOSES_SOON",
                    "isOpen": true,
                    "text": "Closes soon at 15:00",
                    "timeData": {
                        "time": "2022-09-02T13:00:00.000Z"
                    }
                }
            },
            "monogram": "CF"
        }
    ],
    "serviceDetailState": {
        "isAllFeaturesAvailable": true
    }
}