NAV
json xml

Introduksjon

I tillegg til SGregister som en nettside for søk etter foretak med sentral godkjenning har vi også etablert et REST-API som kan brukes til å raskt slå opp og hente inn data fra registeret. Målgruppen for dette APIet er datasystemer og nettsider som ønsker å sjekke om et foretak har sentral godkjenning.

APIet er åpent og gratis tilgjengelig for alle som ønsker å bruke det. Systemeiere trenger ikke å registrere sin bruk hos Direktoratet for byggkvalitet. Vi oppfordrer dog brukere til å ikke lagre data fra registeret permanent, men heller bruke APIet til direkte eller regelmessige oppslag.

API Versjon 1

APIet returnerer JSON eller XML.

Databeskrivelse

Data returnert av APIet er en datastruktur som kan representeres i JSON eller som XML. Oppbygningen er laget slik at data kan brukes både i lesbar form og i kode-form, etter mal fra ByggSøk-XML.

status

Status-delen inneholder generell informasjon om godkjenningen.

Felt Type Beskrivelse
approved Boolean true for et godkjent foretak, false for et ikke godkjent foretak
approval_period_to String Utløpsdato for godkjenningen
approval_certificate String URL for nedlasting av foretakets godkjenningsbevis

enterprise

Enterprise-delen inneholder data om foretaket som har godkjenningen.

Felt Type Beskrivelse
organizational_number String Foretakets organisasjonsnummer
name String Foretakets navn
www String Foretakets nettsideadresse, hvis oppgitt
email String Foretakets e-postadresse, hvis oppgitt
phone String Foretakets telefonnr, hvis oppgitt

businessaddress / postaladdress

Felt Type Beskrivelse
line_1 String Adresselinje 1
line_2 String Adresselinje 2
line_3 String Adresselinje 3
line_4 String Adresselinje 4
postal_code String Postkode
postal_town String Poststed
country String Landkode (ISO 3166-1 alpha-2)

valid_approval_areas

Denne delen inneholder foretakets gyldige godkjenningsområder, med hvert område som et array-element med følgende innhold:

Felt Type Beskrivelse
function String Funksjon, skrevet i klartekst
function_xml String Funksjon, som XML-kode fra ByggSøk
subject_area String Navn på godkjenningsområdet
subject_area_xml String XML-kode for godkjenningsområdet
pbl String PBL-nivået på godkjenningsområdet, i klartekst
pbl_xml String PBL-nivået som XML-kode
grade String Tiltaksklassen for godkjenningsområdet

additional_terms

Denne delen inneholder tilleggsopplysninger

Felt Type Beskrivelse
liability_insurance boolean Hvorvidt foretaket innehar ansvarsforsikring
industrial_injury_insurance boolean Hvorvidt foretaket innehar yrkesskadeforsikring
educational_enterprise_approved boolean Hvorvidt foretaket er godkjent opplæringsbedrift

Ett foretak

Eksempel på kall

$ curl https://sgregister.dibk.no/api/enterprises/123456789.xml \
   -H 'Accept: application/vnd.sgpub.v1'

$ curl https://sgregister.dibk.no/api/enterprises/123456789.json \
   -H 'Accept: application/vnd.sgpub.v1'

Eksempel på resultat:

{
  "dibk-sgdata": {
    "status": {
      "approved": true,
      "approval_period_to": "2022-01-09",
      "approval_certificate": "http://sgregister.dibk.no/enterprises/974760223/approval_certificate"
    },
    "enterprise": {
      "organizational_number": "974760223",
      "name": "DIREKTORATET FOR BYGGKVALITET",
      "www": "www.dibk.no",
      "email": "[email protected]",
      "phone": "22 47 56 00",
      "businessaddress": {
        "line_1": "Mariboes gate 13",
        "line_2": null,
        "line_3": null,
        "line_4": null,
        "postal_code": "0183",
        "postal_town": "OSLO",
        "country": "NO"
      },
      "postaladdress": {
        "line_1": "Postboks 8742 Youngstorget",
        "line_2": null,
        "line_3": null,
        "line_4": null,
        "postal_code": "0028",
        "postal_town": "OSLO",
        "country": "NO"
      }
    },
    "valid_approval_areas": [
      {
        "function": "Utførende",
        "function_xml": "UTF",
        "subject_area": "Landskapsutforming",
        "subject_area_xml": "ULANDSKU",
        "pbl": "PBL 2016",
        "pbl_xml": "pbl2016",
        "grade": "2"
      }
    ],
    "additional_terms": {
      "liability_insurance": false,
      "industrial_injury_insurance": false,
      "educational_enterprise_approved": false
    }
  }
}

