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 Skatteforvaltningens Virksomhedsregister (SVR).
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 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 | https://s5-certservices.datafordeler.dk/SVR/HentSVRdata/1/rest/SEtilhoerendeCVR?cvr=xxxxxxxx |
Generelt for SVR webservices
Registernavn i Selvbetjeningen | SVR |
---|---|
Format | XML/JSON |
DLS version | 1.0709 |
Sikkerhedszone | 5 - Indeholder fortrolige eller følsomme data |
Adgangsniveau | Godkendt bruger Alle brugere skal anmode om adgang til servicen Alle brugere skal IP-whitelistes for at få adgang til 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. 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 - HentSVRdata
Anvendt udstillingsmodel | Skatteforvaltningens Virksomhedsregister |
---|---|
SLA | Se registrets tilgængelighed på Datafordeler.dk |
Metodeoversigt
Metode | SLA kategori | Tværgående tjeneste |
---|---|---|
SEtilhoerendeCVR | Simpel | Nej |
CVRtilhoerendeSE | Simpel | Nej |
HentSVRdataforSEnr | Simpel | Nej |
SLA kategorier i produktion- maksimal svartid i sekunder:
- Simpel: 0.09
- Normal: 1.0
- Kompleks: 2.5
Metode - SEtilhoerendeCVR
Beskrivelse
Liste af SE-numre som er tilknyttet det angivne CVR-nummer. For VirksomhedType = 1 (SkatteforvatningJuridiskEnhed) returneres ét SEnummer, for VirksomhedType = 2 returneres flere SEnumre (administrativEnhed) og for VirksomhedType = 3 (ikkeCVRenhed) returneres tom liste.
Url
https://s5-certservices.datafordeler.dk/SVR/HentSVRdata/1/rest/SEtilhoerendeCVR?cvr=xxxxxxxx |
Inputparametre
Obligatorisk parameter: cvr
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
cvr | integer | CVR-nummer for en virksomhed | EAID_33FF83AB_D70B_42de_9F54_133544C60BDB | |
histdato | date | Dato hvor oplysningerne var i virkning | NOW() |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”SEtilhoerendeCVR.json” | Skema - filudtræk og webservices (SVR) |
Metode - CVRtilhoerendeSE
Beskrivelse
CVR-nummer som det angivne SE-nummer er tilknyttet. For VirksomhedType = 1 og 2 (SkatteforvatningJuridiskEnhed) returneres ét CVRnummer og for VirksomhedType = 3 (ikkeCVRenhed) returneres null.
Url
https://s5-certservices.datafordeler.dk/SVR/HentSVRdata/1/rest/CVRtilhoerendeSE?se=xxxxxxxx |
Inputparametre
Obligatorisk parameter: se
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
se | integer | SE-nummer for en virksomhed | EAID_B464A51D_B297_49fc_80BE_340C31A8D5C5 | |
histdato | date | Dato hvor oplysningerne var i virkning | NOW() |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”CVRtilhoerendeSE.json” | Skema - filudtræk og webservices (SVR) |
Metode - HentSVRdataforSEnr
Beskrivelse
Alle oplysninger (se udstillingsmodel) for det angivne SE-nummer. For VirksomhedType = 1 (SkatteforvaltningJuridiskEnhed) leveres kun de data, som ikke findes i CVR.
Url
https://s5-certservices.datafordeler.dk/SVR/HentSVRdata/1/rest/HentSVRdataforSEnr?se=xxxxxxxx |
Inputparametre
Obligatorisk parameter: se
Navn | Type | Beskrivelse | Default værdi | UUID fra udstillingsmodel |
---|---|---|---|---|
se | integer | SE-nummer for en virksomhed | EAID_B464A51D_B297_49fc_80BE_340C31A8D5C5 | |
histdato | date | Dato hvor oplysningerne var i virkning | NOW() |
Outputparametre
Metode | Skema |
---|---|
Den inkluderede fil ”HentSVRdataforSEnr.json” | Skema - filudtræk og webservices (SVR) |