Oppbygging grunndataWS
Sist oppdatert: 14. juli 2023.
Alle tenester som blir lagde ut under grunndataWS er bygd opp over same lest. Det vil seie at resultatet som blir sendt tilbake til det spørjande systemet er bygd opp av:
- responseheader
- melding
RESponseheadar er ein generell header som blant anna inneheld informasjon om korleis spørjinga har gått. Meldingselementet er eit hovudelement som inneheld informasjon om eininga som det blir spurd på.
RESponseheader
Alle meldingar som blir returnerte til tenesta skal innehalde ein responseHeader. Denne headeren er bygd opp på følgande 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 ikkje postadresse</underStatusMelding>
</understatus>
</responseheader>
Statusar
For kvar enkelt spørjing vil det bli sett ein status som seier korleis spørjinga har gått. Alle spørjingane som har gått bra vil ha hovudstatus sett til 0. I tillegg vil det også vere ein understatus som er ei vidare spesifisering på hovudstatusen. Ikkje all informasjon er registrert på alle organisasjonar. I dei tilfella informasjon manglar, vil dette gå fram her, for eksempel dersom ei eining ikkje har registrert postadresse. Understatusen seier ingenting om eininga etter lova skulle hatt opplysninga.
I enkelte tilfelle blir det spurt på einingar der du ikkje får ut data. så lenge spørjinga har gått OK, vil hovudstatus bli sett til 1, mens understatus skildrar kvifor du ikkje har fått ut data. Dette kan vere fordi eininga er sletta.
Hovudstatus
Hovudstatus seier korleis spørjinga har gått. Følgande hovudstatusar er definerte:
| Hovudstatus | Skildring |
|---|---|
| 0 | Spørjinga har gått OK. |
| 1 | Spørjinga har gått OK, men data manglar. For detaljar, sjå understatus. |
| -1 | Det har oppstått feil knytt til tenesta. |
Understatus
Understatus er ei nærmare forklaring av hovudstatus, eventuelt ei utfyllande forklaring av kvifor du ikkje har fått alle data, slik som for eksempel at postadressa manglar.
| Kode | Melding |
|---|---|
| 0 | Data returnert. |
| 1 | Eining x er sletta som dublett - korrekt eining y er innført. |
| 2 | Eining x er sletta som samanslått - korrekt eining y er innført. |
| 3 | Eining x er registreringseininga til den eininga som blei bestilt. |
| 10 | Orgnr i input ikkje gitt. |
| 10000 | Ikkje gyldig organisasjonsnummer. Organisasjonsnummer skal bestå av 9 siffer og berre tal. |
| 100 | Eining x aldri oppretta. |
| 110 | Eining x er sletta. |
| 120 | Eining x er sletta som dublett eller samanslått - korrekt eining y er sletta. |
| 130 | Eining x er ei bedrift/verksemd, juridisk eining er y. |
| 160 | Input er ikkje eit organisasjonsnummer eller eit fødselsnr. |
| 170 | x er ikkje eit gyldig organisasjonsnummer. |
| 180 | Personen x finst ikkje i databasen vår. |
| 181 | Personen x er registrert død. |
| 182 | Personen x er registrert ugyldig. |
| 183 | Personen x har verje. |
| 190 | Eining x er ikkje ei bedrift/verksemd. |
| 200 | Eining x som blir spurd på er ei registreringeining. |
| 210 | Eining x er ikkje registrert i Frivilligregisteret. |
| 2000 | Ingen endringar finst i siste periode (siste døgn/helg) |
| 1010 | Eining x har ikkje forretningsadresse. |
| 1020 | Eining x har ikkje postadresse. |
| 1030 | Eining x har ikkje adresse. |
| 1060 | Eining x har ikkje stiftelsesdato. |
| 1070 | Eining x har ikkje målform. |
| 1080 | Eining x har ikkje reklame. |
| 1090 | Eining x har ikkje verksemd/art/bransje. |
| 1100 | Eining x har ikkje formål. |
| 1111 | Eining x har ikkje vedtektsdato. |
| 1115 | Eining x har ikkje telefon. |
| 1116 | Eining x har ikkje telefax. |
| 1117 | Eining x har ikkje mobiltelefon. |
| 1118 | Eining x har ikkje e-postadresse. |
| 1119 | Eining x har ikkje heimeside. |
| 1120 | Eining x har ikkje særlege opplysningar. |
| 1125 | Eining x har ikkje næringskode. |
| 1130 | Eining x har ikkje sektorkode. |
| 1135 | Eining x har ikkje tilsette. |
| 1140 | Eining x har ikkje kapital. |
| 1145 | Eining x har ikkje bedrifter/verksemder. |
| 1150 | Eining x inngår ikkje i konsern. |
| 1155 | Eining x har ikkje dato for oppstart. |
| 1160 | Eining x har ikkje dato for eigarskifte. |
| 1165 | Eining x har ikkje hovudføretak. |
| 1180 | Eining x har ikkje rolleblokk n (eit sett av roller). |
| 1190 | Eining x har ikkje frivilligregisterdata. |
| -100 | Brukar manglar autorisasjon for denne tenesta. |
| -101 | Feil i brukarnamn og/eller passord. |
| -1000 | Det har oppstått ein uventa feil. Ved framleis gjentaking, ta kontakt med Brønnøysundregistera. |
Lovlege kombinasjonar av statusar
| Hovudstatus | Understatus kode | Understatus Melding |
|---|---|---|
| 0 | 0 | Data returnert. |
| 0 | 1 | Eining x er sletta som dublett - korrekt eining y er innført |
| 0 | 2 | Eining x er sletta som samanslått - korrekt eining y er innført. |
| 0 | 3 | Eining x er registreringseininga til eininga som blei bestilt. |
| 1 | 10 | Orgnr i input ikkje gitt. |
| 1 | 20 | Valideringsfeil i inputstreng: feilmeldingstekst |
| 1 | 10000 | Ikkje gyldig organisasjonsnummer. Organisasjonsnummer skal bestå av 9 siffer og berre tal. |
| 1 | 100 | Eining x aldri oppretta. |
| 1 | 110 | Eining x er sletta. |
| 1 | 120 | Eining x er sletta som dublett eller samanslått - korrekt eining y er sletta. |
| 1 | 130 | Eining x er ei bedrift/verksemd, juridisk eining er y. |
| 1 | 160 | Input er ikkje et organisasjonsnummer eller eit fødselsnr. |
| 1 | 170 | x er ikkje eit gyldig organisasjonsnummer. |
| 1 | 180 | Personen x er ikkje i databasen vår. |
| 1 | 181 | Personen x er registrert død |
| 1 | 182 | Personen x er registrert ugyldig |
| 1 | 183 | Personen x har verje. |
| 1 | 190 | Eining x er ikkje ei bedrift/verksemd. |
| 1 | 200 | Eining x som blir spurd på er ei registreringseining. |
| 1 | 210 | Eining x er ikkje registrert i Frivilligregisteret. |
| 1 | 2000 | Ingen endringar finst i siste periode (siste døgn/helg). |
| 0 | 1010 | Eining x har ikkje forretningsadresse. |
| 0 | 1020 | Eining x har ikkje postadresse. |
| 0 | 1030 | Eining x har ikkje adresse. |
| 0 | 1060 | Eining x har ikkje stiftelsesdato. |
| 0 | 1070 | Eining x har ikkje målform. |
| 0 | 1090 | Eining x har ikkje verksemd/art/bransje. |
| 0 | 1100 | Eining x har ikkje formål. |
| 0 | 1111 | Eining x har ikkje vedtektsdato. |
| 0 | 1115 | Eining x har ikkje telefon. |
| 0 | 1116 | Eining x har ikkje telefax. |
| 0 | 1117 | Eining x har ikkje mobiltelefon. |
| 0 | 1118 | Eining x har ikkje e-postadresse. |
| 0 | 1119 | Eining x har ikkje heimeside. |
| 0 | 1120 | Eining x har ikkje særlege opplysningar. |
| 0 | 1125 | Eining x har ikkje næringskode. |
| 0 | 1130 | Eining x har ikkje sektorkode. |
| 0 | 1135 | Eining x har ikkje tilsette. |
| 0 | 1140 | Eining x har ikkje kapital. |
| 0 | 1145 | Eining x har ikkje bedrifter/verksemder. |
| 0 | 1150 | Eining x inngår ikkje i konsern. |
| 0 | 1155 | Eining x har ikkje dato for oppstart. |
| 0 | 1160 | Eining x har ikkje dato for eigarskifte. |
| 0 | 1165 | Eining x har ikkje hovudføretak. |
| 0 | 1180 | Eining x har rolleblokk n (eit sett av roller). |
| -1 | -100 | Brukar manglar autorisasjon for tenesta. |
| -1 | -101 | Feil i brukarnamn og/eller passord. |
| -1 | -1000 | Det har oppstått ein uventa feil. Ved fortsatt gjentaking, ta kontakt med Brønnøysundregistera. |
Melding
I meldingselementet vil du finne all informasjon om ei eining som blir spurd på. Meldingselementet er berre til stades i dei tilfella når hovudstatus er 0. Meldinga vil byggast opp forskjellig alt etter kva tenester som blir spurd på, men vil ha dette generelle elementet:
<melding tjeneste=»hentBasisdataMini»>
Her vil informasjonen som det blir spurd på bli lagt.
</melding>