Skip to end of metadata
Go to start of metadata

Enhetsregisteret tilbyr en tjeneste for programmatisk oppslag og søk på registrerte enheter. Dataene leveres i sanntid fra enhetsregisteret, og tjenesten kan f.eks. brukes av en backendløsning for å vaske eller oppdatere egne data. Innholdet i datasettet er beskrevet i informasjonsmodellen for Enhets- og Foretaksregisteret

Ressurser

Alle ressursene støtter formatene json, xml og csv  vha. innholdsforhandling. Ønsket format angis vha. Accept headeren eller som en del av urlen. Format angitt på urlen har høyest presedens og vil overstyre eventuelt format satt vha. Accept headeren. For CSV benyttes semikolon som separator og dobbeltfnutt rundt verdier hvor dette er nødvendig. Line Feed (LN) indikerer linjeskift/ny record.

Datoer er angitt i henhold til ISO-8601, dvs. på mønsteret YYYY-MM-DD.

Hovedenheter

Enkeltpersonforetak, foreninger, selskap, sameier og andre som er registrert i Enhetsregisteret. Enhet på øverste nivå i registreringsstrukturen i Enhetsregisteret. Identifiseres med organisasjonsnummer.

 

RessursURL-mønsterEksempel

Liste over hovedenheter

http://data.brreg.no/enhetsregisteret/enhet.{format}?page={side}&size={antall per side}&$filter={filter}

http://data.brreg.no/enhetsregisteret/enhet.json?page=0&size=5&$filter=antallAnsatte ge 10
 Detaljert beskrivelse

Returnerer data for en eller flere hovedenheter som er registrert i enhetsregisteret.

URL

/enhet?page={page}&size={size}&$filter={filter}

Metode

GET

URL parametere

Frivillig
  • page = Integer [0,)
  • size = Integer [1, 100]
  • $filter = String

     Filtrerbare felter

    Se egen seksjon om  filtrering for hvordan man bygger opp filtere.

    FeltFilter
    organisasjonsnummereq
    navnstartswith, eq
    stiftelsesdatoeq, le, ge, lt, gt
    registreringsdatoEnhetsregistereteq, le, ge, lt, gt
    organisasjonsformeq
    hjemmesideeq
    registrertIFrivillighetsregistereteq
    registrertIMvaregistereteq
    registrertIForetaksregistereteq
    registrertIStiftelsesregistereteq
    frivilligRegistrertIMvaregisteretstartswith
    antallAnsatteeq, le, ge, lt, gt
    institusjonellSektorkode.kodeeq
    registrertIStiftelsesregistereteq
    naeringskode1.kodestartswith, eq
    naeringskode2.kodestartswith, eq
    naeringskode3.kodestartswith, eq
    postadresse.adressestartswith, eq
    postadresse.postnummereq, le, ge, lt, gt
    postadresse.poststedeq
    postadresse.kommunenummereq, le, ge, lt, gt
    postadresse.kommuneeq
    postadresse.landkodeeq
    postadresse.landeq
    forretningsadresse.adressestartswith, eq
    forretningsadresse.postnummereq, le, ge, lt, gt
    forretningsadresse.poststedeq
    forretningsadresse.kommunenummereq, le, ge, lt, gt
    forretningsadresse.kommuneeq
    forretningsadresse.landkodeeq
    forretningsadresse.landeq
    sisteInnsendteAarsregnskapeq
    konkurseq
    underAvviklingeq
    underTvangsavviklingEllerTvangsopplosningeq