<dibk-sgdata xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <status>
    <approved type="boolean">true</approved>
    <approval-period-to type="date">2022-01-09</approval-period-to>
    <approval-certificate>http://sgregister.dibk.no/enterprises/974760223/approval_certificate</approval-certificate>
  </status>
  <enterprise>
    <organizational-number>974760223</organizational-number>
    <name>DIREKTORATET FOR BYGGKVALITET</name>
    <www>www.dibk.no</www>
    <email>[email protected]</email>
    <phone>22 47 56 00</phone>
    <businessaddress>
      <line-1>Mariboes gate 13</line-1>
      <line-2 xsi:nil="true"/>
      <line-3 xsi:nil="true"/>
      <line-4 xsi:nil="true"/>
      <postal-code>0183</postal-code>
      <postal-town>OSLO</postal-town>
      <country>NO</country>
    </businessaddress>
    <postaladdress>
      <line-1>Postboks 8742 Youngstorget</line-1>
      <line-2 xsi:nil="true"/>
      <line-3 xsi:nil="true"/>
      <line-4 xsi:nil="true"/>
      <postal-code>0028</postal-code>
      <postal-town>OSLO</postal-town>
      <country>NO</country>
    </postaladdress>
  </enterprise>
  <valid-approval-areas type="array">
    <valid-approval-area>
      <function>Utførende</function>
      <function-xml>UTF</function-xml>
      <subject-area>Landskapsutforming</subject-area>
      <subject-area-xml>ULANDSKU</subject-area-xml>
      <pbl>PBL 2016</pbl>
      <pbl-xml>pbl2016</pbl-xml>
      <grade>2</grade>
    </valid-approval-area>
  </valid-approval-areas>
  <additional-terms>
    <liability-insurance type="boolean">false</liability-insurance>
    <industrial-injury-insurance type="boolean">false</industrial-injury-insurance>
    <educational-enterprise-approved type="boolean">false</educational-enterprise-approved>
  </additional-terms>
</dibk-sgdata>

Dette endepunktet returnerer data om ett foretak som har eller har hatt sentral godkjenning.

HTTP Request

GET https://sgregister.dibk.no/api/enterprises/:organizational_number(.json|.xml)

Parameter  Beskrivelse
organizational_number Organisasjonsnummeret å gjøre oppslag på

API Versjon 2

APIet returnerer JSON eller XML.

Databeskrivelse

Data returnert av APIet er en datastruktur som kan representeres i JSON eller som XML. Oppbygningen er laget slik at data kan brukes både i lesbar form og i kode-form, etter mal fra ByggSøk-XML.

status

Status-delen inneholder generell informasjon om godkjenningen.

Felt Type Beskrivelse
approved Boolean true for et godkjent foretak, false for et ikke godkjent foretak
approval_period_to String Utløpsdato for godkjenningen
approval_certificate String URL for nedlasting av foretakets godkjenningsbevis

enterprise

Enterprise-delen inneholder data om foretaket som har godkjenningen.

Felt Type Beskrivelse
organizational_number String Foretakets organisasjonsnummer
name String Foretakets navn
www String Foretakets nettsideadresse, hvis oppgitt
email String Foretakets e-postadresse, hvis oppgitt
phone String Foretakets telefonnr, hvis oppgitt

businessaddress / postaladdress

Felt Type Beskrivelse
line_1 String Adresselinje 1
line_2 String Adresselinje 2
line_3 String Adresselinje 3
line_4 String Adresselinje 4
postal_code String Postkode
postal_town String Poststed
country String Landkode (ISO 3166-1 alpha-2)

valid_approval_areas

Denne delen inneholder foretakets gyldige godkjenningsområder, med hvert område som et array-element med følgende innhold:

Felt Type Beskrivelse
function String Funksjon, skrevet i klartekst
function_xml String Funksjon, som XML-kode fra ByggSøk
subject_area String Navn på godkjenningsområdet
subject_area_xml String XML-kode for godkjenningsområdet
pbl String PBL-nivået på godkjenningsområdet, i klartekst
pbl_xml String PBL-nivået som XML-kode
grade String Tiltaksklassen for godkjenningsområdet

additional_terms

Denne delen inneholder tilleggsopplysninger

