Search
One endpoint, ranked so that a code number never loses to prose that mentions it.
Examples
GET /v1/search?q=101076
GET /v1/search?q=raadpleging huisarts&language=nl
GET /v1/search?q=consultation au cabinet&language=frParameters
| Parameter | Default | Notes |
|---|---|---|
q | required | A code, or text in either language. |
language | both | nl or fr to restrict. |
active | false | true to exclude codes no longer in force. |
limit | 50 | Maximum 200. |
Ranking
Results carry match_type, which tells you why something matched and in what order results were ranked.
| match_type | Meaning |
|---|---|
exact_code | The query is this code. |
code_prefix | The code starts with the query. |
exact_text | A description equals the query. |
text_prefix | A description starts with the query. |
relevance | Full-text match in the relevant language. |
fuzzy | Approximate match, accent- and typo-tolerant. |
match_type is useful for interfaces: an exact_code hit can be navigated to directly, while a page of fuzzy hits should be presented as suggestions.