XUND API Documentation

NameFilter

NameFilter extends FilterBase

NameFilter is a filter type that can be used to filter Medical Services by name.

NameFilter type describes a text input, where the user can type the searched text. It does not have extra properties, but its type is always TEXT.

Property name

Property type

Property description

text

string (localized text)

Localised text of the Filter

type

FilterType = ‘TEXT’

Type of the Filter

Example response

An example of a NameFilter retrieved from the GET /v1/services/filters endpoint looks like this:

JSON
{
    "name": {
        "text": "Name",
        "type": "TEXT"
    }
}

Example request

After the filter was rendered, filled, and submitted by the user, its value should be sent to POST /v1/services/filters/apply endpoint.

Location filter is always mandatory

The request body would look like this:

JSON
{
    "name": "john",
    "location": {
        "latitude": 48.218323, 
        "longitude": 16.324020
    }
}

This will return the Medical Services that have the term john in their name, restricted by the endpoint’s limits.