API

Eksempel på nedlasting av datasett

Dersom du eksempelvis ønsker å laste ned Difis liste over fylker, i json-format, kan du gjøre det fra denne adressen:

http://hotell.difi.no/api/json/difi/geo/fylke

Dersom du ønsker å laste ned den samme listen i csv-format, kan du gjøre det fra denne adressen:

http://hotell.difi.no/api/csv/difi/geo/fylke

Merk at datasett på mer enn 100 poster har pagination, se neste avsnitt.

Pagination

Presentasjon av datasett foregår med pagination, og det vil vises maks 100 poster om gangen ved utlisting. For å vise neste side benytter man parameteret page hvor første side er page=1 (1-indeksert). Eksempel:

http://hotell.difi.no/api/json/fmsf/partistotte/2011?page=8

Ved uthenting av data hvor pagination benyttes finnes det metadata om dette i HTTP-header. Følgende parametere kan hentes:

X-Datahotel-Page
X-Datahotel-Total-Pages
X-Datahotel-Total-Posts

ETag

Alle oppslag som henter data (ikke oversikt over organisasjoner, grupper og datasett) har støtte for ETag.

Eksempel på nedlasting av feltdefinisjoner

Alle felt i datahotellet er definert minst med navn, beskrivelse, type (for eksempel om det er et navn, en kategorisering, et fylkesnummer, et kommunenummer eller en måleenhet), om de er søkbare, grupperbare og om de kan gjøres oppslag i. Feltdefinisjonene for datasettet du er interessert i kan lastes ned i JSON:

http://hotell.difi.no/api/json/difi/geo/fylke/fields

Eksempel på oppslag i API'et

Det er to måter å hente ut spesifikke data på. Den første måten er å søke. Du kan for eksempel søke på fylker som har ordet "Agder" i seg, og få resultatet ut i json, på denne måten:

http://hotell.difi.no/api/json/difi/geo/fylke?query=agder

Når man gjør et slikt søk søker man i alle felt som er satt som søkbare (at et felt er søkbart betyr at det i feltdefinisjonen må stå at searchable = True).

Den andre måten å hente ut spesifikke data på er å gjøre oppslag. Man kan kun gjøre oppslag i felt der groupable = True. Det er ingen grupperbare felt i listen over fylker. Det er det derimot i datasettet over kommuner. Kallet settes opp på denne måten:

url-til-datasett?feltnavn=verdi

Hvis jeg ønsker å hente ned alle kommuner i Sogn og Fjordane benyttes følgende adresse:

http://hotell.difi.no/api/json/difi/geo/kommune?fylke=14

Komplett datasett

Det er mulig å laste ned komplett datasett som CSV ved å benytte nedlastingslenke. Eksempel på nedlasting av kommuner: