Bolig API V1

Funksjoner modellen skal kunne understøtte.

Hente informasjon om bolig fra Kobo
Opprette ny bolig i Kobo
Endre data på eksisterende bolig i Kobo
Behandle boligreservasjon
Behandle tildeling
Behandle leieforhold
Soft delete av bolig
Registrere Webhook API key

De ulike funksjonelle scenariene er underlagt ulike krav til informasjon i meldingen, og forutsetninger for hvordan boligens status er i Kobo.

Kobobolig

Feltnavn	Datatype	Obligatorisk	Kan oppdateres	Merknader
adresse	objekt	ja	nei	Se AdresseTO.
antallSoverom	int	nei	ja	Antall soverom i boligen, ikke tilgjengelig i Matrikkelen.
boligtype	enum	ja	ja	Se Boligtype enum.
bruksareal	double	nei	ja	Samme felt som i matrikkelen.
bruksenhetsnummer	string	nei	nei	Må være på rett format.
bygning	objekt	nei	nei	Se BygningTO.
disposisjonsform	enum	nei	ja	Se Disposisjonsform enum.
eieform	enum	nei	ja	Se Eieform enum.
eiendom	objekt	nei	ja	Se EiendomTO.
eieseksjon	objekt	nei	ja	Se EieseksjonTO.
eier	objekt	nei	nei	Se EierTO.
egenskaper	enum[]	nei	ja	Se Boligegenskap enum.
ekstraReferanse	string	nei	nei	Brukes for å skille mellom flere boenheter i samme matrikkel bruksenhet, feks i et bofellesskap.
erBofellesskap	boolean	nei	ja	Brukes feks sammen med `erBofellesskap` ved flere boenheter i en bruksenhet
erTilgjengeligForRullestolbruker	boolean	nei	nei*	*Hvis denne settes til `true` vil Kobo automatisk legge til markere for utvalgte tilrettelegginger i boligen, `false` vil fjerne de
etasjenummer	int	nei	ja	Etasjen inngangen ligger i.
leverandorBoligId	string	ja*	nei	*Obligatorisk ved opprettelse (HTTP POST `/kobobolig`) og ved endring (HTTP PUT/DELETE `/kobobolig/{koboboligId}`)
husstand	objekt	nei	nei	Se HusstandTO.
koboId	uuid	ja*	nei	*Kobos unike id til boenheten. Vil alltid være i meldingen ved utlesning (HTTP GET `/kobobolig/{koboboligId}`) og respons av registrert bolig fra Kobo
kvalifisererMvaKompensasjon	boolean	nei	ja	Hvis denne settes til `true` er det en indikator som forteller om leieobjektet kvalifiserer for kompensasjon av merverdiavgift
leieforhold	objekt	nei	ja	Les hvordan å behandle et leieforhold. Se LeieforholdTO
leiekostnad	objekt	nei	ja	Se LeiekostnadTO.
leieTilEiePotensial	boolean	nei	ja	Hvis denne settes til `true` så er boenheten markert for leie til eie, så vises merkelappen "Leie til eie" i boligdetaljer i Kobo fagsystemet
malernummerStrom	string	nei	ja	Målernummer er de siste 8 sifrene av Målepunkt-ID. Målepunkt-ID: entydig identifikasjon av et målepunkt basert på GS1-standarden Global Service Relation Number (GSRN).
malernummerVann	string	nei	ja	Målernummer vann er serienummeret som står på boligenhetens vannmåler.
matrikkelId	uuid	nei	nei	Id objektet har i Matrikkelen. Kan endre seg hvis Kobo får ny versjon av objektet fra Matrikkelen.
meta	objekt	nei	nei	Read-only felt, alltid med ved utlesning eller respons fra Kobo. Se KoboMetaTO.
matrikkelBruksenhetstype	enum	nei	nei	Se Matrikkel bruksenhetstype enum.
egenvurdertRisikogruppe	enum	nei	ja	Se Risikogruppe enum, definisjon iht NOU 2012:4.
ovrigInformasjon	string	nei	ja	Fritekstfelt på inntil 1000 tegn
reservasjoner	objekt[]	nei	ja*	Les hvordan å behandle en boligreservasjon. Se BoligreservasjonTO
sikkerhet	enum[]	nei	ja	Se Boligsikkerhet enum.
solgtDato	date	nei	ja	Dato for når boligen ble solgt.
solgtTilLeietaker	boolean	nei	ja	Hvis denne settes til true betyr det at boligen ble solgt til Leietaker.
status	enum	ja	ja	Se Boligstatus enum.
statusdato	date	nei	ja	Utfyllende informasjon om boenhetens `status`
tidligereLeieforhold	objekt[]	nei	nei	Read-only felt. Se LeieforholdTO.
tildeling	objekt	nei	ja	Les hvordan å behandle en tildeling. Se BoligtildelingTO
tilfortHusbankenMidler	boolean	nei	ja	`true` angir at Husbanken har gitt lån og/eller tilskudd til oppføring, ombygging eller kjøp av boligen.
tilrettelegginger	enum[]	nei	ja	Se Boligtilrettelegging.
underkategoriBoligtype	string	nei	ja	Boligens boligtype, mer utdypende enn boligtype
uteplass	enum[]	nei	ja	Se Uteplass enum.
utledetLedigFraDato	date	nei	nei	Read-only felt, utledes av Kobo. Styres via feltene `status` og `statusdato`, samt `leieforhold`

Hente bolig

En bolig kan kun leses ut fra Kobo ved å bruke Kobos unike nøkkel for boligen (uuid koboBoligId). Dette skjer typisk etter at FDVU systemet har mottatten webhook melding fra Kobo med referanse til boligen, og et hint om hva som har skjedd i Kobo med boligen.

OpenAPI utdrag

    /kobobolig/{koboBoligId}:
        get:
            tags:
                - fdvu
            summary: Henter en bolig fra Kobo
            operationId: hentBolig
            parameters:
                -   in: path
                    name: koboBoligId
                    required: true
                    schema:
                        type: string
                        format: uuid
                -    in: header
                     name: 'x-kobo-systemid'
                     description: FVDU leverandørens valgte systemId. Velges ved oppsett og aktivering av FDVU leverandøren i Kobo.
                     required: true
                     schema:
                        type: string
            responses:
                "200":
                    $ref: "#/components/responses/Bolig20xResponse"
                "401":
                    $ref: "#/components/responses/Bolig401Response"
                "404":
                    $ref: "#/components/responses/Bolig404Response"
                "502":
                    $ref: "#/components/responses/Bolig502Response"
                "503":
                    $ref: "#/components/responses/Bolig503Response"

Opprette bolig

Generelt sett kan man sende inn hele Kobo boligstrukturen ved opprettelse av bolig i Kobo.

Det er ikke påkrevet å oppgi id felter som eies av Kobo ved opprettelse (ny bolig som Kobo ikke kjenner til fra før).

OpenAPI utdrag

    /kobobolig:
        parameters:
            - in: header
              name: 'x-kobo-systemid'
              description: FVDU leverandørens valgte systemId. Velges ved oppsett og aktivering av FDVU leverandøren i Kobo.
              required: true
              schema:
                  type: string
        post:
            tags:
                - fdvu
            summary: Oppretter en bolig i Kobo
            operationId: opprettBolig
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            $ref: "#/components/schemas/KoboboligTilKoboTO"
            responses:
                "200":
                    $ref: "#/components/responses/Bolig20xResponse"
                "201":
                    $ref: "#/components/responses/Bolig20xResponse"
                "404":
                    $ref: "#/components/responses/Bolig404Response"
                "502":
                    $ref: "#/components/responses/Bolig502Response"
                "503":
                    $ref: "#/components/responses/Bolig503Response"

Endre bolig

Når man skal endre data på en bolig som allerede finnes i Kobo, må Kobos unike nøkkel for boligen angis ( uuid koboBoligId).

OpenAPI utdrag

    /kobobolig/{koboBoligId}:
        parameters:
            - in: path
              name: koboBoligId
              description: Kobos Id for boligen. Mottas ved retur når FDVU leverandøren oppretter sin bolig i Kobo.
              required: true
              schema:
                  type: string
                  format: uuid
            - in: header
              name: 'x-kobo-systemid'
              description: FVDU leverandørens valgte systemId. Velges ved oppsett og aktivering av FDVU leverandøren i Kobo.
              required: true
              schema:
                  type: string
        put:
            tags:
                - fdvu
            summary: Oppdaterer en bolig i Kobo
            operationId: oppdaterBolig
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            $ref: "#/components/schemas/KoboboligTilKoboTO"
            responses:
                "200":
                    $ref: "#/components/responses/Bolig20xResponse"
                "401":
                    $ref: "#/components/responses/Bolig401Response"
                "404":
                    $ref: "#/components/responses/Bolig404Response"
                "502":
                    $ref: "#/components/responses/Bolig502Response"
                "503":
                    $ref: "#/components/responses/Bolig503Response"

Behandle boligreservasjon

I Kobo er det mulig å reservere én eller flere boliger til en sak. En bolig kan også være reservert til flere saker samtidig. Det er støtte for både å opprette og avslutte en boligreservasjon etter behov.

Dette er ikke et obligatorisk steg i Kobo: Du kan velge å tildele en sak direkte til en bolig uten å opprette en reservasjon først.

Opprette boligreservasjon

OpenAPI utdrag

    /kobobolig/{koboBoligId}/sak/{saksreferanse}/reservasjon:
    parameters:
      - $ref: "#/components/parameters/koboBoligIdParam"
      - $ref: "#/components/parameters/leverandorSystemIdParam"
      - $ref: "#/components/parameters/saksreferanseParam"
    put:
      tags:
        - bolig
      summary: Reserverer bolig til en sak med dagens dato som reservert dato
      operationId: reserverBolig
      responses:
        "200":
          $ref: "#/components/responses/Bolig20xResponse"
        "201":
          $ref: "#/components/responses/Bolig20xResponse"
        "404":
          $ref: "#/components/responses/Bolig404Response"
        "502":
          $ref: "#/components/responses/Bolig502Response"
        "503":
          $ref: "#/components/responses/Bolig503Response"

For å opprette en boligreservasjon må man ha en sak i Kobo å koble opp til, som blir da saksreferansen.

Avslutte boligreservasjon

OpenAPI utdrag

    /kobobolig/{koboBoligId}/sak/{saksreferanse}/reservasjon:
    parameters:
      - $ref: "#/components/parameters/koboBoligIdParam"
      - $ref: "#/components/parameters/leverandorSystemIdParam"
      - $ref: "#/components/parameters/saksreferanseParam"
    delete:
      tags:
        - bolig
      summary: Fjerne reservasjon av bolig til en sak
      operationId: fjernReservasjon
      responses:
        "200":
          $ref: "#/components/responses/Bolig20xResponse"
        "201":
          $ref: "#/components/responses/Bolig20xResponse"
        "404":
          $ref: "#/components/responses/Bolig404Response"
        "502":
          $ref: "#/components/responses/Bolig502Response"
        "503":
          $ref: "#/components/responses/Bolig503Response"

