Denne REST-APIen gir tilgang til JSON-representasjon av alle oppslag (artikler) i ordbøkene for bokmål og nynorsk fra Språkrådet og UiB. Det er fire endepunkt i APIen: direkte oppslag, tekstsøk, forslag og ordbok-metadata
Alle API-kall er på formen:
/api/dict/{dict_id}[/article/{article_id}|(search|suggest)?q={query}]
Variabler:
dict_id
:
bob
for bokmålnob
for nynorskbob,no
for begge språk (bare for søk/forslag)article_id
: numerisk id for en ordboksartikkelquery
: SøkeuttrykkDersom man kjenner den numeriske IDen til en artikkel kan man slå den opp vha. dette endepunktet.
Spesifikasjonen til denne operasjonen finner du her
GET /api/dict/bob/article/69947 HTTP/1.1
Accept: application/json
x-api-key: <API-nøkkel>
…resulterer i
HTTP/1.1 200 Ok
Content-Type: application/json
{
"lemmas": [
{
"lemma": "tja",
"id": 69947
}
],
"article_id": 61167,
"body": {
}
}
lemmas
: Ett eller flere oppslagsord som artikkelen beskriver. Elementene i denne listen er på et format som er beskrevet herarticle_id
: Artikkelens ID, som i forespørselenbody
: Selve innholdet i artikkelen, formatet er beskrevet herDenne formen for søk leter etter søketeksten i alle bøyningsformer i oppslagsord, samt i artikkelelementer av typen usage
som beskrives senere.
GET /api/dict/bob/search?q=katt HTTP/1.1
Accept: application/json
x-api-key: <API-nøkkel>
…resulterer i
HTTP/1.1 200 Ok
Content-Type: application/json
[
{
"lemmas": [
{
"lemma": "katt",
"id": 34290
}
],
"article_id": 29022,
"score": 31.717403,
"dict_id": "bob",
"body": {}
},
{},
{}
]
Resultatet er en liste av objekter (som det man får ved direkte oppslag), men med to ekstra elementer:
score
: Et mål på hvor god match denne artikkelen er ift. søket, treffene er sortert synkende etter dette måltalletdict_id
: ID på ordboken artikkelen kommer fra (for tospråklig søk)Fungerer som tekstsøk, men returnerer bare artikler for ord som begynner med søkeuttrykket. Her er heller ingen score
inkludert. Kan brukes til autocomplete.
GET /api/dict/bob/suggest?q=katt HTTP/1.1
Accept: application/json
x-api-key: <API-nøkkel>
Artikkelkroppen samsvarer med dette JSON-skjemaet