Suksess respons

  • Kode: 200

  • Innhold

     JSON Skjema

    Skjemaet inkluderer ikke hypermedia kontroller. Det gjøres oppmerksom på at urler til refererte skjemaer ikke er derefererbare.

    {
       "$schema":"http://json-schema.org/draft-04/schema#",
       "type":"object",
       "properties":{
          "data":{
             "type":"array",
             "description":"Liste med hovedenheter.",
             "items":{      
                "$ref":"http://data.brreg.no/enhetsregisteret/enhet#"
             }
          },
          "page":{
             "type":"object",
             "properties":{
                "size":{
                   "type":"integer"
                },
                "page":{
                   "type":"integer"
                }
             },
             "required": ["size", "page"]
          }
       },
       "required": ["page"]
    }
     CSV beskrivelse

    x = alfanumerisk, 9 = tall

    KolonneKolonneoverskrift/feltDatatypeBeskrivelse
    1organisasjonsnummer9(9) 
    2navnx(180) 
    3stiftelsesdatox(10)YYYY-MM-DD
    4registreringsdatoEnhetsregisteretx(10)YYYY-MM-DD
    5organisasjonsformx(4) 
    6hjemmesidex(150) 
    7registrertIFrivillighetsregisteretx(1)J eller N
    8registrertIMvaregisteretx(1)J eller N
    9registrertIForetaksregisteretx(1)J eller N
    10registrertIStiftelsesregisteretx(1)J eller N
    11frivilligRegistrertIMvaregisteretx(70) ; x(70) ; ..

    Kolonnen kan inneholde flere verdier per rad, og disse er
    da innad i hver celle igjen separert vha. semikolon.

    12antallAnsatteint 
    13institusjonellSektorkode.kode9(4) 
    14institusjonellSektorkode.beskrivelsex(140) 
    15naeringskode1.kodex(6) 
    16naeringskode1.beskrivelsex(140) 
    17naeringskode2.kodex(6) 
    18naeringskode2.beskrivelsex(140) 
    19naeringskode3.kodex(6) 
    20naeringskode3.beskrivelsex(140) 
    21postadresse.adressex(110) 
    22postadresse.postnummer9(4) 
    23postadresse.poststedx(28) 
    24postadresse.kommunenummer9(4) 
    25postadresse.kommunex(26) 
    26postadresse.landkodex(3) 
    27postadresse.landx(35) 
    28forretningsadresse.adressex(110) 
    29forretningsadresse.postnummer9(4) 
    30forretningsadresse.poststedx(28) 
    31forretningsadresse.kommunenummer9(4) 
    32forretningsadresse.kommunex(26) 
    33forretningsadresse.landkodex(3) 
    34forretningsadresse.landx(35) 
    35sisteInnsendteAarsregnskap9(4)YYYY
    36konkursx(1)J eller N
    37underAvviklingx(1)J eller N
    38underTvangsavviklingEllerTvangsopplosningx(1)J eller N
    39overordnetEnhet  9(9) 

Feil respons

  • Kode: 400
    Ved ulovlige input parametere.

Eksempel

 

Oppslag på hovedenhet http://data.brreg.no/enhetsregisteret/enhet/{orgnr}.{format}http://data.brreg.no/enhetsregisteret/enhet/974760673.json
 Detaljert beskrivelse

Returnerer data for en hovedenhet som er registrert i enhetsregisteret.

URL

/enhet/{organisasjonsnummer}

Metode

GET

URL parametere

Påkrevd
  • organisasjonsnummer = Integer

Suksess respons

  • Kode: 200
  • Innhold:

     JSON Skjema

    Skjemaet gir en oversikt over alle felter for hovedenheter. Hypermedia kontroller er ikke med i skjemaet.

    {
       "$schema":"http://json-schema.org/draft-04/schema#",
       "id":"http://data.brreg.no/enhetsregisteret/enhet#",
       "type":"object",
       "properties":{
          "organisasjonsnummer":{
             "type":"integer"
          },
          "navn":{
             "type":"string"
          },
          "stiftelsesdato":{
             "type":"string"
          },
          "registreringsdatoEnhetsregisteret":{
             "type":"string"
          },
          "organisasjonsform":{
             "type":"string",
             "pattern":"^\\w{4}$"
          },
          "hjemmeside":{
             "type":"string"
          },
          "registrertIFrivillighetsregisteret":{
             "type":"string",
             "enum":[
                "J",
                "N"
             ]
          },
          "registrertIMvaregisteret":{
             "type":"string",
             "enum":[
                "J",
                "N"
             ]
          },
          "registrertIForetaksregisteret":{
             "type":"string",
             "enum":[
                "J",
                "N"
             ]
          },
          "registrertIStiftelsesregisteret":{
             "type":"string",
             "enum":[
                "J",
                "N"
             ]
          },
          "frivilligRegistrertIMvaregisteret":{
             "type":"array",
             "items":{
                "type":"string"
             }
          },
          "antallAnsatte":{
             "type":"integer"
          },
          "institusjonellSektorkode":{
             "type":"object",
             "properties":{
                "kode":{
                   "type":"string",
                   "pattern":"^[0-9]{4}$"
                },
                "beskrivelse":{
                   "type":"string"
                }
             }
          },
          "naeringskode1":{
             "$ref":"#/definitions/naeringskode"
          },
          "naeringskode2":{
             "$ref":"#/definitions/naeringskode"
          },
          "naeringskode3":{
             "$ref":"#/definitions/naeringskode"
          },
          "postadresse":{
             "$ref":"#/definitions/adresse"
          },
          "forretningsadresse":{
             "$ref":"#/definitions/adresse"
          },
          "sisteInnsendteAarsregnskap":{
             "type":"integer",
             "pattern":"^[0-9]{4}$"
          },
          "konkurs":{
             "type":"string",
             "enum":[
                "J",
                "N"
             ]
          },
          "underAvvikling":{
             "type":"string",
             "enum":[
                "J",
                "N"
             ]
          },
          "underTvangsavviklingEllerTvangsopplosning":{
             "type":"string",
             "enum":[
                "J",
                "N"
             ]
          },
          "overordnetEnhet":{
             "type":"integer"
          }
       },
       "required":[
          "organisasjonsnummer",
          "navn",
          "organisasjonsform",
          "registreringsdatoEnhetsregisteret",
          "registrertIFrivillighetsregisteret",
          "registrertIMvaregisteret",
          "registrertIForetaksregisteret",
          "registrertIStiftelsesregisteret",
          "konkurs",
          "underAvvikling",
          "underTvangsavviklingEllerTvangsopplosning"
       ],
       "definitions":{
          "adresse":{
             "type":"object",
             "properties":{
                "adresse":{
                   "type":"string"
                },
                "postnummer":{
                   "type":"string",
                   "pattern":"^[0-9]{4}$"
                },
                "poststed":{
                   "type":"string"
                },
                "kommunenummer":{
                   "type":"string",
                   "pattern":"^[0-9]{4}$"
                },
                "kommune":{
                   "type":"string"
                },
                "landkode":{
                   "type":"string",
                   "pattern":"^[a-zA-Z]{2,3}$"
                },
                "land":{
                   "type":"string"
                }
             }
          },
          "naeringskode":{
             "type":"object",
             "properties":{
                "kode":{
                   "type":"string",
                   "pattern":"^[0-9]{2}\\.[0-9]{3}$"
                },
                "beskrivelse":{
                   "type":"string"
                }
             }
          }
       }
    }                  
     CSV beskrivelse

    x = alfanumerisk, 9 = tall

    KolonneKolonneoverskrift/feltDatatypeBeskrivelse
    1organisasjonsnummer9(9) 
    2navnx(180) 
    3stiftelsesdatox(10)YYYY-MM-DD
    4registreringsdatoEnhetsregisteretx(10)YYYY-MM-DD
    5organisasjonsformx(4) 
    6hjemmesidex(150) 
    7registrertIFrivillighetsregisteretx(1)J eller N
    8registrertIMvaregisteretx(1)J eller N
    9registrertIForetaksregisteretx(1)J eller N
    10registrertIStiftelsesregisteretx(1)J eller N
    11frivilligRegistrertIMvaregisteretx(70) ; x(70) ; ..

    Kolonnen kan inneholde flere verdier per rad, og disse er
    da innad i hver celle igjen separert vha. semikolon.

    12antallAnsatteint 
    13institusjonellSektorkode.kode9(4) 
    14institusjonellSektorkode.beskrivelsex(140) 
    15naeringskode1.kodex(6) 
    16naeringskode1.beskrivelsex(140) 
    17naeringskode2.kodex(6) 
    18naeringskode2.beskrivelsex(140) 
    19naeringskode3.kodex(6) 
    20naeringskode3.beskrivelsex(140) 
    21postadresse.adressex(110) 
    22postadresse.postnummer9(4) 
    23postadresse.poststedx(28) 
    24postadresse.kommunenummer9(4) 
    25postadresse.kommunex(26) 
    26postadresse.landkodex(3) 
    27postadresse.landx(35) 
    28forretningsadresse.adressex(110) 
    29forretningsadresse.postnummer9(4) 
    30forretningsadresse.poststedx(28) 
    31forretningsadresse.kommunenummer9(4) 
    32forretningsadresse.kommunex(26) 
    33forretningsadresse.landkodex(3) 
    34forretningsadresse.landx(35) 
    35sisteInnsendteAarsregnskap9(4)YYYY
    36konkursx(1)J eller N
    37underAvviklingx(1)J eller N
    38underTvangsavviklingEllerTvangsopplosningx(1)J eller N
    39overordnetEnhet  9(9) 

Feil respons

  • Kode: 404
    Enheten finnes ikke.

Eksempel

 

Underenheter

Enhet på laveste nivå i registreringsstrukturen i Enhetsregisteret. En underenhet kan ikke eksistere alene og har alltid knytning til en hovedenhet eller et organisasjonsledd. Identifiseres med organisasjonsnummer.

 

RessursURL-mønsterEksempel
Liste over underenheter http://data.brreg.no/enhetsregisteret/underenhet.{format}?page={side}&size={antall per side}&$filter={filter}http://data.brreg.no/enhetsregisteret/underenhet.json?page=0&size=5&$filter=antallAnsatte ge 10
 Detaljert beskrivelse

Returnerer data for en eller flere underenheter som er registrert i enhetsregisteret.

URL

/underenhet?page={page}&size={size}&$filter={filter}

Metode

GET

URL parametere

Frivillig
  • page = Integer [0,)
  • size = Integer [1, 100]
  • $filter = String

     Filtrerbare felter

    Se egen seksjon om  filtrering for hvordan man bygger opp filtere.

    FeltFilter
    organisasjonsnummereq
    navnstartswith, eq
    overordnetEnheteq
    organisasjonsformeq
    registreringsdatoEnhetsregistereteq, le, ge, lt, gt
    oppstartsdatoeq, le, ge, lt, gt
    datoEierskifteeq, le, ge, lt, gt
    registrertIMvaregistereteq
    antallAnsatteeq, le, ge, lt, gt
    hjemmesideeq
    naeringskode1.kodestartswith, eq
    naeringskode2.kodestartswith, eq
    naeringskode3.kodestartswith, eq
    postadresse.adressestartswith, eq
    postadresse.postnummereq, le, ge, lt, gt
    postadresse.poststedeq
    postadresse.kommunenummereq, le, ge, lt, gt
    postadresse.kommuneeq
    postadresse.landkodeeq
    postadresse.landeq
    beliggenhetsadresse.adressestartswith, eq
    beliggenhetsadresse.postnummereq, le, ge, lt, gt
    beliggenhetsadresse.poststedeq
    beliggenhetsadresse.kommunenummereq, le, ge, lt, gt
    beliggenhetsadresse.kommuneeq
    beliggenhetsadresse.landkodeeq
    beliggenhetsadresse.landeq