For å fjerne en boligreservasjon sender man med hvilken saksreferanse det gjelder, og da blir den saken fjernet fra reservasjonene.

Behandle tildeling

En tildeling knytter én sak til én bolig. Dette betyr at det er et én-til-én-forhold mellom saken og boligen, og at denne boligen er den som faktisk er aktuell for husstanden som er registrert på saken.

I Kobo er dette et obligatorisk steg før du kan opprette et leieforhold. For BoligAPI er det derimot ikke et krav å bruke tildeling.

Tildele en bolig i Kobo

OpenAPI utdrag

/kobobolig/{koboBoligId}/tildeling:
        parameters:
            - $ref: "#/components/parameters/koboBoligIdParam"
            - $ref: "#/components/parameters/leverandorSystemIdParam"
        post:
            tags:
                - bolig
            summary: Tildele en bolig i Kobo
            operationId: tildelBolig
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            $ref: "#/components/schemas/BoligtildelingTO"
            responses:
                "200":
                    $ref: "#/components/responses/Bolig20xResponse"
                "201":
                    $ref: "#/components/responses/Bolig20xResponse"
                "404":
                    $ref: "#/components/responses/Bolig404Response"
                "502":
                    $ref: "#/components/responses/Bolig502Response"
                "503":
                    $ref: "#/components/responses/Bolig503Response"

Fjerne tildeling fra en bolig i Kobo

OpenAPI utdrag

/kobobolig/{koboBoligId}/tildeling:
        parameters:
            - $ref: "#/components/parameters/koboBoligIdParam"
            - $ref: "#/components/parameters/leverandorSystemIdParam"
        delete:
            tags:
                - bolig
            summary: Fjerner tildeling fra en bolig i Kobo
            operationId: fjernTildeling
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            $ref: "#/components/schemas/BoligtildelingTO"
            responses:
                "200":
                    $ref: "#/components/responses/Bolig20xResponse"
                "201":
                    $ref: "#/components/responses/Bolig20xResponse"
                "404":
                    $ref: "#/components/responses/Bolig404Response"
                "502":
                    $ref: "#/components/responses/Bolig502Response"
                "503":
                    $ref: "#/components/responses/Bolig503Response"

Behandle leieforhold

Det er mulig å opprette, endre og avslutte et leieforhold. Man kan også registere, endre og oppheve en oppsigelse ved et leieforhold. Se leieforhold flyt.

Leieforhold flyt

Flyten for leieforhold i Kobo er som følger

Opprette leieforhold i Kobo

OpenAPI utdrag

    /kobobolig/{koboBoligId}/leieforhold:
    parameters:
        - $ref: "#/components/parameters/koboBoligIdParam"
        - $ref: "#/components/parameters/leverandorSystemIdParam"
    post:
        tags:
            - bolig
        summary: Oppretter et leieforhold i Kobo
        operationId: opprettLeieforhold
        requestBody:
            required: true
            content:
                application/json:
                    schema:
                        $ref: "#/components/schemas/OpprettLeieforholdTO"
        responses:
            "200":
                $ref: "#/components/responses/Bolig20xResponse"
            "201":
                $ref: "#/components/responses/Bolig20xResponse"
            "404":
                $ref: "#/components/responses/Bolig404Response"
            "502":
                $ref: "#/components/responses/Bolig502Response"
            "503":
                $ref: "#/components/responses/Bolig503Response"

Ved opprettelse av leieforhold, må man ha en sak i Kobo å koble opp til. Se Knytte bolig til sak.

Når man oppretter et leieforhold sender man med en OpprettLeieforholdTO:

OpprettLeieforholdTO

Feltnavn	Datatype	Obligatorisk	Merknader
leieforhold	objekt	ja	Se LeieforholdOpprettOppdaterTO.
husstand	objekt	ja*	Husstanden man evt ønsker å opprette en sak på HusstandTO, se Knytte bolig til sak.
koboSaksreferanse	string	ja*	Saken i Kobo leieforholdet gjelder. Se Knytte bolig til sak

LeieforholdOpprettOppdaterTO

Feltnavn	Datatype	Obligatorisk	Merknader
kontraktStartdato	string	ja	Angir hvilken dato kontrakten skal starte.
kontraktUtlopsdato	string	ja*	Angir hvilken dato kontrakten skal utløpe. *Obligatorisk hvis `erTidsubegrenset` er satt til `false`.
erTidsubegrenset	boolean	ja	Angir om leieforholdet er tidsubegrenset.
manedsleie	double	nei*	*Ikke støttet ennå, skal bli et obligatorisk felt.
depositum	double	nei*	*Ikke støttet ennå, skal bli et obligatorisk felt.

For å opprette et leieforhold må disse feltene være oppgitt:

kontraktStartdato.
erTidsubegrenset.
kontraktUtlopsdato, hvis erTidsubegrenset er satt til false

Hva skjer når et leieforhold opprettes?

Hvis det er flere boligreservasjoner for andre saker på boligen så fjernes de av Kobo.
Hvis saken som skal knyttes til leieforholdet allerede har reserverte boliger, må disse reservasjonene fjernes før leieforholdet kan opprettes på saken. Alternativt må en ny sak opprettes.
Etter opprettelse er det mulig å oppdatere feltene på LeieforholdOpprettOppdaterTO.