Felt Type Beskrivelse
liability_insurance boolean Hvorvidt foretaket innehar ansvarsforsikring
industrial_injury_insurance boolean Hvorvidt foretaket innehar yrkesskadeforsikring
educational_enterprise_approved boolean Hvorvidt foretaket er godkjent opplæringsbedrift

Alle foretak

Dette endepunktet returnerer data om alle foretak som har eller har hatt sentral godkjenning.

HTTP Request

GET https://sgregister.dibk.no/api/enterprises(.json|.xml)

Eksempel på kall:

  $ curl https://sgregister.dibk.no/api/enterprises.xml \
     -H 'Accept: application/vnd.sgpub.v2' \
     -H 'Accept-Encoding: gzip,deflate'

  $ curl https://sgregister.dibk.no/api/enterprises.json \
     -H 'Accept: application/vnd.sgpub.v2' \
     -H 'Accept-Encoding: gzip,deflate'

Eksempel på resultat:

<enterprises type="array" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <enterprise>
    <organizational-number>974760223</organizational-number>
    <name>DIREKTORATET FOR BYGGKVALITET</name>
    <www>www.dibk.no</www>
    <email>[email protected]</email>
    <phone>22 47 56 00</phone>
    <businessaddress>
      <line-1>Mariboes gate 13</line-1>
      <line-2 xsi:nil="true"/>
      <line-3 xsi:nil="true"/>
      <line-4 xsi:nil="true"/>
      <postal-code>0183</postal-code>
      <postal-town>OSLO</postal-town>
      <country>NO</country>
    </businessaddress>
    <postaladdress>
      <line-1>Postboks 8742 Youngstorget</line-1>
      <line-2 xsi:nil="true"/>
      <line-3 xsi:nil="true"/>
      <line-4 xsi:nil="true"/>
      <postal-code>0028</postal-code>
      <postal-town>OSLO</postal-town>
      <country>NO</country>
    </postaladdress>
    <status>
      <approved type="boolean">true</approved>
      <approval-period-to type="date">2022-01-09</approval-period-to>
      <approval-certificate>http://sgregister.dibk.no/enterprises/974760223/approval_certificate</approval-certificate>
    </status>
    <valid-approval-areas type="array">
      <valid-approval-area>
        <function>Utførende</function>
        <function-xml>UTF</function-xml>
        <subject-area>Landskapsutforming</subject-area>
        <subject-area-xml>ULANDSKU</subject-area-xml>
        <pbl>PBL 2016</pbl>
        <pbl-xml>pbl2016</pbl-xml>
        <grade>2</grade>
      </valid-approval-area>
    </valid-approval-areas>
    <additional-terms>
      <liability-insurance type="boolean">false</liability-insurance>
      <industrial-injury-insurance type="boolean">false</industrial-injury-insurance>
      <educational-enterprise-approved type="boolean">false</educational-enterprise-approved>
    </additional-terms>
  </enterprise>
</enterprises>

{
  "enterprises": [
    {
      "organizational_number": "974760223",
      "name": "DIREKTORATET FOR BYGGKVALITET",
      "www": "www.dibk.no",
      "email": "[email protected]",
      "phone": "22 47 56 00",
      "businessaddress": {
        "line_1": "Mariboes gate 13",
        "line_2": null,
        "line_3": null,
        "line_4": null,
        "postal_code": "0183",
        "postal_town": "OSLO",
        "country": "NO"
      },
      "postaladdress": {
        "line_1": "Postboks 8742 Youngstorget",
        "line_2": null,
        "line_3": null,
        "line_4": null,
        "postal_code": "0028",
        "postal_town": "OSLO",
        "country": "NO"
      },
      "status": {
        "approved": true,
        "approval_period_to": "2022-01-09",
        "approval_certificate": "http://sgregister.dibk.no/enterprises/974760223/approval_certificate"
      },
      "valid_approval_areas": [
        {
          "function": "Utførende",
          "function_xml": "UTF",
          "subject_area": "Landskapsutforming",
          "subject_area_xml": "ULANDSKU",
          "pbl": "PBL 2016",
          "pbl_xml": "pbl2016",
          "grade": "2"
        }
      ],
      "additional_terms": {
        "liability_insurance": false,
        "industrial_injury_insurance": false,
        "educational_enterprise_approved": false
      }
    }
  ]
}

Ett foretak

Eksempel på kall

$ curl https://sgregister.dibk.no/api/enterprises/123456789.xml \
   -H 'Accept: application/vnd.sgpub.v2'