Suksess respons

  • Kode: 200

  • Innhold

     JSON Skjema

    Skjemaet inkluderer ikke hypermedia kontroller. Det gjøres oppmerksom på at urler til refererte skjemaer ikke er derefererbare.

    {
       "$schema":"http://json-schema.org/draft-04/schema#",
       "type":"object",
       "properties":{
          "data":{
             "type":"array",
             "description":"Liste med underenheter.",
             "items":{      
                "$ref":"http://data.brreg.no/enhetsregisteret/underenhet#"
             }
          },
          "page":{
             "type":"object",
             "properties":{
                "size":{
                   "type":"integer"
                },
                "page":{
                   "type":"integer"
                }
             },
             "required": ["size", "page"]
          }
       },
       "required": ["page"]
    }
     CSV beskrivelse

    x = alfanumerisk, 9 = tall

    KolonneKolonneoverskrift/feltDatatypeBeskrivelse
    1organisasjonsnummer9(9) 
    2navnx(180) 
    3overordnetEnhet9(9) 
    4organisasjonsformx(4) 
    5registreringsdatoEnhetsregisteretx(10)YYYY-MM-DD
    6oppstartsdatox(10)YYYY-MM-DD
    7datoEierskiftex(10)YYYY-MM-DD
    8registrertIMvaregisteretx(1)J eller N
    9frivilligRegistrertIMvaregisteretx(70) ; x(70) ; ..

    Kolonnen kan inneholde flere verdier per rad, og disse er
    da innad i hver celle igjen separert vha. semikolon.

    10antallAnsatteint 
    11hjemmesidex(150) 
    12naeringskode1.kodex(6)9(2).9(3)
    13naeringskode1.beskrivelsex(140) 
    14naeringskode2.kodex(6)9(2).9(3)
    15naeringskode2.beskrivelsex(140) 
    16naeringskode3.kodex(6)9(2).9(3)
    17naeringskode3.beskrivelsex(140) 
    18postadresse.adressex(110) 
    19postadresse.postnummer9(4) 
    20postadresse.poststedx(28) 
    21postadresse.kommunenummer9(4) 
    22postadresse.kommunex(26) 
    23postadresse.landkodex(3) 
    24postadresse.landx(35) 
    25beliggenhetsadresse.adressex(110) 
    26beliggenhetsadresse.postnummer9(4) 
    27beliggenhetsadresse.poststedx(28) 
    28beliggenhetsadresse.kommunenummer9(4) 
    29beliggenhetsadresse.kommunex(26) 
    30beliggenhetsadresse.landkodex(3) 
    31beliggenhetsadresse.landx(35) 

Feil respons

  • Kode: 400
    Ved ulovlige input parametere.

Eksempel

 

Oppslag på underenhethttp://data.brreg.no/enhetsregisteret/underenhet/{organisasjonsnummer}.{format}http://data.brreg.no/enhetsregisteret/underenhet/874714852.json
 Detaljert beskrivelse

Returnerer data for en underenhet som er registrert i enhetsregisteret.

URL

/underenhet/{organisasjonsnummer}

Metode

GET

URL parametere

Påkrevd

organisasjonsnummer = Integer