Oppdatere eksisterende leieforhold i Kobo

OpenAPI utdrag

    /kobobolig/{koboBoligId}/leieforhold:
        parameters:
            - $ref: "#/components/parameters/koboBoligIdParam"
            - $ref: "#/components/parameters/leverandorSystemIdParam"
        put:
            tags:
                - bolig
            summary: Oppdaterer et leieforhold i Kobo
            operationId: oppdaterEksisterendeLeieforhold
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            $ref: "#/components/schemas/LeieforholdOpprettOppdaterTO"
            responses:
                "200":
                    $ref: "#/components/responses/Bolig20xResponse"
                "201":
                    $ref: "#/components/responses/Bolig20xResponse"
                "404":
                    $ref: "#/components/responses/Bolig404Response"
                "502":
                    $ref: "#/components/responses/Bolig502Response"
                "503":
                    $ref: "#/components/responses/Bolig503Response"

Ved oppdatering av eksisterende leieforhold, må det finnes et eksisterende leieforhold på boligien man prøver å oppdatere leieforholdet på. Sender med et LeieforholdOpprettOppdaterTO objekt.

Registrere oppsigelse av leieforhold

OpenAPI utdrag

    /kobobolig/{koboBoligId}/leieforhold/oppsigelse:
        parameters:
            - $ref: "#/components/parameters/koboBoligIdParam"
            - $ref: "#/components/parameters/leverandorSystemIdParam"
        post:
            tags:
                - bolig
            summary: Registrerer en oppsigelse for et leieforhold i Kobo
            operationId: registrerOppsigelseLeieforhold
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            $ref: "#/components/schemas/LeieforholdOppsigelseTO"
            responses:
                "200":
                    $ref: "#/components/responses/Bolig20xResponse"
                "201":
                    $ref: "#/components/responses/Bolig20xResponse"
                "404":
                    $ref: "#/components/responses/Bolig404Response"
                "502":
                    $ref: "#/components/responses/Bolig502Response"
                "503":
                    $ref: "#/components/responses/Bolig503Response"

Ved registrering av en oppsigelse, må det finnes et eksisterende leieforhold på boligien man prøver å registrere en oppsigelse på. Når man registrerer en oppsigelse sender man med LeieforholdOppsigelseTO:

LeieforholdOppsigelseTO

Feltnavn	Datatype	Obligatorisk	Merknader
oppsagtAktor	enum	ja	Hvem som sa opp leieforholdet.
oppsigelsestid	enum	ja
oppsigelseMottattDato	date	ja	Dato oppsigelsen ble mottatt
annenOppsigelsestid	string	ja*
oppsagtFraDato	date	ja	Dato oppsigelsen gjelder fra
planlagtUtflyttingsdato	date	ja	Dato beboer planlegger å flytte ut

Følgende felter må være utfylt:

oppsagtAktor, se Boligoppsigelse aktør enum.
oppsigelsestid, se Oppsigelsestid.
annenOppsigelsestid, hvis oppsigelsestid (se Oppsigelsestid) er satt til ANNET.
oppsagtFraDato.
oppsigelseMottattDato.
planlagtUtflyttingsdato.

Endre en eksisterende oppsigelse for et leieforhold

OpenAPI utdrag

    /kobobolig/{koboBoligId}/leieforhold/oppsigelse:
        parameters:
            - $ref: "#/components/parameters/koboBoligIdParam"
            - $ref: "#/components/parameters/leverandorSystemIdParam"
        put:
            tags:
                - bolig
            summary: Endre en eksisterende oppsigelse for et leieforhold i Kobo
            operationId: endreOppsigelseLeieforhold
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            $ref: "#/components/schemas/LeieforholdOppsigelseTO"
            responses:
                "200":
                    $ref: "#/components/responses/Bolig20xResponse"
                "201":
                    $ref: "#/components/responses/Bolig20xResponse"
                "404":
                    $ref: "#/components/responses/Bolig404Response"
                "502":
                    $ref: "#/components/responses/Bolig502Response"
                "503":
                    $ref: "#/components/responses/Bolig503Response"

For å endre en oppsigelse, må det finnes et eksisterende leieforhold der oppsigelsen allerede er registrert på boligen det gjelder. Ved endring av en oppsigelse, skal LeieforholdOppsigelseTO sendes med.

Opphev en eksisterende oppsigelse for et leieforhold

OpenAPI utdrag

    /kobobolig/{koboBoligId}/leieforhold/oppsigelse:
        parameters:
            - $ref: "#/components/parameters/koboBoligIdParam"
            - $ref: "#/components/parameters/leverandorSystemIdParam"
        delete:
            tags:
                - bolig
            summary: Opphev en eksisterende oppsigelse for et leieforhold i Kobo
            operationId: opphevOppsigelseLeieforhold
            responses:
                "200":
                    $ref: "#/components/responses/Bolig20xResponse"
                "201":
                    $ref: "#/components/responses/Bolig20xResponse"
                "404":
                    $ref: "#/components/responses/Bolig404Response"
                "502":
                    $ref: "#/components/responses/Bolig502Response"
                "503":
                    $ref: "#/components/responses/Bolig503Response"

For å oppheve en oppsigelse, må det finnes et eksisterende leieforhold der oppsigelsen allerede er registrert på boligen det gjelder. Når en oppsigelse blir opphevet, vil alle feltene knyttet til oppsigelsen i leieforholdet bli satt til null, og oppsigelsen vil ikke lenger være registrert i systemet.

