- Created by Maria Klostermann Tapdrup, last modified on Dec 17, 2019
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 7 Next »
Siden beskriver de tjenester, der udstilles på Datafordeleren fra Matriklen.
Dokumentation for REST for Matriklen er samlet på denne side. Dokumentation for WFS for Matriklen er formidlet i Dataoversigt på Datafordeler.dk
Få en introduktion til Webservice på Datafordeleren (REST), 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 webservice på Selvbetjeningen (REST).
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.
Url-struktur for REST services | endpoint>/register/service/version/servicetype/metode? |
---|---|
Eksempel | https://services.datafordeler.dk/MATRIKEL/Matrikel/1/REST/SamletFastEjendom? |
Matriklen
Matriklen er grundlaget for ejendomsregistreringen i Danmark og udgør en vigtig del af administrationsgrundlaget i den offentlige forvaltning.
Matriklen består konceptuelt af matrikelregistret, matrikelkortet og matrikelarkivet.
- Registret indeholder oplysninger om arealer, herunder evt. vej- eller vandløbsarealer noteringsforhold (f.eks. om landbrugsejendomme, samlede faste ejendomme eller fredskov). Matrikelkortet er et digitalt, juridisk kortværk, som viser de registrerede ejendomsgrænser og vejrettigheder.
- I matrikelkortet vises også de fredskovsbelagte arealer, zoner for strandbeskyttelse og klitfredning.
- Matrikelarkivet indeholder bl.a. tidligere gældende matrikelkort, matrikelprotokoller og registrerede matrikulære sager, herunder måloplysninger.
Matrikelregistret og matrikelkortet er integreret i én samlet datamodel, hvor ”Matrikulære data” er det bærende dataelement.
Matrikulære data kan deles op i tre grupper: Elementer i basismatriklen, øvrige elementer og temaer.
- Basismatriklen indeholder de elementer, der indgår i den matrikulære proces, og de er vigtige elementer i bestemmelsen af den grundlæggende matrikulære situation. Elementer i basismatriklen: Matrikelskel, optaget vej, jordstykke, centroidepunkt, skelpunkt.
- Øvrige elementer indeholder administrative og matrikulære områder, der automatisk kan afledes ud fra elementer i basismatriklen. De indgår således ikke direkte i den matrikulære proces, men kan bruges som støttemateriale i processen.
- Temaer: Region, kommune, sogn, ejerlav. Endelig er temaer elementer, der bygger på den grundlæggende matrikulære situation, og som indgår i den matrikulære proces (jordrente, majoratskov, stormfald, fredskov, strandbeskyttelse, klitfredning, notering om jordforurening).
Generelt for MAT webservices
Format | XML/JSON |
---|---|
DLS version | 3.16 |
Sikkerhedszone | 0 – Indeholder ikke fortrolige eller følsomme data. |
Adgangsniveau | Alle kendte brugere må tilgå tjenesten. |
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. UTC kan angives enten ved +HH:MM (2019-07-05T07:50:14.687580+01:00) eller ved at benytte Z (2019-07-05T07:50:14.687580Z) |
REST - Matrikel
Anvendt udstillingsmodel | Matrikel |
---|
Metodeoversigt
Metode | SLA kategori | Tværgående tjeneste |
---|---|---|
MatrikulaerSag | Kompleks | Nej |
SamletFastEjendom | Normal | Nej |
BygningPaaFremmedGrund | Normal | Nej |
Ejerlejlighed | Normal | Nej |
BestemtFastEjendom | Kompleks | Nej |
MatrikelKommune | Normal | Nej |
SLA kategorier i produktion- maksimal svartid i sekunder:
- Simpel: 0.09
- Normal: 1.0
- Kompleks: 2.5
Metode - MatrikulaerSag
Beskrivelse
Henter infomation om en matrikulær sag.
Url
<endpoint>/Matrikel/Matrikel/1/rest/MatrikulaerSag? |
Inputparametre
Obligatoriske parametre:
SagsId ELLER Journalnr ELLER Sagskategori+Kommunenavn ELLER Sagsoperation+RekvirentRef. Er de ikke sat fås ingen resultater.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
SagsId | String |
| NULL | EAID_9223BE9F_D422_4f05_9180_7D3205A382A9.EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5 |
Journalnr | String |
| NULL | EAID_1A779A80_8462_4abd_BEEF_4982AB809818 |
SagsKategori | String | Synonym for forretningsproces | NULL | EAID_B8BDA19C_BD3A_45ae_9030_E7DFCEF34409 |
Kommunenavn | String | Kommunenavn | NULL | EAID_11D1CACA_AE81_4888_932E_6EC0B84075D0 |
SagsOperation | String | Synonym for forretningshændelse | NULL | EAID_CE6AEE92_1AD5_4496_8A73_5DF2380A5106 |
RekvirentRef | String |
| NULL | EAID_467DE9F6_E982_4a05_A337_F49700FC48E9 |
RegistreringstidFra | DateTime | Fra dato i registreringstidsperioden | NULL | EAID_75D4B68D_05C2_4ff9_983B_FA89782CB594 |
RegistreringstidTil | DateTime | Til dato i registreringstidsperioden | NULL | EAID_AB376482_5DBC_4314_BD49_9CBF6C975894 |
Registreringstid | DateTime | Dato som falder inden for en registreringstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende registreringstid på denne dato udvælges | NOW() | EAID_75D4B68D_05C2_4ff9_983B_FA89782CB594 EAID_AB376482_5DBC_4314_BD49_9CBF6C975894 |
VirkningstidFra | DateTime | Fra dato i virkningstidsperioden | NULL | EAID_7F5D338F_B4E9_4064_B25B_9F17BF8E0F62 |
VirkningstidTil | DateTime | Til dato i virkningstidsperioden | NULL | EAID_0AE85E10_0407_4d2f_9F73_E4EF203D7A33 |
Virkningstid | DateTime | Dato som falder inden for en virkningstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende virkningstid på denne dato udvælges | NOW() | EAID_7F5D338F_B4E9_4064_B25B_9F17BF8E0F62 EAID_0AE85E10_0407_4d2f_9F73_E4EF203D7A33 |
Status | String | En af følgende:
| NULL | EAID_3B09A42C_714C_486e_81B2_50B3DC65B415 |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”MAT_3.16_matrikulaersag.json” |
Metode - SamletFastEjendom
Beskrivelse
Henter en Samlet fast ejendom og tilhørende Jordstykker, herunder fælleslodder samt referencer til eventuelle bestemte faste ejendomme, der er beliggende på eller i ejendommen.
Url
<endpoint>/Matrikel/Matrikel/1/rest/SamletFastEjendom? |
Inputparametre
Obligatoriske parametre: SFEBFEnr ELLER Ejerlavskode+Matrikelnr ELLER point ELLER JordstykkeID ELLER SagsID. Er ingen af disse ikke sat fås ingen resultater. Kun én af disse muligheder må anvendes i et kald, dog må SagsID frit kombineres med andre parametre, hvilket også gælder for Status, Registreringstid og/eller Virkningstid.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
SFEBFEnr | Integer | BFEnummer på SamletFastEjendom | NULL | EAID_3828326A_2F94_4e83_A24D_F0BBB5D9EC28 |
Ejerlavskode | Integer | Ejerlavskoden | NULL | EAID_D16E1BA2_F38E_4cc4_B59E_F35D4ADEE636.EAID_157A3B49_F2FC_4dea_B641_19E46367B721 |
Matrikelnr | String | Matrikelnummer | NULL | EAID_8B60BEE8_D3BD_4c07_88FF_A2547A3D82D1.EAID_9C0920E3_3534_492a_978A_D6ED7344379B |
SagsId | String | Id fra Matrikulær sag | NULL | EAID_9223BE9F_D422_4f05_9180_7D3205A382A9.EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5 |
Point | String | UTM32 etrs89 geometripunkt defineret som indholdet i parentes fx point=(724786 6176332) | NULL | EAID_7B03CCE8_0143_48ec_86A9_7D85DBD97392 |
JordstykkeId | String | Jordstykke lokalid | NULL | EAID_9C1A6CF4_25D6_4e28_949F_D45BA79F9EF1.EAID_E511E10B_AA7D_4fb1_AD02_6BBC5A6E1AF8 |
Registreringstid | DateTime | Dato som falder inden for en registreringstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende registreringstid på denne dato udvælges | NOW() | EAID_F51B090F_487A_461f_B6D7_791BB28665B2 EAID_0B40190D_F1B6_4790_8CF5_42999F64BD94 |
Virkningstid | DateTime | Dato som falder inden for en virkningstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende virkningstid på denne dato udvælges | NOW() | EAID_D679F4FE_2378_4115_8E7E_2374F419C1CC EAID_78C7DF8E_3F5A_42e5_AAD4_70B83A2AC3A5 |
Status | String | En af følgende:
OBS: Ved angivelse af status vil udtrækket indeholde de objekter, hvor status matcher samt de objekter, hvor blot et af underobjekterne har en status der matcher. | NULL | EAID_7B734023_916B_432b_A740_756CC2EBBAE8 |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”MAT_3.16_samletfastejendom.json” |
Metode - BygningPaaFremmedGrund
Beskrivelse
Henter en Bygning på fremmed grund med oplysninger om geometri samt en reference til den SFE, BPFG’en ligger på, samt referencer til eventuelle lejligheder, der er beliggende i BPFG’en.
Url
<endpoint>/Matrikel/Matrikel/1/rest/ BygningPaaFremmedGrund? |
Inputparametre
Følgende parametre er obligatoriske: SFEBFEnr ELLER BPFGBFEnr ELLER Ejerlavskode+Matrikelnr ELLER Point ELLER SagsId. Er de ikke sat fås ingen resultater.
Bemærk at brugeren ikke kender til den geometriske repræsentation af BygningPaaFremmedGrund Logikken skal derfor kunne returnere den relevante geometritype (den skal altså selv finde ud af, om den skal outputte et punkt eller en polygon/flade). De to Default UUID'er repræsenterer henholdsvist et punkt og en flade.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
SFEBFEnr | Integer | BFENummer på SamletFastEjendom | NULL | EAID_9C1A6CF4_25D6_4e28_949F_D45BA79F9EF1.EAID_3828326A_2F94_4e83_A24D_F0BBB5D9EC28 |
BPFGBFEnr | Integer | BFENummer på BygningPaaFremmedGrund | NULL | EAID_3828326A_2F94_4e83_A24D_F0BBB5D9EC28 |
Ejerlavskode | Integer | Ejerlavskoden | NULL | EAID_D16E1BA2_F38E_4cc4_B59E_F35D4ADEE636.EAID_157A3B49_F2FC_4dea_B641_19E46367B721 |
Matrikelnr | String | Matrikelnummer | NULL | EAID_8B60BEE8_D3BD_4c07_88FF_A2547A3D82D1.EAID_9C0920E3_3534_492a_978A_D6ED7344379B |
Point | String | UTM32 etrs89 geometripunkt defineret som indholdet i parentes fx point=(724786 6176332) | NULL | EAID_9C1A6CF4_25D6_4e28_949F_D45BA79F9EF1.EAID_7B03CCE8_0143_48ec_86A9_7D85DBD97392 |
SagsId | String | Id fra Matrikulær sag | NULL | EAID_9223BE9F_D422_4f05_9180_7D3205A382A9.EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5 |
Registreringstid | DateTime | Dato som falder inden for en registreringstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende registreringstid på denne dato udvælges | NOW() | EAID_F51B090F_487A_461f_B6D7_791BB28665B2 EAID_0B40190D_F1B6_4790_8CF5_42999F64BD94 |
Virkningstid | DateTime | Dato som falder inden for en virkningstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende virkningstid på denne dato udvælges | NOW() | EAID_D679F4FE_2378_4115_8E7E_2374F419C1CC EAID_78C7DF8E_3F5A_42e5_AAD4_70B83A2AC3A5 |
Status | String | En af følgende:
OBS: Ved angivelse af status vil udtrækket indeholde de objekter, hvor status matcher samt de objekter, hvor blot et af underobjekterne har en status der matcher. | NULL | EAID_7B734023_916B_432b_A740_756CC2EBBAE8 |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”MAT_3.16_bygningpaafremmedgrund.json” |
Metode - Ejerlejlighed
Beskrivelse
Hent Ejerlejlighed med oplysninger om areal samt en reference til hovedejendommen (Samlet fast ejendom, eller Bygning på fremmed grund, Ejerlejligheden ligger i).
Url
<endpoint>/Matrikel/Matrikel/1/rest/ Ejerlejlighed? |
Inputparametre
Følgende parametre er obligatoriske: SFEBFEnr ELLER BPFGBFEnr ELLER ELBFEnr ELLER Ejerlavskode+Matrikelnr ELLER Ejerlavskode+Matrikelnr+Elnr ELLER SagsId ELLER SFEBFENr + Elnr.
Er de ikke sat fås ingen resultater.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
SFEBFEnr | Integer | BFENummer på SamletFastEjendom | NULL | EAID_9C1A6CF4_25D6_4e28_949F_D45BA79F9EF1.EAID_3828326A_2F94_4e83_A24D_F0BBB5D9EC28 |
BPFGBFEnr | Integer | BFENummer på BygningPaaFremmedGrund | NULL | EAID_A2B9B2EF_86F2_4f1d_87C0_1804A7071486.EAID_3828326A_2F94_4e83_A24D_F0BBB5D9EC28 EAID_1C0A5E2D_83CC_43d5_A7D7_C5B4FABF6109.EAID_3828326A_2F94_4e83_A24D_F0BBB5D9EC28 |
ELBFEnr | Integer | BFENummer på Ejerlejlighed | NULL | EAID_3828326A_2F94_4e83_A24D_F0BBB5D9EC28 |
Ejerlejlighednr | String | Ejerlejlighedsnummer | NULL | EAID_F33B87C5_ECD5_41d8_879D_53F8B778F32B |
Ejerlavskode | Integer | Ejerlavskoden | NULL | EAID_D16E1BA2_F38E_4cc4_B59E_F35D4ADEE636.EAID_157A3B49_F2FC_4dea_B641_19E46367B721 |
Matrikelnr | String | Matrikelnummer | NULL | EAID_8B60BEE8_D3BD_4c07_88FF_A2547A3D82D1.EAID_9C0920E3_3534_492a_978A_D6ED7344379B |
SagsId | String | Id fra Matrikulær sag | NULL | EAID_9223BE9F_D422_4f05_9180_7D3205A382A9.EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5 |
Registreringstid | DateTime | Dato som falder inden for en registreringstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende registreringstid på denne dato udvælges | NOW() | EAID_F51B090F_487A_461f_B6D7_791BB28665B2 EAID_0B40190D_F1B6_4790_8CF5_42999F64BD94 |
Virkningstid | DateTime | Dato som falder inden for en virkningstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende virkningstid på denne dato udvælges | NOW() | EAID_D679F4FE_2378_4115_8E7E_2374F419C1CC EAID_78C7DF8E_3F5A_42e5_AAD4_70B83A2AC3A5 |
Status | String | En af følgende:
OBS: Ved angivelse af status vil udtrækket indeholde de objekter, hvor status matcher samt de objekter, hvor blot et af underobjekterne har en status der matcher. | NULL | EAID_7B734023_916B_432b_A740_756CC2EBBAE8 |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”MAT_3.16_ejerlejlighed.json” |
Metode - BestemtFastEjendom
Beskrivelse
Henter Bestemt fast ejendom, uanset type, med tilhørende oplysninger og ejendomstype samt reference til eventuelle bestemte faste ejendomme, der er beliggende på eller i ejendommen.
Url
<endpoint>/Matrikel/Matrikel/1/rest/BestemtFastEjendom? |
Inputparametre
Følgende parametre er obligatoriske: BFEnr ELLER SagsId. Er de ikke sat fås ingen resultater. Vedr. input parameter Ejendomstype, så kan den anvendes til at afgrænse hvilken af de tre ejendomstyper, der ønskes medtaget i resultat.
De 4 UUID'er repræsenterer SFE, BPFG Flade, BPFG Punkt, og Ejerlejlighed. Se evt. beskrivelse af BygningPaaFremmedGrund.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
BFEnr | Integer | Et BFENummer eller en liste af BFEnumre på BestemtFastEjendom | NULL | EAID_3828326A_2F94_4e83_A24D_F0BBB5D9EC28 |
Ejendomstype | String | Angiver hvilken af de tre undertyper (Punkt og flade er slået sammen til én) der ønskes | NULL | Afledt kolonne - se SQL |
SagsId | String | Id fra Matrikulær sag | NULL | EAID_9223BE9F_D422_4f05_9180_7D3205A382A9.EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5 |
Registreringstid | DateTime | Dato som falder inden for en registreringstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende registreringstid på denne dato udvælges | NOW() | EAID_F51B090F_487A_461f_B6D7_791BB28665B2 EAID_0B40190D_F1B6_4790_8CF5_42999F64BD94 |
Virkningstid | DateTime | Dato som falder inden for en virkningstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende virkningstid på denne dato udvælges | NOW() | EAID_D679F4FE_2378_4115_8E7E_2374F419C1CC EAID_78C7DF8E_3F5A_42e5_AAD4_70B83A2AC3A5 |
Status | String | En af følgende:
OBS: Ved angivelse af status vil udtrækket indeholde de objekter, hvor status matcher samt de objekter, hvor blot et af underobjekterne har en status der matcher. |
| EAID_7B734023_916B_432b_A740_756CC2EBBAE8 |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”MAT_3.16_bestemtfastejendom” |
Metode - MatrikelKommune
Beskrivelse
Søg kommunenavn eller kommunekode.
Url
<endpoint>/Matrikel/Matrikel/1/rest/MatrikelKommune? |
Inputparametre
Obligatoriske parametre: Kommunenavn ELLER Kommunekode. Er de ikke sat fås ingen resultater.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
Kommunenavn | String | Kommunenavn | NULL | EAID_CBF5C68F_2889_4104_B423_22B718D1DA8B |
Kommunekode | String | fire-cifret kommunekode | NULL | EAID_A8B32F95_988E_4efb_B3AD_4920B839393B |
RegistreringstidFra | DateTime | Fra dato i registreringstidsperioden | NULL | EAID_05A5039B_ACFF_4754_BEA9_BD2EBC8F5C6A |
RegistreringstidTil | DateTime | Til dato i registreringstidsperioden | NULL | EAID_6DA20624_44E5_441b_87E4_CDF7765666D7 |
Registreringstid | DateTime | Dato som falder indenfor en registreringstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende registreringstid på denne dato udvælges | NOW() | EAID_05A5039B_ACFF_4754_BEA9_BD2EBC8F5C6A EAID_6DA20624_44E5_441b_87E4_CDF7765666D7 |
VirkningstidFra | DateTime | Fra dato i virkningstidsperioden | NULL | EAID_E5614463_E808_4491_8205_E30FB93CF3C8 |
VirkningstidTil | DateTime | Til dato i virkningstidsperioden | NULL | EAID_4AE908FA_CBA2_458b_AE3F_C925D5C3A54B |
Virkningstid | DateTime | Dato som falder inden for en virkningstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende virkningstid på denne dato udvælges | NOW() | EAID_E5614463_E808_4491_8205_E30FB93CF3C8 EAID_4AE908FA_CBA2_458b_AE3F_C925D5C3A54B |
Status | String | En af følgende:
| NULL | EAID_8972BCDE_C722_475d_8E2E_1869DBFAA78D |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”MAT_3.16_matrikelkommune.json” |
- No labels