Suksess respons

  • Kode: 200
  • Innhold:

     JSON Skjema

    Skjemaet gir en oversikt over alle felter for underenheter. Hypermedia kontroller er ikke med i skjemaet.

    {
       "$schema":"http://json-schema.org/draft-04/schema#",
       "id":"http://data.brreg.no/enhetsregisteret/underenhet#",
       "type":"object",
       "properties":{
          "organisasjonsnummer":{
             "type":"integer"
          },
          "navn":{
             "type":"string"
          },
          "organisasjonsform":{
             "type":"string",
             "pattern":"^\\w{4}$"
          },
          "registreringsdatoEnhetsregisteret":{
             "type":"string"
          },
          "oppstartsdato":{
             "type":"string"
          },
          "datoEierskifte":{
             "type":"string"
          },
          "registrertIMvaregisteret":{
             "type":"string",
             "enum":[
                "J",
                "N"
             ]
          },
          "frivilligRegistrertIMvaregisteret":{
             "type":"array",
             "items":{
                "type":"string"
             }
          },
          "antallAnsatte":{
             "type":"integer"
          },
          "hjemmeside":{
             "type":"string"
          },
          "naeringskode1":{
             "$ref":"#/definitions/naeringskode"
          },
          "naeringskode2":{
             "$ref":"#/definitions/naeringskode"
          },
          "naeringskode3":{
             "$ref":"#/definitions/naeringskode"
          },
          "postadresse":{
             "$ref":"#/definitions/adresse"
          },
          "beliggenhetsadresse":{
             "$ref":"#/definitions/adresse"
          },
          "overordnetEnhet":{
             "type":"integer"
          }
       },
       "required":[
          "organisasjonsnummer",
          "navn",
          "organisasjonsform",
          "registreringsdatoEnhetsregisteret",
          "registrertIMvaregisteret"
       ],
       "definitions":{
          "adresse":{
             "type":"object",
             "properties":{
                "adresse":{
                   "type":"string"
                },
                "postnummer":{
                   "type":"string",
                   "pattern":"^[0-9]{4}$"
                },
                "poststed":{
                   "type":"string"
                },
                "kommunenummer":{
                   "type":"string",
                   "pattern":"^[0-9]{4}$"
                },
                "kommune":{
                   "type":"string"
                },
                "landkode":{
                   "type":"string",
                   "pattern":"^[a-zA-Z]{2,3}$"
                },
                "land":{
                   "type":"string"
                }
             }
          },
          "naeringskode":{
             "type":"object",
             "properties":{
                "kode":{
                   "type":"string",
                   "pattern":"^[0-9]{2}\\.[0-9]{3}$"
                },
                "beskrivelse":{
                   "type":"string"
                }
             }
          }
       }
    }
     CSV beskrivelse

    x = alfanumerisk, 9 = tall

    KolonneKolonneoverskrift/feltDatatypeBeskrivelse
    1organisasjonsnummer9(9) 
    2navnx(180) 
    3overordnetEnhet9(9) 
    4organisasjonsformx(4) 
    5registreringsdatoEnhetsregisteretx(10)YYYY-MM-DD
    6oppstartsdatox(10)YYYY-MM-DD
    7datoEierskiftex(10)YYYY-MM-DD
    8registrertIMvaregisteretx(1)J eller N
    9frivilligRegistrertIMvaregisteretx(70) ; x(70) ; ..

    Kolonnen kan inneholde flere verdier per rad, og disse er
    da innad i hver celle igjen separert vha. semikolon.

    10antallAnsatteint 
    11hjemmesidex(150) 
    12naeringskode1.kodex(6)9(2).9(3)
    13naeringskode1.beskrivelsex(140) 
    14naeringskode2.kodex(6)9(2).9(3)
    15naeringskode2.beskrivelsex(140) 
    16naeringskode3.kodex(6)9(2).9(3)
    17naeringskode3.beskrivelsex(140) 
    18postadresse.adressex(110) 
    19postadresse.postnummer9(4) 
    20postadresse.poststedx(28) 
    21postadresse.kommunenummer9(4) 
    22postadresse.kommunex(26) 
    23postadresse.landkodex(3) 
    24postadresse.landx(35) 
    25beliggenhetsadresse.adressex(110) 
    26beliggenhetsadresse.postnummer9(4) 
    27beliggenhetsadresse.poststedx(28) 
    28beliggenhetsadresse.kommunenummer9(4) 
    29beliggenhetsadresse.kommunex(26) 
    30beliggenhetsadresse.landkodex(3) 
    31beliggenhetsadresse.landx(35) 

