# searchFullText Types

Types and enums related to the searchFullText endpoint.

# SearchFullTextFieldRestriction

Enum An enum of fields that the searchFullText endpoint can be restricted to.

Key Value
Name name
ActiveIngredient active_ingredient
Barcode barcode
AtcCode atc_code

# SearchFullTextOptions

Type Options for configuring the searchFullText endpoint. Consists of LocaleOptions, PaginationOptions and RestrictToFieldOptions<SearchFullTextFieldRestriction>

Name Type Required Default
country HealthboxCountry Value from client configuration
language HealthboxLanguage Value from client configuration
limit number 32
from number 0
restrictToField SearchFullTextFieldRestriction undefined

# SearchFullTextRecord

Type Model of a single data record that the searchFullText endpoint responds with. The endpoint will return an array of those.

Name Type
activeIngredient string
commercialName string
countryCode string
dosage string
languageCode string
mah string
name string
pharmaceuticalForm string
productId string