$ curl https://sgregister.dibk.no/api/enterprises/123456789.json \
   -H 'Accept: application/vnd.sgpub.v2'

Eksempel på resultat:

{
  "enterprise": {
    "status": {
      "approved": true,
      "approval_period_to": "2022-01-09",
      "approval_certificate": "http://sgregister.dibk.no/enterprises/974760223/approval_certificate"
    },
    "enterprise": {
      "organizational_number": "974760223",
      "name": "DIREKTORATET FOR BYGGKVALITET",
      "www": "www.dibk.no",
      "email": "[email protected]",
      "phone": "22 47 56 00",
      "businessaddress": {
        "line_1": "Mariboes gate 13",
        "line_2": null,
        "line_3": null,
        "line_4": null,
        "postal_code": "0183",
        "postal_town": "OSLO",
        "country": "NO"
      },
      "postaladdress": {
        "line_1": "Postboks 8742 Youngstorget",
        "line_2": null,
        "line_3": null,
        "line_4": null,
        "postal_code": "0028",
        "postal_town": "OSLO",
        "country": "NO"
      }
    },
    "valid_approval_areas": [
      {
        "function": "Utførende",
        "function_xml": "UTF",
        "subject_area": "Landskapsutforming",
        "subject_area_xml": "ULANDSKU",
        "pbl": "PBL 2016",
        "pbl_xml": "pbl2016",
        "grade": "2"
      }
    ],
    "additional_terms": {
      "liability_insurance": false,
      "industrial_injury_insurance": false,
      "educational_enterprise_approved": false
    }
  }
}

<enterprise xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <status>
    <approved type="boolean">true</approved>
    <approval-period-to type="date">2022-01-09</approval-period-to>
    <approval-certificate>http://sgregister.dibk.no/enterprises/974760223/approval_certificate</approval-certificate>
  </status>
  <enterprise>
    <organizational-number>974760223</organizational-number>
    <name>DIREKTORATET FOR BYGGKVALITET</name>
    <www>www.dibk.no</www>
    <email>[email protected]</email>
    <phone>22 47 56 00</phone>
    <businessaddress>
      <line-1>Mariboes gate 13</line-1>
      <line-2 xsi:nil="true"/>
      <line-3 xsi:nil="true"/>
      <line-4 xsi:nil="true"/>
      <postal-code>0183</postal-code>
      <postal-town>OSLO</postal-town>
      <country>NO</country>
    </businessaddress>
    <postaladdress>
      <line-1>Postboks 8742 Youngstorget</line-1>
      <line-2 xsi:nil="true"/>
      <line-3 xsi:nil="true"/>
      <line-4 xsi:nil="true"/>
      <postal-code>0028</postal-code>
      <postal-town>OSLO</postal-town>
      <country>NO</country>
    </postaladdress>
  </enterprise>
  <valid-approval-areas type="array">
    <valid-approval-area>
      <function>Utførende</function>
      <function-xml>UTF</function-xml>
      <subject-area>Landskapsutforming</subject-area>
      <subject-area-xml>ULANDSKU</subject-area-xml>
      <pbl>PBL 2016</pbl>
      <pbl-xml>pbl2016</pbl-xml>
      <grade>2</grade>
    </valid-approval-area>
  </valid-approval-areas>
  <additional-terms>
    <liability-insurance type="boolean">false</liability-insurance>
    <industrial-injury-insurance type="boolean">false</industrial-injury-insurance>
    <educational-enterprise-approved type="boolean">false</educational-enterprise-approved>
  </additional-terms>
</enterprise>

Dette endepunktet returnerer data om ett foretak som har eller har hatt sentral godkjenning.

HTTP Request

GET https://sgregister.dibk.no/api/enterprises/:organizational_number(.json|.xml)

Parameter  Beskrivelse
organizational_number Organisasjonsnummeret å gjøre oppslag på

Feilmeldinger

Feilkode Beskrivelse
400 Bad Request Feil i spørringen.
404 Not Found Foretaket ble ikke funnet.
405 Method Not Allowed Feil metode ble brukt (f.eks ble HTTP POST brukt i stedet for GET).
406 Not Acceptable Formatet er feil (ikke XML eller JSON).
429 Too Many Requests For mange spørringer ble gjort.
500 Internal Server Error Et problem oppsto på serveren. Vennligst prøv igjen senere.
503 Service Unavailable Tjenesten er nede for vedlikehold. Vennligst prøv igjen senere.
json xml