Feil respons

  • Kode: 404
    Enheten finnes ikke.

Eksempel

Filtrering

APIet støtter søk/filtrering vha. et gitt sett av operasjoner som kan angis vha. $filter parameteret. Syntaksen er basert på uri-konvensjonene som benyttes for filtrering i OData/Open Data Protocol.

OperasjonSyntaksEksempelBegrensninger
Begynner medstartswith(feltnavn, 'tekst')$filter=startswith(navn,'Brønnøy')Minst to tegn må angis.
Er likfeltnavn eq verdi$filter=underAvvikling eq 'J'Bolske felter håndterer både 'J'/'N' samt true/false.
Større ennfeltnavn gt verdi$filter=antallAnsatte gt 100 
Mindre ennfeltnavn lt verdi$filter=antallAnsatte lt 100 
Større enn eller likfeltnavn ge verdi$filter=antallAnsatte ge 100 
Mindre enn eller likfeltnavn le verdi$filter=antallAnsatte le 100 
Oguttrykk and uttrykk$filter=startswith(navn,'sta') and antallAnsatte gt 10 
Elleruttrykk or uttrykk$filter=startswith(navn,'sta') or antallAnsatte le 10 

Filtrering på dato felter

Ved filtrering på datofelter må man definere dato/tid verdien man søker på vha. mønsteret datetime'yyyy-MM-DDTHH:mm'. For eksempel gir registreringsdatoEnhetsregisteret gt datetime'2012-01-01T00:00' et filter hvor registreringsdato i enhetsregisteret er før 01.01.2012 kl 00:00.

Filtrering på nøstede felter

Ved filtrering i nøstede strukturer benyttes "/" som en separator. Gitt JSON strukturen under vil stien til adresse feltet uttrykkes vha. "postadresse/adresse". Eksempel: startswith(postadresse/adresse,  'adresse').

 

{
  "postadresse": {
    "adresse": "adresse verdi"
  }
}

Eksempler på sammensatte filtere

FilterBeskrivelse

$filter=antallAnsatte gt 1 and antallAnsatte lt 1000 and underAvvikling eq 'J' and forretningsadresse/poststed eq 'Stavanger'

Enheter med 2 til 999 ansatte som er under avvikling og som har poststed i Stavanger.
$filter=antallAnsatte ge 1000 and (forretningsadresse/poststed eq 'Stavanger' or forretningsadresse/poststed eq 'Oslo')Enheter med 1000 eller flere ansatte og som har poststed i Stavanger eller Oslo.
$filter=stiftelsesdato ge datetime'2010-01-01T00:00' and stiftelsesdato le datetime'2013-01-01T00:00'Enheter med stiftelsesdato mellom 01.01.2010 og 01.01.2013.

Paginering

Ressursene som returnerer en liste kan pagineres ved at man angir ønsket side og antall enheter per side. Maks antall enheter per side er 100, og man kan maksimalt navigere seg gjennom de 10 000 første enhetene. Ved behov for å navigere utover dette antallet må man laste ned komplett datasett.

Ønsket side angis med parameteret page, hvor første side er page=0 (0-indeksert). Antall elementer per side angis med parameteret size, hvor size=100 er standardverdien. Eksempel for å hente side 3 med 30 enheter per side: http://data.brreg.no/enhetsregisteret/enhet.json?page=2&size=30

I responsen finnes meta-informasjon om hvilken side man står på, antall elementer per side samt lenker til forrige og neste side dersom disse eksisterer. I eksemplet under ser man at page=1 og size=1 samt at både prev og next linkene er definert.

 

