Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Display Metadata | ||
---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
Siden beskriver de REST tjenester der udstilles på Datafordeleren fra Ejendomvurderingsregisteret.
Der udstilles i alt 1 webservice med 6 metoder.
Få en introduktion til REST på Datafordeleren, hvis du har brug for en introduktion til og vejledning i, hvordan man kan anvende webservices, som udstilles på Datafordeleren.
Få en guide til helt konkrete anvisninger til at bruge en webservice fra Datafordeleren i Guide til REST på Selvbetjeningen.
Table of Contents |
---|
Url opbygning for REST
Url for de enkelte services er opbygget af et endpoint efterfulgt af registernavn, servicenavn, versionen af servicen, servicetype (REST eller WFS etc.) samt metodenavn for REST services. Efter ? tilføjes parametre i kaldet, der kan indeholde generelle kaldeparametre for REST services og metode specifikke parametre.
Endpointet indeholder værtsnavnet, med et præfiks for miljøet hvis det ikke er produktionsmiljøet der tilgås. Hvis der er tale om fortrolige eller følsomme data, følger S5 og at servicen skal kaldes med certifikat derfor certservices - se miljøbeskrivelser.
Læs mere om sammensætning af url'er på siden REST på Datafordeleren eller se eksempler på, at parametre bliver tilføjet til url'er på Datafordeleren - eks. på anvendelse af bitemporalitet eller User stories.
Url-struktur for REST services | <endpoint>/register/service/version/servicetype/metode? |
---|---|
Eksempel på url med brugernavn/adgangskode | https://services.datafordeler.dk/Ejendomsvurdering/Ejendomsvurdering/1/rest/HentEjendomsvurderingerÆndretFraDatoTilDato?username=xxx&password=yyy&AendringDatoFra=yyyy-mm-dd&AendringDatoTil=yyyy-mm-dd |
Eksempel på url med certifikat | https://certservices.datafordeler.dk/Ejendomsvurdering/Ejendomsvurdering/1/rest/HentEjendomsvurderingerÆndretFraDatoTilDato?AendringDatoFra=yyyy-mm-dd&AendringDatoTil=yyyy-mm-dd |
Ejendomsvurdering (VUR)
I nedenstående afsnit beskrives den webservice på Datafordeleren, der udstiller Ejendomsvurderings data.
Datamodel
Det centrale objekt er en ejendomsvurdering med en id.
To af metoderne leverer en liste af id’er til ejendomsvurderinger tilbage. De andre metoder leverer en liste med ejendomsvurderinger inklusive alle attributter og underentiteter tilbage. Dvs. en ejendomsvurdering leveres med entiteterne Fordeling, Loftansættelse, Grundværdispecifikation, FradragForForbedring samt Fritagelse. Desuden leveres for hver ejendomsvurdering en liste med tilhørende BFE’er, den tilhørende vurderingsejendom, moderejendommen (hvis vurderingsejendommen er en ejerlejlighed) og den ejendom vurderingsejendommen er vurderet under (hvis vurderingsejendommen er en beliggenhedsejendom).
Data leveres således samlet i udstillingsmodellen og den eneste nøgle som har en betydning er id’en til ejendomsvurderingen (attribut id på klassen Ejendomsvurdering), samt nøglen til den ejendom som vurderes (attribut VURejendomsid på klassen Vurderingsejendom).
Primærnøglerne til klasserne Fordeling, Loftansættelse, Grundværdispecifikation, FradragForForbedring samt Fritagelse samt fremmednøglerne fra disse klasser til den tilhørende vurdering er ikke en del af udstillingsmodellen.
Ønsker man at se beliggenhedsejendomme til en vurderingsejendom hhv. ejerlejligheder til en moderejendom findes disse ved at 'travle' baglæns:
Eksempel:
- Vurderingsejendom med ejendomsid 1 vurderes med fritagelse G i år 2014.
- Beliggenhedsejendomme med ejendomsid 2 og 3 vurderes og deres vurderinger for 2014 vil i strukturen ”Vurderet under” have angivet ejendomsid 1.
- For at finde beliggenhedsejendomme til vurderingsejendom 1 i år 2014 skal man kigge alle vurderinger af samme år igennem og se, om de har en understruktur ”Vurderet Under”, som angiver ejendomsid 1.
På samme måde kan ejerlejligheder til en moderejendom findes.
En detaljeret beskrivelse af de udstillede data findes i grunddatamodellen.
Dataindhold
Relationen til BFE, Moderejendom, VurderetUnder som udstilles for eksisterende ejendomsvurderinger, er som de ser ud i dag og ikke som de så ud på vurderingstidspunktet, da der ikke var historik på ESR matrikler.
Kun afsluttede vurderinger, dvs. vurderinger med status 'låst' samt overspringsvurderinger/årsreguleringer udstilles via Datafordeleren. Begreberne overspringsvurderinger/årsreguleringer dækker begge over, at der ikke gennemføres en egentlig vurdering i det pågældende år. Der er den forskel på de to begreber, at årsreguleringer (ændringskode = 9) kan rumme indekserede ansættelser, hvorimod overspringsvurderingen er en videreførelse af en tidligere vurdering uden indeksering. Efterfølgende er dette modificeret via L80 og L76, idet der indført såkaldte reduktioner på henholdsvis ejendomsværdi og grundværdi på ejerboliger. I årene 2001 – 2002 havde ændringskode = 9 dog en særlig betydning, idet alle ejendomme her var udtaget til vurdering hvert år.
Vurderingsidenten 1.1.2003 vil altid have ændringsdatoen 01012003. Hvis der sker en ændring her bliver der skrevet oveni de gamle data. Dvs. der er ikke historik. 2003 kan godt have en nyere gældende vurdering, hvor ændringsdatoen f.eks. er 27052005, hvis der f.eks. har været en klage over vurderingen. Det er vurderingsåret, der afgør hvilket år vurderingen vedr., og ændringsdatoen, hvilken der er skattemæssig gældende.
Generelt for VUR webservices
Registernavn i Selvbetjeningen | Ejendomsvurdering |
---|---|
Format | XML/JSON |
DLS version | 2.15 |
Sikkerhedszone | 0 – Indeholder ikke fortrolige eller følsomme data |
Adgangsniveau | Alle kendte brugere skal anmode om adgang til servicen |
Paging | Anvender ikke paging. |
Dato- og tidsformat | Datoformat følger ISO 8601 Date and time format. Alle datoer skrives med andre ord i formatet yyyy-mm-ddTHH:MM:SS.ssssss, hvor tidsangivelsen kan udelades. Tidszonen kan angives enten ved (2019-02-05T07:50:14.687580+01:00 (for normaltid/vintertid)), (2019-07-05T07:50:14.687580+02:00 (for sommertid)) eller ved at benytte Z (2019-07-05T07:50:14.687580Z). |
REST - Ejendomsvurdering
Beskrivelse
Tjeneste til at hente ejendomsvurderinger.
Den udstillede REST service har i alt 6 metoder. Der er 2 metoder til at fremsøge ejendomsvurderingid'er ud fra et tidsinterval. Der er 4 metoder til at hente ejendomsvurderinger med underentiteter ud fra forskellige nøgler.
Adgangsbegrænsning | Følgende 10 felter i tabel Ejendomsvurdering leveres ikke hvis dataanvenderens rolle indeholder en begrænsning: bebyggelseProcent |
---|---|
Anvendt udstillingsmodel | Ejendomsvurdering |
Metodeoversigt
Metode | SLA kategori |
---|---|
HentEjendomsvurderingerÆndretFraDatoTilDato | Kompleks |
HentEjendomsvurderingerAjourføringFraDatoTilDato | Kompleks |
HentEjendomsvurderingerForEjendomsvurderingId | Kompleks |
HentEjendomsvurderingerForVurderingsejendomID | Kompleks |
HentEjendomsvurderingerForESRkommunenummerESRejendomsnummer | Kompleks |
HentEjendomsvurderingerForBFE | Kompleks |
SLA kategorier i produktion- maksimal svartid i sekunder:
- Simpel: 0.09
- Normal: 1.0
- Kompleks: 2.5
Metode - HentEjendomsvurderingerÆndretFraDatoTilDato
Beskrivelse
Metoden returnerer liste af id'er for de Ejendomsvurderinger som opfylder det medsendte tidsinverval for feltet aendringDato.
Eksempel på url med brugernavn/adgangskode
https://services.datafordeler.dk/Ejendomsvurdering/Ejendomsvurdering/1/rest/HentEjendomsvurderingerÆndretFraDatoTilDato?username=xxx&password=yyy&AendringDatoFra=yyyy-mm-dd&AendringDatoTil=yyyy-mm-dd |
Eksempel på url med certifikat
https://certservices.datafordeler.dk/Ejendomsvurdering/Ejendomsvurdering/1/rest/HentEjendomsvurderingerÆndretFraDatoTilDato?AendringDatoFra=yyyy-mm-dd&AendringDatoTil=yyyy-mm-dd |
Inputparametre
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
AendringDatoFra | Date | Angiver starttidspunktet for intervallet på feltet aendringDato på Ejendomsvurdering, som medtages i søgningen. | NULL | EAID_9000D323_BCB3_4637_880E_B69AE00C13CB |
AendringDatoTil | Date | Angiver sluttidspunktet for intervallet på feltet aendringDato på Ejendomsvurdering, som medtages i søgningen. | NULL | EAID_9000D323_BCB3_4637_880E_B69AE00C13CB |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”VUR_2.15_EjendomsvurderingIDSvarStruktur.json” |
Metode - HentEjendomsvurderingerAjourføringFraDatoTilDato
Beskrivelse
Returnerer liste af id'er for de Ejendomsvurderinger som opfylder det medsendte tidsinverval for feltet ajourfoeringDato.
Eksempel på url med brugernavn/adgangskode
https://services.datafordeler.dk/Ejendomsvurdering/Ejendomsvurdering/1/rest/HentEjendomsvurderingerAjourføringFraDatoTilDato?AjourføringDatoFra=yyyy-mm-dd&AjourføringDatoTil=yyyy-mm-dd&username=xxx&password=yyy |
Eksempel på url med certifikat
https://certservices.datafordeler.dk/Ejendomsvurdering/Ejendomsvurdering/1/rest/HentEjendomsvurderingerAjourføringFraDatoTilDato?AjourføringDatoFra=yyyy-mm-dd&AjourføringDatoTil=yyyy-mm-dd&username=xxx&password=yyy |
Inputparametre
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
AjourføringDatoFra | Datetime | Angiver starttidspunktet for intervallet på feltet ajourfoeringDato på Ejendomsvurdering, som medtages i søgningen. | NULL | EAID_14EBEA8C_E349_498d_B9FA_A71B9CC5DBEC |
AjourføringDatoTil | Datetime | Angiver sluttidspunktet for intervallet på feltet ajourfoeringDato på Ejendomsvurdering, som medtages i søgningen. | NULL | EAID_14EBEA8C_E349_498d_B9FA_A71B9CC5DBEC |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”VUR_2.15_EjendomsvurderingIDSvarStruktur.json” |
Metode - HentEjendomsvurderingerForEjendomsvurderingId
Beskrivelse
Returnerer liste af Ejendomsvurderinger med underentiteter for de Ejendomsvurderinger som har id = @id (Her returneres kun en men det er for at vi kan have samme outputstruktur på alle kald som returnerer hele strukturen)
Eksempel på url med brugernavn/adgangskode
https://services.datafordeler.dk/Ejendomsvurdering/Ejendomsvurdering/1/rest/HentEjendomsvurderingerForEjendomsvurderingId?id=xxxxxxxxxxxxx&username=xxx&password=yyy |
Eksempel på url med certifikat
https://certservices.datafordeler.dk/Ejendomsvurdering/Ejendomsvurdering/1/rest/HentEjendomsvurderingerForEjendomsvurderingId?id=xxxxxxxxxxxxx |
Inputparametre
Obligatoriske parametre: Id
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
Id | Integer | Entydig identifikation af en Ejendomsvurdering | EAID_698623F8_598C_409f_88B6_4A99487D9ADB |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”VUR_2.14_EjendomsvurderingSvarStruktur.json” |
Metode - HentEjendomsvurderingerForVurderingsejendomID
Beskrivelse
Returnerer liste af Ejendomsvurderinger med underentiteter for de Vurderingsejendomme som har vurderingsejendomID = @vurderingsejendomID (returns a list of Ejendomsvurderinger, each Ejendomsvurdering is delivered with substructures)
Eksempel på url med brugernavn/adgangskode
https://services.datafordeler.dk/Ejendomsvurdering/Ejendomsvurdering/1/rest/HentEjendomsvurderingerForVurderingsejendomID?VurderingsejendomID=xxxxxxxxxxxxx&username=xxx&password=yyy |
Eksempel på url med certifikat
https://certservices.datafordeler.dk/Ejendomsvurdering/Ejendomsvurdering/1/rest/HentEjendomsvurderingerForVurderingsejendomID?VurderingsejendomID=xxxxxxxxxxxxx |
Inputparametre
Obligatoriske parametre: VurderingsejendomID
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
VurderingsejendomID | Integer | Entydig identifikation af en Vurderingsejendom ud fra vurderingsejendomID(ID som kommer fra ICE) |
| EAID_59BECEEB_B148_45a4_BDB0_A3F0E0A980A9 |
År | Integer | År for en Ejendomsvurdering | NULL | EAID_E975756F_A42D_484b_90E9_0F3A556A3839 |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”VUR_2.14_EjendomsvurderingSvarStruktur.json” |
Metode - HentEjendomsvurderingerForESRkommunenummerESRejendomsnummer
Beskrivelse
Returnerer liste af Ejendomsvurderinger med underentiteter for de Ejendomsvurderinger som har Ejendomsvurdering.ESRejendomsnummer = @Ejendomsvurdering.ESRejendomsnummer.
Eksempel på url med brugernavn/adgangskode
https://services.datafordeler.dk/Ejendomsvurdering/Ejendomsvurdering/1/rest/HentEjendomsvurderingerForESRkommunenummerESRejendomsnummer?ESRejendomsnummer=xxxxxx&ESRkommunenummer=xxx&username=xxx&password=yyy |
Eksempel på url med certifikat
https://certservices.datafordeler.dk/Ejendomsvurdering/Ejendomsvurdering/1/rest/HentEjendomsvurderingerForESRkommunenummerESRejendomsnummer?ESRejendomsnummer=xxxxxx&ESRkommunenummer=xxx |
Inputparametre
Obligatoriske parametre: ESRejendomsmnummer og ESRkommunenummer
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
ESRejendomsnummer | Integer | ESR Ejendomsnummer |
| EAID_40A5A897_E518_417f_AF09_865C53F964A5 |
ESRkommunenummer | Integer | ESR Kommunenummer |
| EAID_E5914BB4_8282_4613_ABC7_8A296D8C5FE0 |
År | Integer | År for en Ejendomsvurdering | NULL | EAID_E975756F_A42D_484b_90E9_0F3A556A3839 |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”VUR_2.14_EjendomsvurderingSvarStruktur.json” |
Metode - HentEjendomsvurderingerForBFE
Beskrivelse
Returnerer liste af Ejendomsvurderinger med underentiteter for de Ejendomsvurderinger som har BFEnummer = @BFEnummer (returns a list of Ejendomsvurderinger, each Ejendomsvurdering is delivered with substructures)
Eksempel på url med brugernavn/adgangskode
https://services.datafordeler.dk/Ejendomsvurdering/Ejendomsvurdering/1/rest/HentEjendomsvurderingerForBFE?BFENummer=xxxxxxx&username=xxx&password=yyy |
Eksempel på url med certifikat
https://certservices.datafordeler.dk/Ejendomsvurdering/Ejendomsvurdering/1/rest/HentEjendomsvurderingerForBFE?BFENummer=xxxxxxx |
Inputparametre
Obligatoriske parametre: BFEnummer
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
BFEnummer | Integer | Bestemt Fast Ejendom nummer |
| EAID_3828326A_2F94_4e83_A24D_F0BBB5D9EC28 (UUID er fra Matrikel) |
År | Integer | År for en Ejendomsvurdering | NULL | EAID_E975756F_A42D_484b_90E9_0F3A556A3839 |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”VUR_2.14_EjendomsvurderingSvarStruktur.json” |