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 Ejerfortegnelsen. Der er tale om tre REST services med tilhørende 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.
Kendte fejl, som du kan finde i data hos EJF er beskrevet på Kendte fejl (EJF)
Table of Contents |
---|
Sideinformation
Display Metadata | ||
---|---|---|
|
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 certifikat | https://s5-certservices.datafordeler.dk/EJERFORTEGNELSE/Ejerfortegnelsen/1/rest/EjendomsadministratorMedStamoplysninger?BFENummer=xxxxxxx |
Url-struktur for REST services | <endpoint>/register/service/version/servicetype/metode? |
---|---|
Eksempel på url med certifikat | https://s5-certservices.datafordeler.dk/EJERFORTEGNELSE/Ejerfortegnelsen/2.0.0/rest/EjendomsadministratorMedStamoplysninger?BFENummer=xxxxxxx |
Generelt for EJF webservices
Registernavn i Selvbetjeningen | EJERFORTEGNELSE |
---|---|
Format | XML/JSON |
DLS version | 3.14 |
Sikkerhedszone | 5 - Indeholder fortrolige eller følsomme data. |
Anvendt udstillingsmodel | Ejerfortegnelsen |
Paging | Anvender 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. BEMÆRK Ejerfortegnelsen ikke benytter mikrosekunder for registerings- og virkningstid. For deres registerings- og virkningstid er mikrosekunderne er altid 0 og har derfor følgende format yyyy-mm-ddTHH:MM:SS.000000. Tidszonen kan angives enten ved (2019-02-05T07:50:14.000000+01:00 (for normaltid/vintertid)), (2019-07-05T07:50:14.000000+02:00 (for sommertid)) eller ved at benytte Z (2019-07-05T07:50:14.000000Z). |
REST - Ejerfortegnelsen
Beskrivelse
Fremsøgning af ikke-fortrolige ejer- og administratoroplysninger ift. en Bestemt fast ejendom. Servicen anvender og returnerer ingen CPR-numre eller beskyttede navne/adresser.
Adgangsniveau | Alle kendte brugere må tilgå tjenesten Alle brugere skal IP-whitelistes for at få adgang til tjenesten |
---|---|
SLA | Se registrets tilgængelighed på datafordeler.dk |
Metodeoversigt
Metodenavn | SLA | Tværgående tjeneste | Anvendt udstillingsmodel |
---|---|---|---|
EjendomsadministratorMedStamoplysninger | Kompleks | Ja | DAR, CPR, CVR |
EjerskabMedStamoplysninger | Kompleks | Ja | DAR, CPR, CVR |
Ejerskabsskifte | Normal | Nej | - |
Ejerskifte | Kompleks | Nej | - |
Handelsoplysning | Kompleks | Nej | - |
PersonEllerVirksomhedsoplysning | Normal | Nej | - |
SLA kategorier i produktion- maksimal svartid i sekunder:
- Simpel: 0.09
- Normal: 1.0
- Kompleks: 2.5
Metode - EjendomsadministratorMedStamoplysninger
Beskrivelse
Metoden henter oplysninger om en ejendomsadministrator til en Bestemt fast ejendom – med alle stamoplysninger (navn og adresse) fra hhv. Det Centrale Virksomhedsregister (CVR), Det Centrale Personregister (CPR) og Danmarks Adresseregister (DAR).
Eksempel på url med certifikat
https://s5-certservices.datafordeler.dk/EJERFORTEGNELSE/Ejerfortegnelsen/1/rest/EjendomsadministratorMedStamoplysninger?BFEnr=xxxxxxx |
Inputparametre
Obligatorisk parameter: BFE-nummer (BFEnr)
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
BFEnr | String | Bestemt Fast Ejendom nummer | NULL | EAID_dst831A8A_9D17_463c_96AE_199F42DCA267 |
Virkningstid | DateTime | Dato som falder indenfor en virkningstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende virkningstid på denne dato udvælges | NOW() | EAID_DB0ADB0B_AEF4_4c51_846D_D3404DC85449 EAID_06091801_5AC6_4262_825D_0B4C2FA3D57C |
Status | String | Status jf. grunddatamodellens udfaldsrum for EjerfortegnelsestatusVærdi | NULL | EAID_5DF93B9F_50AA_49aa_9481_F04517799FFF |
Outputparametre
Typen af administrator afgør hvilke dele af outputskemaet, der vil være udfyldt. Hvis administratoren er en person, vil der for eksempel ikke være nogen virksomhed i output. Der vil således altid være præcis én type administrator i hver returnerede forekomst, hvis der er en administrator på ejendommen.
Kaldes tjenesten uden status returneres både gældende samt historiske forekomster.
Der vises ikke adresseinformation for personer med adressebeskyttelse. For sådanne personer vil disse oplysninger således ikke eksistere i output for de enkelte administratorer.
Metode | Skema |
---|---|
Den inkluderede fil ”EJF_3.14_ejendomsadministratormedstamoplysninger.json” indeholder output som JSON-schema | Skema - filudtræk og webservices (EJF) |
Metode - EjerskabMedStamoplysninger
Beskrivelse
Metoden henter ejeroplysninger til en given Bestemt fast ejendom – også kaldet Ejerskab – med alle stamoplysninger (ejendomsoplysninger, navn og adresse) fra hhv. Ejendomsbeliggenhedsregistret (EBR), Matriklen (MAT), Det Centrale Virksomhedsregister (CVR), Det Centrale Personregister (CPR) og Danmarks Adresseregister (DAR).
Eksempel på url med certifikat, version 1
https://s5-certservices.datafordeler.dk/EJERFORTEGNELSE/Ejerfortegnelsen/1/rest/EjerskabMedStamoplysninger?BFEnr=xxxxxxx |
Inputparametre
Obligatoriske parametre: Enten BFE-nummer (BFEnr) eller ejerskabsid (Ejerskabsid).
Det er muligt at angive begge værdier, men det vil ikke være muligt at få resultater fra flere ejendomme, ved at angive et ejerskabsid, som ikke er tilknyttet til den angivne ejendom.
Det er ikke muligt, at angive BFE-nummer (BFEnr) og ejerskabsid (Ejerskabsid) samtidig og på den måde få resultater fra forskellige ejendomme. Angives begge parametre, vil det dog være muligt, at få et resultat, hvis det angivne ejerskabsid findes på et ejerskab på ejendommen med det angivne BFE-nummer.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
BFEnr | String | Bestemt Fast Ejendom nummer | NULL | EAID_dst911481_AA7A_425a_8B3D_DA1AE8630B36 |
Ejerskabsid | String | Lokalid for et ejerskab | NULL | EAID_422EE0E4_C1B2_4dc0_A1DD_88F37B725096 EAID_42EEFD36_07DE_48e5_AF47_A3302D9EDEF5 |
Virkningstid | DateTime | Dato som falder indenfor en virkningstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende virkningstid på denne dato udvælges | NOW() | EAID_DB0ADB0B_AEF4_4c51_846D_D3404DC85449 EAID_06091801_5AC6_4262_825D_0B4C2FA3D57C |
Status | String | Status jf. grunddatamodellens udfaldsrum for EjerfortegnelsestatusVærdi | NULL | EAID_5DF93B9F_50AA_49aa_9481_F04517799FFF |
Outputparametre
Typen af ejer og tilstedeværelse og typen af administrator afgør hvilke dele af outputskemaet, der vil være udfyldt. Hvis ejeren er en person, vil der for eksempel ikke være nogen ejende virksomheder i output. Der vil således altid være præcis én type ejer og nul til én type administrator.
Der vises ikke adresseinformation for personer med adressebeskyttelse. For sådanne personer vil disse oplysninger således ikke eksisterer i output for de enkelte ejere/administratorer.
Metode | Skema |
---|---|
Den inkluderede fil ”EJF_3.14_ejerskabmedstamoplysninger.json” indeholder output som JSON-schema | Skema - filudtræk og webservices (EJF) |
Metode - Ejerskabsskifte
Beskrivelse
Metoden returnerer Ejerfortegnelsens oplysninger om ejerskabsskifte. Selve ejerskabene samt Stamoplysninger for ejere, som er involveret i ejerskiftet, udstilles ikke via denne service.
Eksempel på url med certifikat, version 1
https://s5-certservices.datafordeler.dk/EJERFORTEGNELSE/Ejerfortegnelsen/1/rest/Ejerskabsskifte?ejerskabsskifteId=yxxxyyyx-xyyy-yyyx-xyyy-yyyyyyxxyyxx |
Inputparametre
Obligatoriske parametre: Ejerskabsskifteid (EjerskabsskifteId).
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
EjerskabsskifteId | String | Lokal id for et ejerskabsskifte | NULL | EAID_42EEFD36_07DE_48e5_AF47_A3302D9EDEF5 EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5 |
RegistreringstidFra | DateTime | Fra dato i registreringstidsperioden. | NULL | EAID_76A43210_69E9_4a22_8D1F_A4CBCF5D362D |
RegistreringstidTil | DateTime | Til dato i registreringstidsperioden. | NULL | EAID_E41A79F3_7D5D_4314_AA49_2610AFC92738 |
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_76A43210_69E9_4a22_8D1F_A4CBCF5D362D EAID_E41A79F3_7D5D_4314_AA49_2610AFC92738 |
VirkningstidFra | DateTime | Fra dato i virkningstidsperioden. | NULL | EAID_DB0ADB0B_AEF4_4c51_846D_D3404DC85449 |
VirkningstidTil | DateTime | Til dato i virkningstidsperioden. | NULL | EAID_06091801_5AC6_4262_825D_0B4C2FA3D57C |
Virkningstid | DateTime | Dato som falder indenfor en virkningstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende virkningstid på denne dato udvælges. | NOW() | EAID_DB0ADB0B_AEF4_4c51_846D_D3404DC85449 EAID_06091801_5AC6_4262_825D_0B4C2FA3D57C |
Status | String | Status jf. grunddatamodellens udfaldsrum for EjerfortegnelsestatusVærdi | NULL | EAID_5DF93B9F_50AA_49aa_9481_F04517799FFF |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”EJF_3.14_ejerskabsskifte.json” indeholder output som JSON-schema | Skema - filudtræk og webservices (EJF) |
Metode - Ejerskifte (version 2.0.0 )
Beskrivelse
Metoden returnerer Ejerfortegnelsens oplysninger om ejerskifte på en Bestemt fast ejendom. Ejerskabsskifter (afstået og modtaget andel mv.) udstilles ikke via denne metode
Eksempel på url med certifikat, version 2.0.0 (Inklusiv BFE nummer)
https://s5-certservices.datafordeler.dk/EJERFORTEGNELSE/Ejerfortegnelsen/2.0.0/rest/Ejerskifte?BFEnr=xxxxxxx |
Inputparametre
Obligatoriske parametre: Enten BFE-nummer (BFEnr) eller ejerskifteid (EjerskifteId).
Det er muligt at angive begge værdier, men det vil ikke være muligt at få resultater fra flere ejendomme, ved at angive et ejerskifteid, som ikke er tilknyttet til den angivne ejendom.
Bemærk, at der i denne metode gives mulighed for periodeopslag på trods af, at der foretages join på relationen mellem ejerskifte og ejerskabsskifte. Denne relation er speciel, da et ejerskifte vil have det samme sæt af ejerskabsskifter under hele dets levetid. Der foretages derfor et specielt join, som gør, at alle resulterende ejerskifter, vil have alle sine ejerskabsskifter tilknyttet. Dette ignorerer altså evt. historik på ejerskabsskifterne, men da der kun leveres lokalid, som er konstant, er dette ikke et problem, eftersom der hverken kan opstå nye ejerskabskifter eller fjernes eksisterende i løbet af ejerskiftet historik.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
BFEnr | String | Bestemt Fast Ejendom nummer | NULL | EAID_dst2E9BC3_F084_4064_A34B_334C6CC03CB8 |
EjerskifteId | String | Lokal id for et ejerskifte | NULL | EAID_42EEFD36_07DE_48e5_AF47_A3302D9EDEF5 EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5 |
RegistreringstidFra | DateTime | Fra dato i registreringstidsperioden. | NULL | EAID_76A43210_69E9_4a22_8D1F_A4CBCF5D362D |
RegistreringstidTil | DateTime | Til dato i registreringstidsperioden. | NULL | EAID_E41A79F3_7D5D_4314_AA49_2610AFC92738 |
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_76A43210_69E9_4a22_8D1F_A4CBCF5D362D EAID_E41A79F3_7D5D_4314_AA49_2610AFC92738 |
VirkningstidFra | DateTime | Fra dato i virkningstidsperioden | NULL | EAID_DB0ADB0B_AEF4_4c51_846D_D3404DC85449 |
VirkningstidTil | DateTime | Til dato i virkningstidsperioden. | NULL | EAID_06091801_5AC6_4262_825D_0B4C2FA3D57C |
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_DB0ADB0B_AEF4_4c51_846D_D3404DC85449 EAID_06091801_5AC6_4262_825D_0B4C2FA3D57C |
Status | String | Status jf. grunddatamodellens udfaldsrum for EjerfortegnelsestatusVærdi | NULL | EAID_5DF93B9F_50AA_49aa_9481_F04517799FFF |
Outputparametre
Metode | Skema |
---|---|
Ejerskifte - version 2.0.0 Den inkluderede fil ”EJF_3.15_ejerskifte.json” indeholder output som JSON-schema (inklusiv bfeNummer) | Skema - filudtræk og webservices (EJF) |
Metode - Handelsoplysning
Beskrivelse
Servicen returnerer Ejerfortegnelsens oplysninger om datoer i forbindelse med ejendomshandel, økonomiske oplysninger og andre oplysninger til brug for vurdering og ejendomsbeskatning.
Eksempel på url med certifikat, version 1
https://s5-certservices.datafordeler.dk/EJERFORTEGNELSE/Ejerfortegnelsen/1/rest/Handelsoplysning?BFEnr=xxxxxxx |
Inputparametre
Obligatoriske parametre: Enten BFE-nummer (BFEnr) eller handelsoplysningsid (HandelsOplysningsId).
Det er muligt at angive begge værdier, men det vil ikke være muligt at få resultater fra flere ejendomme, ved at angive et handelsoplysningsid, som ikke er tilknyttet til den angivne ejendom.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
BFEnr | String | Bestemt Fast Ejendom nummer | NULL | EAID_9F5F102E_4713_47d7_92AC_C1858DAB021C EAID_dst2E9BC3_F084_4064_A34B_334C6CC03CB8 |
HandelsOplysningsId | String | Lokalid for en handelsoplysning | NULL | EAID_42EEFD36_07DE_48e5_AF47_A3302D9EDEF5 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_76A43210_69E9_4a22_8D1F_A4CBCF5D362D EAID_E41A79F3_7D5D_4314_AA49_2610AFC92738 |
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_DB0ADB0B_AEF4_4c51_846D_D3404DC85449 EAID_06091801_5AC6_4262_825D_0B4C2FA3D57C |
Status | String | Status jf. grunddatamodellens udfaldsrum for EjerfortegnelsestatusVærdi | NULL | EAID_5DF93B9F_50AA_49aa_9481_F04517799FFF |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”EJF_3.14_handelsoplysning.json” indeholder output som JSON-schema | Skema - filudtræk og webservices (EJF) Output indeholder en liste af lokalid'er på ejerskifter, som er tilknyttet handelsoplysningen, men ingen yderligere information om ejerskifterne. |
Metode - PersonEllerVirksomhedsoplysning
Beskrivelse
Metoden returnerer Ejerfortegnelsens oplysninger om personer eller virksomheder der ikke findes i CPR eller CVR.
Eksempel på url med certifikat, version 1
https://s5-certservices.datafordeler.dk/EJERFORTEGNELSE/Ejerfortegnelsen/1/rest/PersonEllerVirksomhedsoplysning?PVOId=yyyxyyxx-xyyy-yxxy-yyxy-xyyyyyxyyyyx |
Inputparametre
Obligatoriske parametre: Enten person- eller virksomhedsoplysingsid (PVOId) eller det fiktive PV-nummer (FiktivtPVnummer).
Det er muligt at angive begge værdier, men det vil ikke være muligt at få resultater for flere person- eller virksomhedsoplysninger, ved at angive et fiktivt PV-nummer, som ikke er tilknyttet til det angivne person- eller virksomhedsid.
På trods af, at det fiktive PV-nummer, som man kan filtrere på med parameteren FiktivtPVNummer, kan være NULL i data, er det ikke muligt at foretage søgninger med værdien NULL. Sættes værdien til NULL, eller udelades den, vil den altså blive ignoreret, hvorved PVOId parameteren er krævet, som beskrevet ovenfor.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
PVOId | String | Id for person eller virksomhed, der ikke kan findes ved CVR eller CPR | NULL | EAID_42EEFD36_07DE_48e5_AF47_A3302D9EDEF5 EAID_6CEB0356_5CBF_4159_B96B_A2489DD2DAC8 |
FiktivtPVnummer | String | Fiktivt PV-nummer | NULL | EAID_7A84F94B_7116_48ba_B35E_37757DA1DFC9 |
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. Datoformat følger ISO 8601 | NOW() | EAID_76A43210_69E9_4a22_8D1F_A4CBCF5D362D EAID_E41A79F3_7D5D_4314_AA49_2610AFC92738 |
Virkningstid | DateTime | Dato som falder indenfor en virkningstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende virkningstid på denne dato udvælges. Datoformat følger ISO 8601 | NOW() | EAID_DB0ADB0B_AEF4_4c51_846D_D3404DC85449 EAID_06091801_5AC6_4262_825D_0B4C2FA3D57C |
Status | String | Status jf. grunddatamodellens udfaldsrum for EjerfortegnelsestatusVærdi | NULL | EAID_5DF93B9F_50AA_49aa_9481_F04517799FFF |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”EJF_3.14_personellervirksomhedsoplysning.json” indeholder output som JSON-schema | Skema - filudtræk og webservice (EJF) |
REST - EjerfortegnelsenFortrolig
Beskrivelse
Servicen udstiller Ejerfortegnelsens fortrolige oplysninger om ejere og administratorer af en Bestemt fast ejendom. Servicen kan anvende og returnere CPR-numre, men returnerer ikke beskyttede navne/adresser.
Adgangsniveau | Alle brugere skal anmode om adgang til servicen Alle brugere skal IP-whitelistes for at få adgang til tjenesten |
---|---|
SLA | Se registrets tilgængelighed på datafordeler.dk |
Metodeoversigt
Metodenavn | Kompleksitet | Tværgående tjeneste | Anvendt udstillingsmodel |
---|---|---|---|
EjendomsadministratorMedStamoplysninger | Kompleks | Ja | DAR, CPR, CVR |
EjendommeMedSammeEjer | Kompleks | Nej | - |
Ejendomsadministrator | Normal | Nej | - |
Ejerskab | Kompleks | Nej | - |
EjerskabMedStamoplysninger | Kompleks | Ja | DAR, CPR, CVR |
PersonVirksomhedsAdministrator | Kompleks | Nej | - |
PersonVirksomhedsAdministratorMedStamoplysninger | Kompleks | Ja | DAR, CPR, CVR |
SLA kategorier i produktion- maksimal svartid i sekunder:
- Simpel: 0.09
- Normal: 1.0
- Kompleks: 2.5
Metode - EjendomsadministratorMedStamoplysninger
Beskrivelse
Metoden henter oplysninger om en ejendomsadministrator til en Bestemt fast ejendom – med alle stamoplysninger (navn og adresse) fra hhv. Det Centrale Virksomhedsregister (CVR), Det Centrale Personregister (CPR) og Danmarks Adresseregister (DAR).
Bemærk at, eventuelle CPR-numre returneres, men beskyttede navne/adresser gør ikke.
Eksempel på url med certifikat
https://s5-certservices.datafordeler.dk/EJERFORTEGNELSE/EjerfortegnelsenFortrolig/1/rest/EjendomsadministratorMedStamoplysninger?BFEnr=xxxxxxx |
Inputparametre
Obligatoriske parametre: Enten BFE-nummer eller id for Ejerskab.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
BFEnr | String | Bestemt Fast Ejendom nummer | NULL | EAID_dst831A8A_9D17_463c_96AE_199F42DCA267 |
Virkningstid | DateTime | Dato som falder indenfor en virkningstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende virkningstid på denne dato udvælges | NOW() | EAID_DB0ADB0B_AEF4_4c51_846D_D3404DC85449 EAID_06091801_5AC6_4262_825D_0B4C2FA3D57C |
Status | String | Status jf. grunddatamodellens udfaldsrum for EjerfortegnelsestatusVærdi | NULL | EAID_5DF93B9F_50AA_49aa_9481_F04517799FFF |
Outputparametre
Typen af administrator afgør hvilke dele af outputskemaet, der vil være udfyldt. Hvis administratoren er en person, vil der for eksempel ikke være nogen virksomhed i output. Der vil således altid være præcis én type administrator i hver returnerede forekomst, hvis der er en administrator på ejendommen. Kaldes tjenesten uden status returneres både gældende samt historiske forekomster.
Der vises ikke adresseinformation for personer med adressebeskyttelse. For sådanne personer vil disse oplysninger således ikke eksistere i output for de enkelte administratorer.
Metode | Skema |
---|---|
Den inkluderede fil ”EJF_fortrolig_3.14_ejendomsadministratormedstamoplysninger.json” indeholder output som JSON-schema | Skema - filudtræk og webservices (EJF) |
Metode - EjendommeMedSammeEjer
Beskrivelse
Metoden udstiller Ejerfortegnelsens fortrolige oplysninger om ejendomme, som helt eller delvis har samme ejer.
Eksempel på url med certifikat
https://s5-certservices.datafordeler.dk/EJERFORTEGNELSE/EjerfortegnelsenFortrolig/1/rest/EjendommeMedSammeEjer?CPRnr=xxxxxxxxxx |
Inputparametre
Obligatoriske parametre: Enten CPR-nummer (CPRnr), CVR-nummer (CVRnr) eller person- eller virksomhedsoplysningsid (PVOId).
Det er ikke muligt, at angive flere end én af disse parametre eksempelvis for at få resultater med en person og en virksomhed samtidig. Angives mere end én vil der ikke returneres nogle resultater.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
CPRnr | String | Ejerens CPR nummer | NULL | EAID_dst232201_AC47_4eb1_B8E6_E5D6B6665D8F |
CVRnr | String | Ejerens CVR nummer | NULL | EAID_dst963D65_C08F_4bec_8AFF_BB9DC92B07FF |
PVOId | String | Id for den ejende person eller virksomhed, der ikke kan findes ved CVR eller CPR | NULL | EAID_dst976384_168B_431a_9C00_CC8D9097563E |
RegistreringstidFra | DateTime | Fra dato i registreringstidsperioden. Datoformat følger ISO 8601 | NULL | EAID_76A43210_69E9_4a22_8D1F_A4CBCF5D362D |
RegistreringstidTil | DateTime | Til dato i registreringstidsperioden. Datoformat følger ISO 8601 | NULL | EAID_E41A79F3_7D5D_4314_AA49_2610AFC92738 |
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. Datoformat følger ISO 8601 | NOW() | EAID_76A43210_69E9_4a22_8D1F_A4CBCF5D362D EAID_E41A79F3_7D5D_4314_AA49_2610AFC92738 |
VirkningstidFra | DateTime | Fra dato i virkningstidsperioden. Datoformat følger ISO 8601 | NULL | EAID_DB0ADB0B_AEF4_4c51_846D_D3404DC85449 |
VirkningstidTil | DateTime | Til dato i virkningstidsperioden. Datoformat følger ISO 8601 | NULL | EAID_06091801_5AC6_4262_825D_0B4C2FA3D57C |
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. Datoformat følger ISO 8601 | NOW() | EAID_DB0ADB0B_AEF4_4c51_846D_D3404DC85449 EAID_06091801_5AC6_4262_825D_0B4C2FA3D57C |
Status | String | Status jf. grunddatamodellens udfaldsrum for EjerfortegnelsestatusVærdi | NULL | EAID_5DF93B9F_50AA_49aa_9481_F04517799FFF |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”EJF_fortrolig_3.14_ejerskab2.json” indeholder output som JSON-schema | Skema - filudtræk og webservices (EJF) |
Metode - Ejendomsadministrator (version 1)
Beskrivelse
Metoden udstiller Ejerfortegnelsens oplysninger om en ejendomsadministrator til en Bestemt fast ejendom. Stamoplysninger for administratoren udstilles ikke via denne metode.
Eksempel på url med certifikat
https://s5-certservices.datafordeler.dk/EJERFORTEGNELSE/EjerfortegnelsenFortrolig/1/rest/Ejendomsadministrator?BFEnr=xxxxxxx |
Inputparametre
Obligatorisk parameter: BFE-nummer (BFEnr).
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
BFEnr | String | Bestemt Fast Ejendom nummer | NULL | EAID_dst831A8A_9D17_463c_96AE_199F42DCA267 |
RegistreringstidFra | DateTime | Fra dato i registreringstidsperioden. Datoformat følger ISO 8601 | NULL | EAID_76A43210_69E9_4a22_8D1F_A4CBCF5D362D |
RegistreringstidTil | DateTime | Til dato i registreringstidsperioden. Datoformat følger ISO 8601 | NULL | EAID_E41A79F3_7D5D_4314_AA49_2610AFC92738 |
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. Datoformat følger ISO 8601 | NOW() | EAID_76A43210_69E9_4a22_8D1F_A4CBCF5D362D EAID_E41A79F3_7D5D_4314_AA49_2610AFC92738 |
VirkningstidFra | DateTime | Fra dato i virkningstidsperioden. Datoformat følger ISO 8601 | NULL | EAID_DB0ADB0B_AEF4_4c51_846D_D3404DC85449 |
VirkningstidTil | DateTime | Til dato i virkningstidsperioden. Datoformat følger ISO 8601 | NULL | EAID_06091801_5AC6_4262_825D_0B4C2FA3D57C |
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. Datoformat følger ISO 8601 | NOW() | EAID_DB0ADB0B_AEF4_4c51_846D_D3404DC85449 EAID_06091801_5AC6_4262_825D_0B4C2FA3D57C |
Status | String | Status jf. grunddatamodellens udfaldsrum for EjerfortegnelsestatusVærdi | NULL | EAID_5DF93B9F_50AA_49aa_9481_F04517799FFF |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”EJF_fortrolig_3.14_ejendomsadministrator.json” indeholder output som JSON-schema | Skema - filudtræk og webservices (EJF) |
Metode - Ejendomsadministrator (version 2.0.0)
Beskrivelse
Metoden udstiller Ejerfortegnelsens oplysninger om en ejendomsadministrator til en Bestemt fast ejendom. Stamoplysninger for administratoren udstilles ikke via denne metode.
Eksempel på url med certifikat
https://s5-certservices.datafordeler.dk/EJERFORTEGNELSE/EjerfortegnelsenFortrolig/2.0.0/rest/Ejendomsadministrator?BFEnr=xxxxxxx |
Inputparametre
Obligatorisk parameter: Enten Bestemt Fast Ejendom nummer (BFEnr), CPR-nummer (CPRnr), CVR-nummer(CVRnr), Produktionsenhed nummer (Pnr) eller person- eller virksomhedsoplysningsid (PVId) skal være angivet - ellers fås ingen resultater.
Det er ikke muligt, at angive flere end én af disse parametre for at få resultater for eksempelvis en person og en virksomhed samtidig. Angives mere end én vil der ikke være nogle resultater.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
BFEnr | String | Bestemt Fast Ejendom nummer | NULL | EAID_dst831A8A_9D17_463c_96AE_199F42DCA267 |
CPRnr | String | CPR nummer | NULL | EAID_dstB18BF9_EAE1_4e5e_96C9_D2234E281C60 |
CVRnr | String | CVR nummer | NULL | EAID_dstE13914_9E08_4ed7_91EF_EFA5AAF5C774 |
Pnr | String | Produktionsenhed nummer | NULL | EAID_dstF6D55E_01CB_4674_A3B6_53F0B183CADE |
Pvid | String | Fiktiv PV LokalID | NULL | EAID_dstC85E12_E209_42f5_AFB3_0739EC4303D9 |
RegistreringstidFra | DateTime | Fra dato i registreringstidsperioden. Datoformat følger ISO 8601 | NULL | EAID_76A43210_69E9_4a22_8D1F_A4CBCF5D362D |
RegistreringstidTil | DateTime | Til dato i registreringstidsperioden. Datoformat følger ISO 8601 | NULL | EAID_E41A79F3_7D5D_4314_AA49_2610AFC92738 |
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. Datoformat følger ISO 8601 | NOW() | EAID_76A43210_69E9_4a22_8D1F_A4CBCF5D362D EAID_E41A79F3_7D5D_4314_AA49_2610AFC92738 |
VirkningstidFra | DateTime | Fra dato i virkningstidsperioden. Datoformat følger ISO 8601 | NULL | EAID_DB0ADB0B_AEF4_4c51_846D_D3404DC85449 |
VirkningstidTil | DateTime | Til dato i virkningstidsperioden. Datoformat følger ISO 8601 | NULL | EAID_06091801_5AC6_4262_825D_0B4C2FA3D57C |
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. Datoformat følger ISO 8601 | NOW() | EAID_DB0ADB0B_AEF4_4c51_846D_D3404DC85449 EAID_06091801_5AC6_4262_825D_0B4C2FA3D57C |
Status | String | Status jf. grunddatamodellens udfaldsrum for EjerfortegnelsestatusVærdi | NULL | EAID_5DF93B9F_50AA_49aa_9481_F04517799FFF |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”EJF_fortrolig_3.14_ejendomsadministrator.json” indeholder output som JSON-schema | Skema - filudtræk og webservices (EJF) |
Metode - Ejerskab
Beskrivelse
Metoden udstiller Ejerfortegnelsens ejeroplysninger til en given Bestemt fast ejendom – også kaldet Ejerskab. Stamoplysninger for ejere udstilles ikke via denne service.
Eksempel på url med certifikat
https://s5-certservices.datafordeler.dk/EJERFORTEGNELSE/EjerfortegnelsenFortrolig/1/rest/Ejerskab?BFEnr=xxxxxxx |
Inputparametre
Obligatoriske parametre: Enten BFE-nummer (BFEnr) eller ejerskabsid (Ejerskabsid).
Det er muligt at angive begge værdier, men det vil ikke være muligt at få resultater fra flere ejendomme ved at angive et ejerskabsid, som ikke er tilknyttet til den angivne ejendom.
I modsætning til EjerskabMedStamoplysninger er denne metode ikke tværgående. Output indeholder altså kun referencer til relationer, såsom lokalid for en ejende person.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
BFEnr | String | Bestemt Fast Ejendom nummer | NULL | EAID_dst911481_AA7A_425a_8B3D_DA1AE8630B36 |
Ejerskabsid | String | Lokal id for et ejerskab | NULL | EAID_42EEFD36_07DE_48e5_AF47_A3302D9EDEF5 EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5 |
RegistreringstidFra | DateTime | Fra dato i registreringstidsperioden. | NULL | EAID_76A43210_69E9_4a22_8D1F_A4CBCF5D362D |
RegistreringstidTil | DateTime | Til dato i registreringstidsperioden. | NULL | EAID_E41A79F3_7D5D_4314_AA49_2610AFC92738 |
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_76A43210_69E9_4a22_8D1F_A4CBCF5D362D EAID_E41A79F3_7D5D_4314_AA49_2610AFC92738 |
VirkningstidFra | DateTime | Fra dato i virkningstidsperioden. | NULL | EAID_DB0ADB0B_AEF4_4c51_846D_D3404DC85449 |
VirkningstidTil | DateTime | Til dato i virkningstidsperioden. | NULL | EAID_06091801_5AC6_4262_825D_0B4C2FA3D57C |
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_DB0ADB0B_AEF4_4c51_846D_D3404DC85449 EAID_06091801_5AC6_4262_825D_0B4C2FA3D57C |
Status | String | Status jf. grunddatamodellens udfaldsrum for EjerfortegnelsestatusVærdi | NULL | EAID_5DF93B9F_50AA_49aa_9481_F04517799FFF |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”EJF_fortrolig_3.14_ejerskab.json” indeholder output som JSON-schema | Skema - filudtræk og webservices (EJF) |
Metode - EjerskabMedStamoplysninger
Beskrivelse
Metoden henter ejeroplysninger til en given Bestemt fast ejendom – også kaldet Ejerskab – med alle stamoplysninger (ejendomsoplysninger, navn og adresse) fra hhv. Ejendomsbeliggenhedsregistret (EBR), Matriklen (MAT), Det Centrale Virksomhedsregister (CVR), Det Centrale Personregister (CPR) og Danmarks Adresseregister (DAR).
Bemærk at, eventuelle CPR-numre returneres, men beskyttede navne/adresser gør ikke.
Eksempel på url med certifikat
https://s5-certservices.datafordeler.dk/EJERFORTEGNELSE/EjerfortegnelsenFortrolig/1/rest/EjerskabMedStamoplysninger?BFEnr=xxxxxxx |
Inputparametre
Obligatoriske parametre: Enten BFE-nummer (BFEnr) eller ejerskabsid (Ejerskabsid).
Det er muligt at angive begge værdier, men det vil ikke være muligt at få resultater fra flere ejendomme, ved at angive et ejerskabsid, som ikke er tilknyttet til den angivne ejendom.
Det er ikke muligt, at angive BFE-nummer (BFEnr) og ejerskabsid (Ejerskabsid) samtidig og på den måde få resultater fra forskellige ejendomme. Angives begge parametre, vil det dog være muligt, at få et resultat, hvis det angivne ejerskabsid findes på et ejerskab på ejendommen med det angivne BFE-nummer.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
BFEnr | String | Bestemt Fast Ejendom nummer | NULL | EAID_dst911481_AA7A_425a_8B3D_DA1AE8630B36 |
Ejerskabsid | String | Lokal id for et ejerskab | NULL | EAID_42EEFD36_07DE_48e5_AF47_A3302D9EDEF5 EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5 |
Virkningstid | DateTime | Dato som falder indenfor en virkningstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende virkningstid på denne dato udvælges | NOW() | EAID_DB0ADB0B_AEF4_4c51_846D_D3404DC85449 EAID_06091801_5AC6_4262_825D_0B4C2FA3D57C |
Status | String | Status jf. grunddatamodellens udfaldsrum for EjerfortegnelsestatusVærdi | NULL | EAID_5DF93B9F_50AA_49aa_9481_F04517799FFF |
Outputparametre
Typen af ejer og tilstedeværelse og typen af administrator afgør hvilke dele af outputskemaet, der vil være udfyldt. Hvis ejeren er en person, vil der for eksempel ikke være nogen ejende virksomhed i output. Der vil således altid være præcis én type ejer og nul til én type administrator.
Kaldes tjenesten uden status returneres både gældende samt historiske forekomster.
Der vises ikke adresseinformation for personer med adressebeskyttelse. For sådanne personer vil disse oplysninger ikke eksistere i output for de enkelte ejere/administratorer.
Metode | Skema |
---|---|
Den inkluderede fil ”EJF_fortrolig_3.14_ejerskabmedstamoplysninger.json” indeholder output som JSON-schema | Skema - filudtræk og webservices (EJF) |
Metode - PersonVirksomhedsAdministrator
Beskrivelse
Metoden udstiller oplysninger om en Person/Virksomhed administrator til en person eller virksomhed. Stamoplysninger for administratoren udstilles ikke via denne metode.
https://s5-certservices.datafordeler.dk/EJERFORTEGNELSE/EjerfortegnelsenFortrolig/1/rest/PersonVirksomhedsAdministrator?CPRnr=xxxxxxxxxx |
Inputparametre
Obligatoriske parametre: Enten CPR-nummer (CPRnr), CVR-nummer(CVRnr) eller person- eller virksomhedsoplysningsid (PVOId).
Det er ikke muligt, at angive flere end én af disse parametre for at få resultater eksempelvis en administrerende person og en administrerende virksomhed samtidig. Angives mere end én vil der ikke returneres nogle resultater.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
CPRnr | String | Den administrerede persons CPR nummer | NULL | EAID_dst0F15B8_03C8_430a_86D6_6AE6BDC5D97D |
CVRnr | String | Den administrerede virksomheds CVR nummer | NULL | EAID_dst49808D_BE67_47bb_8C51_ED19142A62E3 |
PVOId | String | Id for den administrerede person eller virksomhed, der ikke kan findes ved CVR eller CPR | NULL | EAID_dstD29BA9_BA2B_4328_AE3A_417B3FC87C29 |
RegistreringstidFra | DateTime | Fra dato i registreringstidsperioden. | NULL | EAID_76A43210_69E9_4a22_8D1F_A4CBCF5D362D |
RegistreringstidTil | DateTime | Til dato i registreringstidsperioden. | NULL | EAID_E41A79F3_7D5D_4314_AA49_2610AFC92738 |
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_76A43210_69E9_4a22_8D1F_A4CBCF5D362D EAID_E41A79F3_7D5D_4314_AA49_2610AFC92738 |
VirkningstidFra | DateTime | Fra dato i virkningstidsperioden. | NULL | EAID_DB0ADB0B_AEF4_4c51_846D_D3404DC85449 |
VirkningstidTil | DateTime | Til dato i virkningstidsperioden. Datoformat følger ISO 8601 | NULL | EAID_06091801_5AC6_4262_825D_0B4C2FA3D57C |
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. Datoformat følger ISO 8601 | NOW() | EAID_DB0ADB0B_AEF4_4c51_846D_D3404DC85449 EAID_06091801_5AC6_4262_825D_0B4C2FA3D57C |
Status | String | Status jf. grunddatamodellens udfaldsrum for EjerfortegnelsestatusVærdi | NULL | EAID_5DF93B9F_50AA_49aa_9481_F04517799FFF |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil "EJF_fortrolig_3.14_personellervirksomhedsadministrator.json” indeholder output som JSON-schema | Skema - filudtræk og webservices (EJF) |
Metode - PersonVirksomhedsAdministratorMedStamoplysninger
Beskrivelse
Metoden henter oplysninger om en Person/Virksomhed administrator til en person eller virksomhed – med alle stamoplysninger (navn og adresse) fra hhv. Det Centrale Virksomhedsregister (CVR), Det Centrale Personregister (CPR) og Danmarks Adresseregister (DAR).
Eksempel på url med certifikat
https://s5-certservices.datafordeler.dk/EJERFORTEGNELSE/EjerfortegnelsenFortrolig/1/rest/PersonVirksomhedsAdministratorMedStamoplysninger?CPRnr=xxxxxxxxxx |
Inputparametre
Obligatoriske parametre: Enten CPR-nummer (CPRnr), CVR-nummer(CVRnr) eller person- eller virksomhedsoplysningsid (PVOId) for den administrerede.
Det er ikke muligt, at angive flere end én af disse parametre for at få resultater for eksempelvis en administreret person og en administreret virksomhed samtidig. Angives mere end én vil der ikke være nogle resultater.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
CPRnr | String | Den administrede persons CPR nummer | NULL | EAID_dst0F15B8_03C8_430a_86D6_6AE6BDC5D97D |
CVRnr | String | Den administrede virksomheds CVR nummer | NULL | EAID_dst49808D_BE67_47bb_8C51_ED19142A62E3 |
PVOId | String | Id for den administrerede person eller virksomhed, der ikke kan findes ved CVR eller CPR | NULL | EAID_dstD29BA9_BA2B_4328_AE3A_417B3FC87C29 |
Virkningstid | DateTime | Dato som falder indenfor en virkningstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende virkningstid på denne dato udvælges | NOW() | EAID_DB0ADB0B_AEF4_4c51_846D_D3404DC85449 EAID_06091801_5AC6_4262_825D_0B4C2FA3D57C |
Status | String | Status jf. grunddatamodellens udfaldsrum for EjerfortegnelsestatusVærdi | NULL | EAID_5DF93B9F_50AA_49aa_9481_F04517799FFF |
Outputparametre
Der vises ikke adresseinformation for personer med adressebeskyttelse. For sådanne personer vil disse oplysninger således ikke eksistere i output for de enkelte administratorer.
Kaldes tjenesten uden status returneres både gældende samt historiske forekomster.
Metode | Skema |
---|---|
Den inkluderede fil ”EJF_fortrolig_3.14_personellervirksomhedsadministratormedstamoplysninger.json” indeholder output som JSON-schema | Skema - filudtræk og webservices (EJF) |
REST - EjerfortegnelsenFortroligBeskyttet
Beskrivelse
Fremsøgning af potentielt fortrolige og beskyttede ejer- og administratoroplysninger ift. en Bestemt fast ejendom.
Servicen kan anvende og returnere CPR-numre samt beskyttede navne/adresser.
Adgangsniveau | Alle brugere skal anmode om adgang til servicen Alle brugere skal IP-whitelistes for at få adgang til tjenesten |
---|---|
SLA | Se registrets tilgængelighed på datafordeler.dk |
Metodeoversigt
Metodenavn | SLA | Tværgående tjeneste | Anvendt udstillingsmodel |
---|---|---|---|
EjerskabMedStamoplysninger | Kompleks | Ja | DAR, CPR, CVR |
EjendomsadministratorMedStamoplysninger | Kompleks | Ja | DAR, CPR, CVR |
PersonVirksomhedsAdministratorMedStamoplysninger | Kompleks | Ja | DAR, CPR, CVR |
SLA kategorier i produktion- maksimal svartid i sekunder:
- Simpel: 0.09
- Normal: 1.0
- Kompleks: 2.5
Metode - EjendomsadministratorMedStamoplysninger
Beskrivelse
Metoden henter oplysninger om en ejendomsadministrator til en Bestemt fast ejendom – med alle stamoplysninger (navn og adresse) fra hhv. Det Centrale Virksomhedsregister (CVR), Det Centrale Personregister (CPR) og Danmarks Adresseregister (DAR).
For servicen ”EjerfortegnelsenFortroligBeskyttet” generelt gælder, at eventuelle CPR-numre og beskyttede navne/adresser returneres.
Eksempel på url med certifikat
https://s5-certservices.datafordeler.dk/EJERFORTEGNELSE/EjerfortegnelsenFortroligBeskyttet/1/rest/EjendomsadministratorMedStamoplysninger?BFEnr=xxxxxxx |
Inputparametre
Obligatoriske parametre: BFE-nummer (BFEnr).
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
BFEnr | String | Bestemt Fast Ejendom nummer | NULL | EAID_dst831A8A_9D17_463c_96AE_199F42DCA267 |
Virkningstid | DateTime | Dato som falder indenfor en virkningstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende virkningstid på denne dato udvælges | NOW() | EAID_DB0ADB0B_AEF4_4c51_846D_D3404DC85449 EAID_06091801_5AC6_4262_825D_0B4C2FA3D57C |
Status | String | Status jf. grunddatamodellens udfaldsrum for EjerfortegnelsestatusVærdi | NULL | EAID_5DF93B9F_50AA_49aa_9481_F04517799FFF |
Outputparametre
Typen af administrator afgør hvilke dele af outputskemaet, der vil være udfyldt. Hvis administratoren er en person, vil der for eksempel ikke være nogen virksomhed i output. Der vil således altid være præcis én type administrator i hver returnerede forekomst, hvis der findes en administrator på ejendommen.
Kaldes tjenesten uden status returneres både gældende samt historiske forekomster.
Metode | Skema |
---|---|
Den inkluderede fil ”EJF_fortroligbeskyttet_3.14_ejendomsadministratormedstamoplysninger.json” indeholder output som JSON-schema | Skema - filudtræk og webservices (EJF) |
Metode - EjerskabMedStamoplysninger
Beskrivelse
Metoden henter ejeroplysninger til en given Bestemt fast ejendom – også kaldet Ejerskab – med alle stamoplysninger (ejendomsoplysninger, navn og adresse) fra hhv. Ejendomsbeliggenhedsregistret (EBR), Matriklen (MAT), Det Centrale Virksomhedsregister (CVR), Det Centrale Personregister (CPR) og Danmarks Adresseregister (DAR).
For servicen ”EjerfortegnelsenFortroligBeskyttet” generelt gælder, at eventuelle CPR-numre og beskyttede navne/adresser returneres.
Eksempel på url med certifikat
https://s5-certservices.datafordeler.dk/EJERFORTEGNELSE/EjerfortegnelsenFortroligBeskyttet/1/rest/EjerskabMedStamoplysninger?BFEnr=xxxxxxx |
Inputparametre
Obligatoriske parametre: Enten BFE-nummer (BFEnr) eller ejerskabsid (Ejerskabsid).
Det er muligt at angive begge værdier, men det vil ikke være muligt at få resultater fra flere ejendomme, ved at angive et ejerskabsid, som ikke er tilknyttet til den angivne ejendom.
Det er ikke muligt, at angive BFE-nummer (BFEnr) og ejerskabsid (Ejerskabsid) samtidig og på den måde få resultater fra forskellige ejendomme. Angives begge parametre, vil det dog være muligt, at få et resultat, hvis det angivne ejerskabsid findes på et ejerskab på ejendommen med det angivne BFE-nummer.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
BFEnr | String | Bestemt Fast Ejendom nummer | NULL | EAID_dst911481_AA7A_425a_8B3D_DA1AE8630B36 |
Ejerskabsid | String | Lokal id for et ejerskab | NULL | EAID_42EEFD36_07DE_48e5_AF47_A3302D9EDEF5 EAID_9AB90AE0_9F85_4164_9B25_8EB2139D65A5 |
Virkningstid | DateTime | Dato som falder indenfor en virkningstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende virkningstid på denne dato udvælges | NOW() | EAID_DB0ADB0B_AEF4_4c51_846D_D3404DC85449 EAID_06091801_5AC6_4262_825D_0B4C2FA3D57C |
Status | String | Status jf. grunddatamodellens udfaldsrum for EjerfortegnelsestatusVærdi | NULL | EAID_5DF93B9F_50AA_49aa_9481_F04517799FFF |
Outputparametre
Typen af ejer og tilstedeværelse og typen af administrator afgør hvilke dele af outputskemaet, der vil være udfyldt. Hvis ejeren er en person, vil der for eksempel ikke være nogen ejende virksomhed i output. Der vil således altid være præcis én type ejer og nul til én type administrator.
Kaldes tjenesten uden status returneres både gældende samt historiske forekomster.
Metode | Skema |
---|---|
Den inkluderede fil ”EJF_fortroligbeskyttet_3.14_ejerskabmedstamoplysninger.json” indeholder output som JSON-schema Bemærk, at denne tjeneste har samme skema, som tjenesten EjerfortegnelsenFortrolig/EjerskabMedStamoplysninger og at skemaet er udstillet under de fortrolige tjenester i DLS'en. | Skema - filudtræk og webservices (EJF) |
Metode - PersonVirksomhedsAdministratorMedStamoplysninger
Beskrivelse
Metoden henter oplysninger om en Person/Virksomhed administrator til en person eller virksomhed – med alle stamoplysninger (navn og adresse) fra hhv. Det Centrale Virksomhedsregister (CVR), Det Centrale Personregister (CPR) og Danmarks Adresseregister (DAR).
For servicen ”EjerfortegnelsenFortroligBeskyttet” generelt gælder, at eventuelle CPR-numre og beskyttede navne/adresser returneres.
Eksempel på url med certifikat
https://s5-certservices.datafordeler.dk/EJERFORTEGNELSE/EjerfortegnelsenFortroligBeskyttet/1/rest/PersonVirksomhedsAdministratorMedStamoplysninger?CPRnr=xxxxxxxxxx |
Inputparametre
Obligatoriske parametre: Enten CPR-nummer (CPRnr), CVR-nummer(CVRnr) eller person- eller virksomhedsoplysningsid (PVOId) for den administrerede.
Det er ikke muligt, at angive flere end én af disse parametre for at få resultater for eksempelvis en administreret person og en administreret virksomhed samtidig. Angives mere end én vil der ikke være nogle resultater.
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
CPRnr | String | Den administrede persons CPR nummer | NULL | EAID_dst0F15B8_03C8_430a_86D6_6AE6BDC5D97D |
CVRnr | String | Den administrede virksomheds CVR nummer | NULL | EAID_dst49808D_BE67_47bb_8C51_ED19142A62E3 |
PVOId | String | Id for den administrerede person eller virksomhed, der ikke kan findes ved CVR eller CPR | NULL | EAID_dstD29BA9_BA2B_4328_AE3A_417B3FC87C29 |
Virkningstid | DateTime | Dato som falder indenfor en virkningstidsperiode. Anvendes fx 2015-09-02 vil de instanser med en gældende virkningstid på denne dato udvælges | NOW() | EAID_DB0ADB0B_AEF4_4c51_846D_D3404DC85449 EAID_06091801_5AC6_4262_825D_0B4C2FA3D57C |
Status | String | Status jf. grunddatamodellens udfaldsrum for EjerfortegnelsestatusVærdi | NULL | EAID_5DF93B9F_50AA_49aa_9481_F04517799FFF |
Outputparametre
Der vises ikke adresseinformation for personer med adressebeskyttelse. For sådanne personer vil disse oplysninger således ikke eksistere i output for de enkelte administratorer.
Kaldes tjenesten uden status returneres både gældende samt historiske forekomster.
Metode | Skema |
---|---|
Den inkluderede fil ”EJF_fortroligbeskyttet_3.14_personellervirksomhedsadministratormedstamoplysninger.json” indeholder output som JSON-schema | Skema - filudtræk og webservices (EJF) |