Avslutte leieforhold i Kobo

OpenAPI utdrag

    /kobobolig/{koboBoligId}/leieforhold:
        parameters:
            - $ref: "#/components/parameters/koboBoligIdParam"
            - $ref: "#/components/parameters/leverandorSystemIdParam"
        delete:
            tags:
                - bolig
            summary: Avslutter et leieforhold i Kobo
            operationId: avsluttLeieforhold
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            $ref: "#/components/schemas/LeieforholdAvsluttTO"
            responses:
                "200":
                    $ref: "#/components/responses/Bolig20xResponse"
                "201":
                    $ref: "#/components/responses/Bolig20xResponse"
                "404":
                    $ref: "#/components/responses/Bolig404Response"
                "502":
                    $ref: "#/components/responses/Bolig502Response"
                "503":
                    $ref: "#/components/responses/Bolig503Response"

For å avslutte et leieforhold, må det finnes et eksisterende leieforhold på boligen det gjelder. Ved avslutning av leieforhold, skal LeieforholdAvsluttTO sendes med:

LeieforholdAvsluttTO

Feltnavn	Datatype	Obligatorisk	Merknader
utflyttetdato	date	ja	Dato når beboer flyttet ut
boligstatus	enum	ja	Status boligen skal få
avslutningsgrunn	enum	ja	Grunn for hvorfor leieforholdet avsluttes

Følgende felter må være utfylt:

utflyttetdato.
boligstatus, se Boligstatus enum. Kan kun sette status som KLAR_FOR_INNFLYTTING eller VEDLIKEHOLD
avslutningsgrunn, se Leieforhold avslutningsgrunn enum.

Det er ikke mulig å omgjøre en avslutning av leieforholdet eller endre det. Leieforholdet er nå tilgjengelig i tidligereLeieforhold på KoboBoligTO.

Knytte bolig til sak

En bolig kan være knyttet til en sak ved at boligen har en reservasjon, har en tildeling eller har et leieforhold hvor saksreferansen er oppgitt.

Med saksreferanse - har sak

Hvis man oppgir en saksreferanse må denne saken finnes i Kobo.

Uten saksreferanse - trenger ny sak

Både reservasjon og tildeling må alltid ha en gyldig saksreferanse. For leieforhold er det litt annerledes: her er det den eneste operasjonen hvor saksreferanse egentlig er påkrevd, men det er også mulig å sende inn en null saksreferanse dersom boligen ikke allerede er koblet til en sak.

For å opprette et leieforhold må det kunne kobles til en sak i Kobo. Hvis det ikke finnes en sak fra før, kan du sende inn forespørselen uten saksreferanse. I slike tilfeller må du inkludere en gyldig husstand i forespørselen — se HusstandTO for detaljer.

Når du sender inn en forespørsel uten saksreferanse, vil Kobo anta at du ønsker å opprette en ny sak for personene i husstand.beboere. Den første beboeren i listen blir da registrert som hovedsøker. Hvis opprettelsen av personene i husstanden lykkes, vil Kobo opprette en ny sak og returnere den nye saksreferansen i responsen.

Soft delete av bolig

Når man skal gjøre en soft delete på en bolig som allerede finnes i Kobo, må Kobos unike nøkkel for boligen angis ( uuid koboBoligId).

OpenAPI utdrag

    /kobobolig/{koboBoligId}:
        parameters:
            - in: path
              name: koboBoligId
              description: Kobos Id for boligen. Mottas ved retur når FDVU leverandøren oppretter sin bolig i Kobo.
              required: true
              schema:
                  type: string
                  format: uuid
            - in: header
              name: 'x-kobo-systemid'
              description: FVDU leverandørens valgte systemId. Velges ved oppsett og aktivering av FDVU leverandøren i Kobo.
              required: true
              schema:
                  type: string
        delete:
            tags:
                - bolig
            summary: Soft delete av bolig i Kobo
            operationId: slettBolig
            responses:
                204:
                    headers:
                        x-kobo-behandlet:
                            schema:
                                type: boolean
                                description: true hvis boligen ble slettet
                    description: Bolig ble slettet
                401:
                    $ref: "#/components/responses/Bolig401Response"
                404:
                    $ref: "#/components/responses/Bolig404Response"

Registrere Webhook API key

FDVU-systemet må sende en "hemmelighet" til Kobo som Kobo senere kan benytte når Kobo sender meldinger til FDVU-systemet.

På denne måten kan FDVU-systemet verifisere at det er Kobo som er avsender av meldingene til FDVU-systemet. Denne type sikkerhet benyttes da det er forventet at FDVU systemets webhook API endepunkt står åpent tilgjengelig på internett.

Det er dermed FDVU systemets ansvar å sjekke at innkommende webhookmeldinger har riktig API key.

Se også siden Sikkerhet under Kobo FDVU Webhook API.

OpenAPI utdrag

    /fdvusystem/:
        post:
            tags:
                - bolig
            summary: Registrerer api-nøkkelen til FDVU systemet
            operationId: registrerApiKey
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            $ref: "#/components/schemas/WebhookRegistreringRequestTO"
            responses:
                "204":
                    description: Melding er mottatt Ok. API hemmelighet er oppdatert.
                "400":
                    description: Bad request - Krav til utfylling av felter er ikke overholdt.
                "401":
                    description: Unauthorized - Maskinporten token er ikke godkjent.
                "404":
                    description: Not Found - Oppsett for FDVU System mangler i Kobo.

Klassediagram

