API-dokumentasjon – prototyping

Dette er dokumentasjonen for eksperimentelle APIer for Store norkse leksikon og andre leksika publisert av Foreningen Store norske leksikon.

APIene som er dokumentert her er prototyper og eksperimenter som brukes for å rettlede utformingen av fremtidige APIer og kan endre seg eller forsvinne helt, uten forvarsel.

https://[subdomene].snl.no/.api/prototyping/search?query=[søketekst]&[flere parametre...]

Parameter Forklaring
encyclopedia Begrens søket til angitt leksikon: snl, sml, nbl eller nkl. Den samme filtreringen kan også oppnås ved gjøre søket i et subdomene. https://sml.snl.no/.api/prototyping/search?query=… vil med andre ord gi samme treff som https://snl.no/.api/prototyping/search?encyclopedia=sml&query=….
query Søketekst, f.eks. "Tog", "Edvard Munch"
limit Maksimalt antall resultater. 1-100 er gyldige verdier, standard er 10
offset Brukes for paginering av resultatene. Sett for eksempel offset=100 for å vise søkeresultater utover de første 100.
include_metadata Metadata inkluderes i søkeresultatene hvis dette parameteret settes til true
article_type_id Filtrer søket til å bare inkludere artikler med angitt artikkeltype
author_id Filtrer søket til å bare inkludere artikler av angitt forfatter
author_name Filtrer søket til å bare inkludere artikler av forfattere med samsvarende navn
taxonomy_id Filtrer søket til å bare inkludere artikler i angitt taksonomi
taxonomy_title Filtrer søket til å bare inkludere artikler i taksonomier med samsvarende navn
tagsonomy_id Filtrer søket til å bare inkludere artikler i angitt tagsonomy
tagsonomy_title Filtrer søket til å bare inkludere artikler i tagsonomyer med samsvarende navn
char_count_min Filtrer søket til å bare inkludere artikler med angitt antall tegn i artikkelteksten, eller flere
char_count_max Filtrer søket til å bare inkludere artikler med angitt antall tegn i artikkelteksten, eller færre
media_count_min Filtrer søket til å bare inkludere artikler med angitt antall media-vedlegg, eller flere
media_count_max Filtrer søket til å bare inkludere artikler med angitt antall media-vedlegg, eller færre
version_count_min Filtrer søket til å bare inkludere artikler med angitt antall historiske versjoner, eller flere
version_count_max Filtrer søket til å bare inkludere artikler med angitt antall historiske versjoner, eller færre
license_id Filtrer søket til å bare inkludere artikler med angitt lisens-id (free eller restricted)
updated_at_or_after Filtrer søket til å bare inkludere artikler oppdatert på angitt tidspunkt, eller senere. Tidspunktet angis i RFC3339-format.
updated_at_or_before Filtrer søket til å bare inkludere artikler oppdatert på angitt tidspunkt, eller tidligere. Tidspunktet angis i RFC3339-format.
Resultatfelt Forklaring
headword Artikkelens tittel, eksklusive presisering
clarification Presiseringsfelt for tittel
article_url URL til vanlig visning av artikkelen
article_url_json URL til JSON-representasjon av artikkelen
query_match_quality En numerisk evaluering av hvor godt dette søkeresultatet svarer til søkestrengen (query). 0: Treff på artikkeltekst eller deler av tittel, 1: Søkestrengen er lik artikkelens tittel (headword), men artikkelen har en ytterligere presisering (clarification), 2: Søkestrengen er lik artikkelens tittel (headword) og det er ingen ytterligere presisering (clarification).

Kommentarer

Har du spørsmål om eller kommentarer til artikkelen?

Kommentaren din vil bli publisert under artikkelen, og fagansvarlig eller redaktør vil svare når de har mulighet.

Du må være logget inn for å kommentere.