Oppbygging GrunndataWS
Sist oppdatert: 10. juli 2023.
Alle tjenester som legges ut under grunndataWS er bygd opp over samme lest. Det vil si at resultatet som sendes tilbake til det spørrende systemet er bygd opp av:
- responseHeader
- melding
ResponseHeader er en generell header som blant annet inneholder informasjon om hvordan spørringen har gått. Meldingselementet er et hovedelement som inneholder informasjon om enheten som det spørres på.
ResponseHeader
Alle meldinger som blir returnert til tjenesten skal inneholde en responseHeader. Denne headeren er bygd opp på følgende måte:
<responseHeader prossessDato=»2003-09-17″ tjeneste=»hentBasisdataMini»>
<orgnr>980123456</orgnr>
<hovedStatus>0</hovedStatus>
<underStatus>
<underStatusMelding kode=»0″>Data returnert</underStatusMelding>
<underStatusMelding kode=»1020″>Enhet 980123456 har ikke postadresse</underStatusMelding>
</underStatus>
</responseHeader>
Statuser
For hver enkelt spørring vil det bli satt en status som sier hvordan spørringen har gått. Alle spørringene som har gått bra vil ha hovedstatus satt til 0. I tillegg vil det også være en understatus som er en videre spesifisering på hovedstatusen. Ikke all informasjon er registrert på alle organisasjoner. I de tilfellene det mangler informasjon, vil dette gå fram her, for eksempel hvis en enhet ikke har registrert postadresse. Understatusen sier ingenting om enheten etter loven skulle hatt opplysningen.
I enkelte tilfeller blir det spurt på enheter hvor du ikke får ut data. Så lenge spørringen har gått OK, vil hovedstatus bli satt til 1, mens understatus beskriver hvorfor du ikke har fått ut data. Dette kan være fordi enheten er slettet.
Hovedstatus
Hovedstatus sier hvordan spørringen har gått. Følgende hovedstatuser er definert:
| Hovedstatus | Beskrivelse |
|---|---|
| 0 | Spørringen har gått OK. |
| 1 | Spørringen har gått OK, men data mangler. For detaljer, se understatus. |
| -1 | Det har oppstått feil knyttet til tjenesten. |
Understatus
Understatus er en nærmere beskrivelse av hovedstatus, eventuelt en utfyllende beskrivelse av hvorfor du ikke har fått alle data, slik som for eksempel at postadressen mangler.
| Kode | Melding |
|---|---|
| 0 | Data returnert. |
| 1 | Enhet x er slettet som dublett - korrekt enhet y er innført. |
| 2 | Enhet x er slettet som sammenslått - korrekt enhet y er innført. |
| 3 | Enhet x er registreringsenheten til den enheten som ble bestilt! |
| 10 | Orgnr i input ikke gitt. |
| 10000 | Ikke gyldig organisasjonsnummer. Organisasjonsnummer skal bestå av 9 siffer og kun tall. |
| 100 | Enhet x aldri opprettet. |
| 110 | Enhet x er slettet. |
| 120 | Enhet x er slettet som dublett eller sammenslått - korrekt enhet y er slettet. |
| 130 | Enhet x er en bedrift/virksomhet, juridisk enhet er y. |
| 160 | Input er ikke et organisasjonsnummer eller et fødselsnr. |
| 170 | x er ikke et gyldig organisasjonsnummer. |
| 180 | Personen x finnes ikke i vår database. |
| 181 | Personen x er registrert død. |
| 182 | Personen x er registrert ugyldig. |
| 183 | Personen x har verge. |
| 190 | Enhet x er ikke en bedrift/virksomhet. |
| 200 | Enhet x det spørres på er en registreringsenhet. |
| 210 | Enhet x er ikke registrert i Frivillighetsregisteret. |
| 2000 | Ingen endringer finnes i siste periode (siste døgn/helg) |
| 1010 | Enhet x har ikke forretningsadresse. |
| 1020 | Enhet x har ikke postadresse. |
| 1030 | Enhet x har ikke adresse. |
| 1060 | Enhet x har ikke stiftelsesdato. |
| 1070 | Enhet x har ikke målform. |
| 1080 | Enhet x har ikke reklame. |
| 1090 | Enhet x har ikke virksomhet/art/bransje. |
| 1100 | Enhet x har ikke formål. |
| 1111 | Enhet x har ikke vedtektsdato. |
| 1115 | Enhet x har ikke telefon. |
| 1116 | Enhet x har ikke telefax. |
| 1117 | Enhet x har ikke mobiltelefon. |
| 1118 | Enhet x har ikke e-postadresse. |
| 1119 | Enhet x har ikke hjemmeside. |
| 1120 | Enhet x har ikke særlige opplysninger. |
| 1125 | Enhet x har ikke næringskode. |
| 1130 | Enhet x har ikke sektorkode. |
| 1135 | Enhet x har ikke ansatte. |
| 1140 | Enhet x har ikke kapital. |
| 1145 | Enhet x har ikke bedrifter/virksomheter. |
| 1150 | Enhet x inngår ikke i konsern. |
| 1155 | Enhet x har ikke dato for oppstart. |
| 1160 | Enhet x har ikke dato for eierskifte. |
| 1165 | Enhet x har ikke hovedforetak. |
| 1180 | Enhet x har ikke rolleblokk n (et sett av roller). |
| 1190 | Enhet x har ikke frivillighetsregisterdata. |
| -100 | Bruker mangler autorisasjon for denne tjenesten. |
| -101 | Feil i brukernavn og/eller passord. |
| -1000 | Det har oppstått en uventet feil. Ved fortsatt gjentakelse, ta kontakt med Brønnøysundregistrene |
Lovlige kombinasjoner av statuser
| Hovedstatus | Understatus kode | Understatus Melding |
|---|---|---|
| 0 | 0 | Data returnert. |
| 0 | 1 | Enhet x er slettet som dublett - korrekt enhet y er innført |
| 0 | 2 | Enhet x er slettet som sammenslått - korrekt enhet y er innført. |
| 0 | 3 | Enhet x er registreringsenheten til den enheten som ble bestilt! |
| 1 | 10 | Orgnr i input ikke gitt. |
| 1 | 20 | Valideringsfeil i inputstreng: feilmeldingstekst |
| 1 | 10000 | Ikke gyldig organisasjonsnummer. Organisasjonsnummer skal bestå av 9 siffer og kun tall. |
| 1 | 100 | Enhet x aldri opprettet. |
| 1 | 110 | Enhet x er slettet. |
| 1 | 120 | Enhet x er slettet som dublett eller sammenslått - korrekt enhet y er slettet. |
| 1 | 130 | Enhet x er en bedrift/virksomhet, juridisk enhet er y. |
| 1 | 160 | Input er ikke et organisasjonsnummer eller et fødselsnr. |
| 1 | 170 | x er ikke et gyldig organisasjonsnummer. |
| 1 | 180 | Personen x er ikke i vår database. |
| 1 | 181 | Personen x er registrert død |
| 1 | 182 | Personen x er registrert ugyldig |
| 1 | 183 | Personen x har verge. |
| 1 | 190 | Enhet x er ikke en bedrift/virksomhet. |
| 1 | 200 | Enhet x det spørres på er en registreringsenhet. |
| 1 | 210 | Enhet x er ikke registrert i Frivillighetsregisteret. |
| 1 | 2000 | Ingen endringer finnes i siste periode (siste døgn/helg). |
| 0 | 1010 | Enhet x har ikke forretningsadresse. |
| 0 | 1020 | Enhet x har ikke postadresse. |
| 0 | 1030 | Enhet x har ikke adresse. |
| 0 | 1060 | Enhet x har ikke stiftelsesdato. |
| 0 | 1070 | Enhet x har ikke målform. |
| 0 | 1090 | Enhet x har ikke virksomhet/art/bransje. |
| 0 | 1100 | Enhet x har ikke formål. |
| 0 | 1111 | Enhet x har ikke vedtektsdato. |
| 0 | 1115 | Enhet x har ikke telefon. |
| 0 | 1116 | Enhet x har ikke telefax. |
| 0 | 1117 | Enhet x har ikke mobiltelefon. |
| 0 | 1118 | Enhet x har ikke e-postadresse. |
| 0 | 1119 | Enhet x har ikke hjemmeside. |
| 0 | 1120 | Enhet x har ikke særlige opplysninger. |
| 0 | 1125 | Enhet x har ikke næringskode. |
| 0 | 1130 | Enhet x har ikke sektorkode. |
| 0 | 1135 | Enhet x har ikke ansatte. |
| 0 | 1140 | Enhet x har ikke kapital. |
| 0 | 1145 | Enhet x har ikke bedrifter/virksomheter. |
| 0 | 1150 | Enhet x inngår ikke i konsern. |
| 0 | 1155 | Enhet x har ikke dato for oppstart. |
| 0 | 1160 | Enhet x har ikke dato for eierskifte. |
| 0 | 1165 | Enhet x har ikke hovedforetak. |
| 0 | 1180 | Enhet x har rolleblokk n (et sett av roller). |
| -1 | -100 | Bruker mangler autorisasjon for denne tjenesten. |
| -1 | -101 | Feil i brukernavn og/eller passord. |
| -1 | -1000 | Det har oppstått en uventet feil. Ved fortsatt gjentakelse, ta kontakt med Brønnøysundregistrene. |
Melding
I meldingselementet vil du finne all informasjon om en enhet som det spørres på. Meldingselementet er bare til stede i de tilfellene når hovedstatus er 0. Meldingen vil bygges opp forskjellig alt etter hvilke tjenester det spørres på, men vil ha dette generelle elementet:
<melding tjeneste=»hentBasisdataMini»>
Her vil informasjonen som det spørres på bli lagt.
</melding>