Totalbestand

Bruksmønster

Tjenestene for å hente alle rettsstiftelser, og abonnere på endringene er delt inn i totalbestand og endringslogg. Totalbestand er endepunktet man bruker for å hente hele den aktive bestanden opp til og med et bestemt tidspunkt. Når man har hentet alt som var tilgjengelig fra totalbestanden skal man bruke endringslogg endepunktet for å lytte på endringer i datasettet. Av denne grunn er tjenesten avgrenset slik at man med endringsloggen kun kan hente rettsstiftelser som ble prosessert iløpet av de siste 30 dagene.

Stegvis fremgangsmåte for å hente og vedlikeholde bestanden:

1. Kall totalbestand endepunktet med “upperCutoff” med tidspunkt da hentingen ble påbegynt, paginer igjennom resultatene som vist nedenfor.
2. Når man mottar en tom page har man hele totalbestanden opp til tidspunktet, ta med tidspunktet brukt i “upperCutOff” til bruk i endringslogg.
3. Kall endringslogg med feltet “lowerCutoff” satt til dette tidspunktet, paginer igjennom på tilsvarende måte.
4. Når man når tom side har man endringsloggen frem til nå. Ta vare på feltet sistEndretSisteInnslag fra siste page.
5. Vent til man ønsker å hente endringslogg igjen, og gjenta fra steg 3.

Grensesnittbeskrivelse

Domener:

• For testmiljø (ppe) https://losoreregisteret.ppe.brreg.no/registerinfo
• For produksjon https://losoreregisteret.brreg.no/registerinfo

Henting av totalbestand

Beskrivelse

Tjenesten tar imot en forespørsel med feltene upperCutOff for tidspunkt-avgrensning og lastSortValues for paginering. Den valgfrie query parameteren “language” angir språkkode (ISO 639-2) for hvilket språk som skal benyttes for beskrivelser i responsen. Hvis den ikke er angitt benyttes norsk bokmål (NOB).

Validering

• Maskinport-tokenet som blir sendt inn er knyttet til avtalepartens organisasjonsnummer, og dette organisasjonsnummeret skal være gyldig samt ha en gyldig avtale for å kunne hente ut opplysninger i Løsøreregisteret.
• Avgrensningsverdien upperCutoff i request-body er en timestamp med tidssone på formatet “YYYY-MM-DDTHH:MM:SS.mmm+HH:MM”, det valideres at feltet ikke peker frem i tid.
• Det sjekkes at avtalepartens organisasjonsnummer er registrert og ikke slettet i Enhetsregisteret. Dersom det ikke er registrert, eller er slettet, returneres det en feilmelding.
• Hvis “language” er angitt må verdien være en støttet språkkode, hvis ikke returneres det en feilmelding med informasjon om støttede språkkoder.

Paginering

Grunnet store datamengder er det nødvendig å paginere requests og respons til tjenesten. Dette gjøres ved hjelp av feltet “lastSortValues”. Ved første forespørsel skal dette feltet være null, deretter skal det settes til verdien til feltet “sortValues” i responsen fra forrige request. Dette gjør at tjenesten er istand til å vite hvilken side av datasettet den skal returnere.

Merk: Siste side vil ha 0 rettsstiftelser, og vil ikke inneholde “sortValues”.

Request

Første request før paginering vil kunne se slik ut:

{
  "upperCutoff": "2023-03-06T00:00:00.000+02:00",
  "lastSortValues": null
}

Deretter vil man, basert på “sortValues” fra forrige response, utforme en request som dette:

{
    "upperCutoff": "2023-03-06T00:00:00.000+02:00",
    "lastSortValues": [
      "1685515741112",
      "1000009845"
    ]
}

Response

Dersom kallet lykkes får man HTTP-status 200 og data fra tjenesten på JSON-format, i form av et JSON-objekt som inneholder opplysninger om rettsstiftelsene.

Eksempelrespons

{
  "upperCutoffForrigeRequest": "2023-03-06T00:00:00.000+02:00",
  "sortValues": [
    "1685515741112",
    "1000009845"
  ],
  "antallRettsstiftelser": 1,
  "rettsstiftelse": [
    {
      "dokumentnummer": "1000009845",
      "type": "rettsstiftelsestype.sap",
      "typeBeskrivelse": "Salgspant",
      "status": "statusregistreringsobjekt.tl",
      "statusBeskrivelse": "tinglyst",
      "innkomsttidspunkt": "2022-11-11T08:00:00+01:00",
      "utlopRettsvernstid": "2042-11-11",
      "paategning": [],
      "rolle": [
        {
          "rolletype": "rolletype.panthaver",
          "rolletypeBeskrivelse": "Panthaver",
          "rollegruppetype": "rollegruppe.rett",
          "rollegruppetypeBeskrivelse": "Rettighetshaver",
          "rolleinnehaver": {
            "aktorType": "aktortype.virksomhet",
            "organisasjonsnummer": "810844612"
          }
        },
        {
          "rolletype": "rolletype.pantsetter",
          "rolletypeBeskrivelse": "Pantsetter",
          "rollegruppetype": "rollegruppe.forp",
          "rollegruppetypeBeskrivelse": "Forpliktet",
          "rolleinnehaver": {
            "aktorType": "aktortype.virksomhet",
            "organisasjonsnummer": "810845422"
          }
        },
        {
          "rolletype": "rolletype.pantsetter",
          "rolletypeBeskrivelse": "Pantsetter",
          "rollegruppetype": "rollegruppe.forp",
          "rollegruppetypeBeskrivelse": "Forpliktet",
          "rolleinnehaver": {
            "aktorType": "aktortype.person",
            "personnavn": {
              "fornavn": "PLUTSELIG",
              "etternavn": "MORMOR"
            },
            "fodselsnummerEllerDNummer": "13888998238"
          }
        }
      ],
      "formuesgode": [
        {
          "identifiseringsmate": "identifiseringsmate.entydig",
          "type": "formuesgodetype.mv.e",
          "typeBeskrivelse": "Registrert motorvogn",
          "eierandel": {},
          "registreringsnummerMotorvogn": "CU11242",
          "historiskRegistreringsnummerMotorvogn": []
        }
      ],
      "prioritetsvikelse": [],
      "krav": {
        "belop": [
          {
            "belop": 105158028,
            "valuta": "NOK"
          }
        ],
        "kravSalgspant": "kravsalgspant.selgers.krav",
        "kravSalgspantBeskrivelse": "selgerens krav på kjøpesummen"
      }
    }
  ]
}

Feilmeldinger

Dersom man ikke får HTTP-status 200, så får man en melding fra tjenesten i JSON-format.

Eksempelrespons feilmelding

{
  "korrelasjonsid": "cba2c68f-2f04-4104-9dbf-8e69c5e36c5c",
  "tidspunkt": "2023-04-17T09:16:08.815966+02:00",
  "feilmelding": "Totalbestand kan ikke hentes med upperCutoff frem i tid."
}