Se respektive detaljer for objekter i Felter i klassediagrammet under, eller i KoboboligTO.

Objekter

Adresse

Feltnavn	Datatype	Obligatorisk	Kan oppdateres
gatenavn	string	ja	nei
husnummer	int	ja	nei
husbokstav	string	nei	nei
postnummer	string	ja	nei
poststed	string	nei	nei

Beboer

Read-only objekt som ligger på objektet HusstandTO hvis boligen er knyttet til en sak i Kobo.

Feltnavn	Datatype	Obligatorisk	Kan oppdateres	Merknader
koboId	uuid	ja	nei
adresse	uuid	ja	nei	Se AdresseTO.
personidentifikator	string	ja	nei	Er på formatet til et fødselsnummer eller dnummer.
fodselsdato	date	nei	nei
fornavn	string	nei	nei
mellomnavn	string	nei	nei
etternavn	string	nei	nei
epost	string	nei	nei
telefonnummer	string	nei	nei
reservertMotDigitalKommunikasjon	boolean	nei	nei

Bygning

Feltnavn	Datatype	Obligatorisk	Kan oppdateres	Merknader
koboId	uuid	ja	nei	Ved utlesning og respons fra Kobo
leverandorBygningId	string	ja	nei	Ved opprettelse fra FDVU systemet
bygningsnummer	long	ja	nei	Definisjonen er hentet fra Statens Kartverk ved Geonorge.
lopenummer	int	ja	nei
eiendom	objekt	ja	nei	Se EiendomTO.
matrikkelenhetId	long	ja	nei*	*Id objektet har i Matrikkelen. Kan endre seg hvis Kobo får ny versjon av objektet fra Matrikkelen.

Eiendom

Arves fra Matrikkelenhet og inneholder alle felter (se MatrikkelenhetTO). I tillegg har Eiendom disse feltene:

Feltnavn	Datatype	Obligatorisk	Kan oppdateres	Merknader
leverandorEiendomId	string	ja	nei	Ved opprettelse fra FDVU systemet

Eieseksjon

Arves fra Matrikkelenhet og inneholder alle felter (se MatrikkelenhetTO). I tillegg har Eiesekjson disse feltene:

Feltnavn	Datatype	Obligatorisk	Kan oppdateres	Merknader
leverandorEieseksjonId	string	ja	nei	Ved opprettelse fra FDVU systemet

Eier

Feltnavn	Datatype	Obligatorisk	Kan oppdateres	Merknader
boligeiersNavn	string	ja	nei
boligeiersOrganisasjonsnummer	string	ja*	nei	Format resistriksjoner (9 siffer)
boligeiersMobilnummer	string	ja*	nei	Format restriksjoner (kun siffer, parantes, + tegn og mellomrom)

*En av organisasjonsnummer eller mobilnummer må være fylt ut.

Husstand

Read-only objekt som sendes fra Kobo hvis boligen er knyttet til en sak. Feks via en boligreservasjon eller et leieforhold.

Feltnavn	Datatype	Obligatorisk	Kan oppdateres	Merknader
antallBarn	int	ja	nei	Antallet barn som er registrert i saken knyttet til boligen
beboere	objekt[]	ja	nei	Se BeboerTO

Boligreservasjon

Feltnavn	Datatype	Obligatorisk	Kan oppdateres	Merknader
reservertDato	date	nei*	ja	Datoen boligen ble reservert. Brukes kun til visning for informasjon til saksbehandler i Kobo.
koboSaksreferanse	string	ja	nei	Saken boligreservasjonen skal knyttes til.

Boligtildeling

Feltnavn	Datatype	Obligatorisk	Kan oppdateres	Merknader
tildeltDato	date	nei	nei	Tidspunktet tildelingen ble opprettet i Kobo, blir satt av Kobo ved opprettelse av tildelingen
koboSaksreferanse	string	ja	nei	Saken boligreservasjonen skal knyttes til

Leieforhold

Feltnavn	Datatype	Kan oppdateres	Merknader
koboId	uuid	nei	Er alltid med ved utlesning fra Kobo. Må ikke sendes inn.
depositum	double	nei*	*Ikke støttet ennå, skal bli et obligatorisk felt.
koboSaksreferanse	string	ja	Saken i Kobo leieforholdet gjelder, kan bare settes ved oppretting av leieforhold. Se Knytte bolig til sak.
erTidsubegrenset	boolean	ja	Angir om leieforholdet er tidsubegrenset.
kontraktStartdato	date	ja	Angir hvilken dato kontrakten skal starte.
kontraktUtlopsdato	date	ja	Angir hvilken dato kontrakten skal utløpe.
månedsleie	double	nei*	*Ikke støttet ennå, skal bli et obligatorisk felt.
meta	date	nei	Read-only felt, alltid med ved utlesning eller respons fra Kobo. Se KoboMetaTO.
oppsagtAktor	enum	ja	Hvem som sa opp leieforholdet.
oppsigelsestid	enum	ja
oppsigelseMottattDato	date	ja	Dato oppsigelsen ble mottat.
annenOppsigelsestid	string	ja
oppsagtFraDato	date	ja	Dato oppsigelsen gjelder fra.
planlagtUtflyttingsdato	date	ja	Dato beboer planlegger å flytte ut.
utflyttetdato	date	ja	Dato når beboer flyttet ut.
avsluttetdato	date	nei	Når leieforholdet avsluttes, settes av Kobo.
leieforholdAvslutningsgrunn	enum	ja	Grunn for hvorfor leieforholdet avsluttes.

