Filter Medical Services

POST/v1/services/filters/apply

Apply filters endpoint is used to filter Medical Services by filters requested from the 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 the GET /v1/services/features/:countryCode endpoint to get information about accessible Service properties.

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

Authorization

BearerToken

AuthorizationBearer <token>

Authenticate with a JWT bearer token obtained from the token endpoint with your Client Id and API key.

In: header

Header Parameters

language*string

The expected language of the response.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

The filter values to apply on Medical Services. All the parameters are optional, except location.

name?string

Medical Service name filter value.

genders?array<string>

Medical Service gender filter. Use the option item ids returned as gender filter values by GET /v1/services/filters (maximum 2 elements). Only filters doctors, all other services will be displayed.

Itemsitems <= 2

specializations?array<string>

Medical Service specializations filter. The array can include a maximum of 15 elements.

linkedIcd10Codes?array<string>

Filter Medical Services by linked illness ICD-10 codes.

insurers?array<string>

Filter Medical Services by supported insurers.

openingHours?

Optional filtering of Medical Services by opening hours.

location*

An object of latitude-longitude pair. This endpoint, unlike others, does not support the CountryCode parameter, since an exact location is mandatory.

limit?|

Limit the result by number or radius. When limiting by radius, a radius unit of KM (kilometers) or MI (miles) is required. The maximal result count is 250, except when radius filtering is applied. The maximum filterable radius is 10 KM or MI.

skip?integer

Number of elements to skip from the beginning of the results — usable for pagination.

top?integer

Number of elements to return — usable for pagination.

selector?

Optional selector parameter to reduce the returned data size. The 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.

Response Body

`application/json`

curl -X POST "https://example.com/v1/services/filters/apply" \  -H "authorization: Bearer <token>" \  -H "language: en" \  -H "Content-Type: application/json" \  -d '{    "genders": [      "80e5d6f2-d486-45c7-8e3e-7e73e3dd0519"    ],    "location": {      "latitude": 48.218323,      "longitude": 16.32402    }  }'

{  "count": 2,  "items": [    {      "id": "002f31d5-7a5c-4076-ba36-9cfc35c7e106",      "name": "Dr. Eva Muster",      "type": "DOCTOR",      "gender": "FEMALE",      "phone": "019876543",      "email": "[email protected]",      "location": {        "country": "AT",        "zip": "1170",        "city": "Wien",        "address": "Beispielgasse 5",        "province": "Wien",        "latitude": 48.220512,        "longitude": 16.329874      },      "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": "EM"    },    {      "id": "e6d452f3-32c3-4738-a820-b3812b75583e",      "name": "Dr. Anna Beispiel",      "type": "DOCTOR",      "gender": "FEMALE",      "phone": "011234567",      "email": "[email protected]",      "location": {        "country": "AT",        "zip": "1170",        "city": "Wien",        "address": "Musterstraße 1",        "province": "Wien",        "latitude": 48.219104,        "longitude": 16.326217      },      "specializations": [        {          "id": "a7c31b02-88d4-4f2e-9c65-3d1e0b7a54c9",          "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": "AB"    }  ],  "serviceDetailState": {    "isAllFeaturesAvailable": true  }}