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. For API-detaljer se Swagger↗.

Kobobolig

Feltnavn	Datatype	Obligatorisk	Kan oppdateres	Merknader
adresse	objekt	ja	nei
antallSoverom	int	nei	ja	Antall soverom i boligen, ikke tilgjengelig i Matrikkelen.
boligtype	enum	ja	ja
bruksareal	double	nei	ja	Samme felt som i matrikkelen.
bruksenhetsnummer	string	nei	nei	Må være på rett format f.eks "H0402" eller "U0101."
bygning	objekt	nei	nei
disposisjonsform	enum	nei	ja
eieform	enum	nei	ja
eiendom	objekt	nei	ja
eieseksjon	objekt	nei	ja
eier	objekt	nei	nei
egenskaper	enum[]	nei	ja
ekstraReferanse	string	nei	nei	Brukes for å skille mellom flere boenheter i samme matrikkel-bruksenhet, feks i et bofellesskap. Typiske eksempel er "Rom 1", "Rom 2" osv.
erBofellesskap	boolean	nei	ja
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.
husstand	objekt	nei	nei
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
leiekostnad	objekt	nei	ja
leieTilEiePotensial	boolean	nei	ja	Hvis denne settes til true så er boenheten markert for leie til eie, og vil vises med merkelappen "Leie til eie" i Kobo fagsystem
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 som 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.
matrikkelBruksenhetstype	enum	nei	nei
egenvurdertRisikogruppe	enum	nei	ja	Grupper definert etter NOU 2012:4.
ovrigInformasjon	string	nei	ja	Fritekstfelt på inntil 1000 tegn
reservasjoner	objekt[]	nei	ja*	Les hvordan å behandle en boligreservasjon.
sikkerhet	enum[]	nei	ja
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
statusdato	date	nei	ja
tidligereLeieforhold	objekt[]	nei	nei
tildeling	objekt	nei	ja	Les hvordan å behandle en tildeling
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
underkategoriBoligtype	string	nei	ja	Brukt til å kategorisere boliger.
uteplass	enum[]	nei	ja
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.

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).

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).

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

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

Avslutte boligreservasjon

OpenAPI utdrag

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

Fjerne tildeling fra en bolig i Kobo

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

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

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

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

Registrere oppsigelse av leieforhold

Ved registrering av en oppsigelse, må det finnes et eksisterende leieforhold på boligien man prøver å registrere en oppsigelse på.

Endre en eksisterende oppsigelse for et leieforhold

For å endre en oppsigelse, må det finnes et eksisterende leieforhold der oppsigelsen allerede er registrert på boligen det gjelder.

Opphev en eksisterende oppsigelse for et leieforhold

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

For å avslutte et leieforhold, må det finnes et eksisterende leieforhold på boligen det gjelder.

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.

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).

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.

Klassediagram

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