{
   "links":[
      {
         "rel":"prev",
         "href":"http://data.brreg.no/enhetsregisteret/enhet.json?page=0&size=1&$filter=startswith%28navn%2C%27kommune%27%29"
      },
      {
         "rel":"next",
         "href":"http://data.brreg.no/enhetsregisteret/enhet.json?page=2&size=1&$filter=startswith%28navn%2C%27kommune%27%29"
      },
      {
         "rel":"self",
         "href":"http://data.brreg.no/enhetsregisteret/enhet.json?page=1&size=1&$filter=startswith%28navn%2C%27kommune%27%29"
      }
   ],
   "data":[
      {
         "organisasjonsnummer":990490813,
         "navn":"KOMMUNEKASSERAREN I LEIKANGER",
         "registreringsdatoEnhetsregisteret":"2007-03-19",
         "organisasjonsform":"ADOS",
         "registrertIFrivillighetsregisteret":"N",
         "registrertIMvaregisteret":"N",
         "registrertIForetaksregisteret":"N",
         "registrertIStiftelsesregisteret":"N",
         "antallAnsatte":0,
         "forretningsadresse":{
            "adresse":"Skrivarvegen 7",
            "postnummer":"6863",
            "poststed":"LEIKANGER",
            "kommunenummer":"1419",
            "kommune":"LEIKANGER",
            "landkode":"NO",
            "land":"Norge"
         },
         "konkurs":"N",
         "underAvvikling":"N",
         "underTvangsavviklingEllerTvangsopplosning":"N",
         "links":[
            {
               "rel":"self",
               "href":"http://data.brreg.no/enhetsregisteret/enhet/990490813"
            }
         ]
      }
   ],
   "page":{
      "size":1,
      "page":1
   }
}

Versjonering av tjenesten

Vi ønsker å holde tjenesten mest mulig bakoverkompatibel og tjenesten er derfor versjonert. Innenfor en versjon vil ingen elementer eller attributter endre navn, men det kan dukke opp nye elementer. Versjoneringen gjøres vha. leverandørspesifikke mediatyper, men for versjon 1 vil også standard mediatyper fungere. Når det kommer en ny versjon av APIet må man dermed eksplisitt angi at man ønsker å benytte denne versjonen ved å legge inn dette i Accept headeren på forespørselen. Når en ny versjon legges ut vil denne siden oppdateres med informasjon om den nye mediatypen.

For versjon 1 av APIet kan man om ønskelig benytte vnd.er-api-v1.0, f.eks. kan Accept headeren settes til application/vnd.er-api-v1.0+json for JSON eller til application/vnd.er-api-v1.0+xml for XML.

Komplett datasett

Det er mulig å laste ned et komplett datasett ved å benytte nedlastingslenke. Per dags dato tilbys komplette datasett kun i form av CSV filer. Det gjøres oppmerksom på at disse filene produseres hver natt mandag, tirsdag, onsdag og torsdag, samt lørdag ettermiddag. Innholdet i disse kan dermed kan avvike noe fra hva som gis av APIet. Tidspunkt for nattproduksjon av komplett datasett kan variere (avhengig av saksmengde som skal prosesseres fra dagen før). De vil normalt være utført til kl 05:00.

Navngiving av filene har følgende format: <datasett>.<ddMMyyyyHHmm>.csv, hvor datasett er enten hovedenheter eller underenheter og tidsangivelse represtenterer når filen ble ferdig produsert. Filene er komprimert med GZIP.

Oversikt over kolonner og datatyper for hvert datasett er beskrevet nærmere på følgende sider:

 

  • No labels

3 Comments

  1. Jeg synes dette så veldig bra ut!
    (smile) 
    Forslag til endringer
    • Bør forklare hva en hoved og underenhet er. 
    • Angi hvilken standard vi bruker på filteroperasjoner

     

  2. Enig. Det er lagt til en kort henvisning til OData for filtrering.

    En kort og presis forklaring på hva en hovedenhet og underenhet tror jeg nok Elin bør utforme.

  3. Bør også være med en kort forklaring på hva et API faktisk er. I og med at det blir liggende en lenke "API", vil det nok være flere som "klikker seg innom der" enn de som faktisk skal bruke API'et og som vet hva det API betyr.. (smile)