Leiekostnad

Feltnavn	Datatype	Obligatorisk	Kan oppdateres	Merknader
depositum	double	nei	nei	Et pengebeløp som leier setter inn på en bankkonto som er adskilt fra leiers og utleiers midler for å sikre utleier mot økonomisk tap i leieforholdet
månedsleie	double	ja	nei	Månedlig husleie oppgitt i kroner

Matrikkelenhet

Feltnavn	Datatype	Obligatorisk	Kan oppdateres	Merknader
koboId	uuid	ja	nei	Ved utlesning og respons fra Kobo
kommunenummer	string	ja	nei	Definisjonen er hentet fra statistisk sentralbyrås metadataregister
gaardsnummer	int	ja	nei	Definisjonen er knyttet opp mot definisjon av matrikkelnummer og hentet fra Statens Kartverk ved Geonorge
bruksnummer	int	ja	nei	Definisjonen er knyttet opp mot definisjon av matrikkelnummer og hentet fra Statens Kartverk ved Geonorge
festenummer	int	nei	nei	Definisjonen er knyttet opp mot definisjon av matrikkelnummer og hentet fra Statens Kartverk ved Geonorge
seksjonsnummer	int	nei	nei	Definisjonen er knyttet opp mot definisjon av matrikkelnummer og hentet fra Statens Kartverk ved Geonorge
matrikkelenhetId	long	ja	nei*	*Id objektet har i Matrikkelen. Kan endre seg hvis Kobo får ny versjon av objektet fra Matrikkelen.

Feltnavn	Datatype	Obligatorisk	Kan oppdateres	Merknader
opprettet	date	ja	nei
sistEndret	date	ja	nei

Enums

Boligegenskap enum

Andre egenskaper ved boligenheten

Enum verdi	Beskrivelse
BOD_INKLUDERT
OPPLEGG_FOR_TV
OPPLEGG_FOR_INTERNETT
VELFERDSTEKNOLOGI
UTENDORS_STROMUTTAK
HUSDYR_IKKE_TILLATT
INTEGRERTE_HVITEVARER

Boligstatus enum

Boligobjektets tilgjengelighet status

Enum verdi	Beskrivelse
KLAR_FOR_INNFLYTTING	En bolig som er uten mangler og klar for leietaker
VEDLIKEHOLD	En bolig under kortvarig vedlikehold
UTLEID	En bolig utleid i en utleiesak, eller utleid utenfor Kobo
IKKE_TILGJENGELIG	En bolig som er utilgjengelig for lengre tid, feks omfattende vedlikehold

Boligtype enum

Enum verdi	Beskrivelse
ORDINAR_BOLIG	Bolig der det i utgangspunktet ikke er tatt særskilt hensyn til brukergrupper med spesielle behov. En ordinær bolig kan likevel være av livsløpsstandard eller universelt utformet
OMSORGSBOLIG	En omsorgsbolig er en bolig som er tilpasset orientering- og bevegelseshemmede og fysisk tilrettelagt slik at beboerne etter behov skal kunne motta heldøgns pleie og omsorg. En omsorgsbolig er beboerens eget hjem
TJENESTEBOLIG	Bolig som primært leies ut til ansatte i kommune/stat/fylkeskommune
ANNET_UTLEIEOBJEKT

Boligsikkerhet enum

Sikkerhetstiltak knyttet til brann og innbruddsalarm

Enum verdi	Beskrivelse
SPRINKLERANLEGG
VANNTAAKEANLEGG
DIREKTEKOBLING_TIL_BRANNVESEN
KOMFYRVAKT
INNBRUDDSALARM

Boligtilrettelegging enum

Typer tilrettelegginger som en bolig kan ha eller som en søker kan ha behov for.

Enum verdi	Beskrivelse
LAVE_DORTERSKLER
TRAPPEFRI_INNGANG
HANDTAK_PA_BAD
BREDE_DORER
ALT_PA_ETT_PLAN
RAMPE
HEV_OG_SENKINNREDNING
FORSTERKET_BOLIG
IKKE_DUSJKABINETT
HEIS_I_BYGNINGEN
ANNEN_TILRETTELEGGING

Boligoppsigelse aktør enum

Enum verdi	Beskrivelse
LEIETAKER
UTLEIER

Disposisjonsform enum

I tillegg til disposisjonsformene i tabellen under har Kobo også tildelingsavtale og tilvisningsavtale. Disse er ikke tilgjengeligjort i API'et. Boliger med denne disposisjonsformen vil heller ikke kunne oversendes via API'et.

Enum verdi	Beskrivelse
KOMMUNALT_EID
INNLEID_FRA_KOMMUNALT_FORETAK
INNLEID_FRA_STIFTELSE
INNLEID_FRA_PRIVAT_FORETAK
INNLEID_FRA_PRIVATPERSON

Eieform enum

Enum verdi	Beskrivelse
SELVEIER
BORETTSLAG
AKSJELEILIGHET

Leieforhold avslutningsgrunn enum

Begrunnelse ved avslutning av leieforhold

Enum verdi	Beskrivelse
KJOPT_BOLIG_MED_STARTLAN
KJOPT_DEN_KOMMUNALE_BOIGEN
FATT_ANNEN_BOLIGBISTAND
FUNNET_BOLIG_PA_EGENHAND
FLYTTET_UT_AV_KOMMUNEN
BYTTET_KOMMUNAL_BOLIG
ER_PA_INSTITUSJON
ER_I_FENGSEL
DOD
FORLENGELSE
ANNET

Matrikkel bruksenhetstype enum

Enum verdi	Beskrivelse
BOLIG
IKKE_GODKJENT_BOLIG
FRITIDSBOLIG
ANNET_ENN_BOLIG
UNUMMERERT_BRUKSENHET

Oppsigelsestid enum

Enum verdi	Beskrivelse
MND1
MND3
ANNET

Risikogruppe enum

Kobo angir en risikogruppe basert på opplysninger som er angitt for denne boligen (NOU 2012:4).

Risikogruppe 1 eller lavere Settes hvis boligen har én av følgende kombinasjoner; Har ikke direktekobling til brannvesen eller har direktekobling til brannvesen, men ikke sprinkelanlegg eller døgnbemanning

Risikogruppe 3 eller lavere Settes hvis boligen har direktekobling til brannvesen samt døgnbemanning, men ikke sprinkelanlegg

Risikogruppe 7 eller lavere

Enum verdi	Beskrivelse
RISIKOGRUPPE0
RISIKOGRUPPE1
RISIKOGRUPPE2
RISIKOGRUPPE3
RISIKOGRUPPE4
RISIKOGRUPPE5
RISIKOGRUPPE6
RISIKOGRUPPE7

Uteplass enum

Enum verdi	Beskrivelse
PRIVAT_HAGE
FELLES_HAGE
ALTAN_BALKONG_TERASSE_ELLER_VERANDA

Kobobolig​

Hente bolig​

OpenAPI utdrag​

Opprette bolig​

OpenAPI utdrag​

Endre bolig​

OpenAPI utdrag​

Behandle boligreservasjon​

Opprette boligreservasjon​

OpenAPI utdrag​

Avslutte boligreservasjon​

OpenAPI utdrag​

Behandle tildeling​

Tildele en bolig i Kobo​

OpenAPI utdrag​

Fjerne tildeling fra en bolig i Kobo​

OpenAPI utdrag​

Behandle leieforhold​

Leieforhold flyt​

Opprette leieforhold i Kobo​

OpenAPI utdrag​

OpprettLeieforholdTO​

LeieforholdOpprettOppdaterTO​

Oppdatere eksisterende leieforhold i Kobo​

OpenAPI utdrag​

Registrere oppsigelse av leieforhold​

OpenAPI utdrag​

LeieforholdOppsigelseTO​

Endre en eksisterende oppsigelse for et leieforhold​

OpenAPI utdrag​

Opphev en eksisterende oppsigelse for et leieforhold​

OpenAPI utdrag​

Avslutte leieforhold i Kobo​

OpenAPI utdrag​

LeieforholdAvsluttTO​

Knytte bolig til sak​

Med saksreferanse - har sak​

Uten saksreferanse - trenger ny sak​

Soft delete av bolig​

OpenAPI utdrag​

Registrere Webhook API key​

OpenAPI utdrag​

Klassediagram​

Objekter​

Adresse​

Beboer​

Bygning​

Eiendom​

Eieseksjon​

Eier​

Husstand​

Boligreservasjon​

Boligtildeling​

Leieforhold​

Leiekostnad​

Matrikkelenhet​

Meta​

Enums​

Boligegenskap enum​

Boligstatus enum​

Boligtype enum​

Boligsikkerhet enum​

Boligtilrettelegging enum​

Boligoppsigelse aktør enum​

Disposisjonsform enum​

Eieform enum​

Leieforhold avslutningsgrunn enum​

Matrikkel bruksenhetstype enum​

Oppsigelsestid enum​

Risikogruppe enum​

Uteplass enum​

Kobobolig

Hente bolig

OpenAPI utdrag

Opprette bolig

OpenAPI utdrag

Endre bolig

OpenAPI utdrag

Behandle boligreservasjon

Opprette boligreservasjon

OpenAPI utdrag

Avslutte boligreservasjon

OpenAPI utdrag

Behandle tildeling

Tildele en bolig i Kobo

OpenAPI utdrag

Fjerne tildeling fra en bolig i Kobo

OpenAPI utdrag

Behandle leieforhold

Leieforhold flyt

Opprette leieforhold i Kobo

OpenAPI utdrag

OpprettLeieforholdTO

LeieforholdOpprettOppdaterTO

Oppdatere eksisterende leieforhold i Kobo

OpenAPI utdrag

Registrere oppsigelse av leieforhold

OpenAPI utdrag

LeieforholdOppsigelseTO

Endre en eksisterende oppsigelse for et leieforhold

OpenAPI utdrag

Opphev en eksisterende oppsigelse for et leieforhold

OpenAPI utdrag

Avslutte leieforhold i Kobo

OpenAPI utdrag

LeieforholdAvsluttTO

Knytte bolig til sak

Med saksreferanse - har sak

Uten saksreferanse - trenger ny sak

Soft delete av bolig

OpenAPI utdrag

Registrere Webhook API key

OpenAPI utdrag

Klassediagram

Objekter

Adresse

Beboer

Bygning

Eiendom

Eieseksjon

Eier

Husstand

Boligreservasjon

Boligtildeling

Leieforhold

Leiekostnad

Matrikkelenhet

Meta

Enums

Boligegenskap enum

Boligstatus enum

Boligtype enum

Boligsikkerhet enum

Boligtilrettelegging enum

Boligoppsigelse aktør enum

Disposisjonsform enum

Eieform enum

Leieforhold avslutningsgrunn enum

Matrikkel bruksenhetstype enum

Oppsigelsestid enum

Risikogruppe enum

Uteplass enum