tilbage

REST API version 2

Indledning

DIA Formular API v2 bruges af Blanketmotoren og andre leverandører til at oprette, redigere og slette statslige formularvarianter.

Rettigheder

Alle ressourcer under /dia/2 kræver at CVR nummer fra det certifikat man kalder med er det samme som det som er angivet som {leverandør-cvr} paramter, med mindre at man har fået tildelt rettighed af Erhvervsstyrelsen til at man kan angive en {leverandør-cvr} paramter som ikke matcher det CVR nummer fra det certifikat man kalder med. Denne rettighed giver jer ret til at agerer 'på vegne af' en anden leverandør.

URL

Resourcen formular tilgås vha flg. url

   https://api.virk.dk/dia/2/formular

Den relative sti /dia/2/ indikerer at det er version 2 af api'en der tilgås.

HTTP Metoder

HTTP Metode Url Beskrivelse
GET /dia/2/formular/{leverandør-cvr} Hent en liste af formularer
GET /dia/2/formular/{leverandør-cvr}/{EGET-ID} Hent en formular
PUT /dia/2/formular/{leverandør-cvr}/{EGET-ID} Opret / Opdater en formular.
DELETE /dia/2/formular/{leverandør-cvr}/{EGET-ID} Slettemarker en formular.

GET: Hent en liste af formularer

URL

https://api.virk.dk/dia/2/formular/{leverandør-cvr}

Beskrivelse

Henter en liste af formularer som, er leveret af den angivne leverandør.

Felter

JSON felt Type Beskrivelse Øvrige kommentarer
titel Tekst Titel
diaId Tekst DIA id, bliver genereret automatisk af DIA
egetId Tekst Leverandørens eget id, for denne formular
path Tekst relativ url, til formularen

Eksempel

$ curl -H 'Content-Type: application/json' https://api.virk.dk/dia/2/formular/61966617

Eksempel på JSON response

[
    {
    "titel": "Ansøgning om/bevilling af tilskud til mentorfunktion",
    "diaId": "5344.1",
    "egetId": "kb7921ff",
    "path": "/dia/2/formular/61966617/kb7921ff"
    },
    {
    "titel": "Send erklæring om indhentelse af børneattest",
    "diaId": "30233.1",
    "egetId": "kb7741ff",
    "path": "/dia/2/formular/61966617/kb7741ff"
    }
]

GET: Hent en formular

URL

https://api.virk.dk/dia/2/formular

Beskrivelse

Felter

Feltnavn (GUI) Felt (JSON) Type Null? Beskrivelse
Dia ID diaId Tekst DIAs interne ID for formularen (read-only felt)
Valgte myndigheder udstillere Tekst Nej Myndighed(erne) der udstiller denne formular, angivet ved forkortelse. Flere myndigheder angives på en liste, adskilt af komma, f.eks. : "ERST, BANE". Bemærk: statslige formularer skal kun have 1 udstiller.
Titel titel Tekst[255] Nej Den titel, som kommer til at stå på Virk.dk’s introside for indberetningsløsningen.
Kort beskrivelse kortBeskrivelse Tekst[200] Ja Denne beskrivelse præsenteres på introsiden for en specifik løsning (efter valg af kommune). Der er ingen validering; dog må der ikke indsættes javascript.
Beskrivelse beskrivelse Tekst[?] Ja Denne beskrivelse præsenteres på introsiden for en specifik løsning
Hav følgende parat forudsaetninger ”longtext” Ja Ingen validering.
Trin trin ”longtext” Ja Ingen validering (dog ingen java-script).
Kontaktinformation kontaktInformation Tekst Ja Ingen validering
Url til lovstof urlTilLovstof List Ja En liste af maps med 'titel' og 'url' elementer, f.eks. "urlTilLovstof": [{ "titel": "Yahoo!", "url": "http://www.yahoo.com" }, { "titel": "Google", "url": "http://www.google.com" }]
Url til vejledning urlTilVejledning URL Ja
Skabelon skabelon ”integer” Ja Mulige værdier: TBD… (Dette skal afklares i samarbejde med projekt ”Ny brugergrænseflade” i Erhvervsstyrelsen.)
Fritekst 1 fritekst1 ”longtext” Ja Ingen validering.
Fritekst 2 fritekst2 ”longtext” Ja Ingen validering.
Fritekst 3 fritekst3 ”longtext” Ja Ingen validering.
Ekstra supportinformation hjaelp ”longtext” Ja Ingen validering (dog ingen java-script).
Integrationsteknik formularType Tekst[15] Nej Mulige værdier: "aktiv-top", "integration-iframe-916", "integration-iframe-960-med-titel", "integration-iframe-960-uden-titel", "integration-frameset-med-titel", "integration-frameset-uden-titel", "integration-ekstern-link"
AktivTop JavaScript som skal bruges af løsningen aktivTopIntegrationsform Tekst ja Mulige værdier: "default", "module"
Url til løsning, test urlTest Tekst[500] Ja Indholdet url-valideres.
Url til løsning, prod urlProd Tekst[500] Ja Indholdet url-valideres.
Krav til login med SSO kraeverSSO Boolean Ja Default er FALSE.
Login url til EIDAS (privatperson), test eidPersonLinkTest Tekst[500] Ja Ingen validering
Login url til EIDAS (privatperson), prod eidPersonLinkProd Tekst[500] Ja Ingen validering
Login url til EIDAS (medarbejder), test eidVirksomhedLinkTest Tekst[500] Ja Ingen validering
Login url til EIDAS (medarbejder), prod eidVirksomhedLinkProd Tekst[500] Ja Ingen validering
Login til SSI, test ssiLinkTest Tekst[500] Ja Ingen validering
Login til SSI, prod ssiLinkProd Tekst[500] Ja Ingen validering
Ny startknaptekst startKnapTekst ”longtext” Ja Ingen validering (dog ingen java-script).
Brugerdefineret javascript brugerdefineretJavascript ”longtext” Ja Ingen validering.
Forslag til søgeord forslagTilSoegeord Tekst Ja Virk-redaktionen har ejerskab til feltet søgeord. Myndigheder og løsningsleverandører (og med denne grænseflade også KL) kan foreslå søgeord, som redaktionen kan vælge at tage med. Indholdet af dette felt i grænsefladen publiceres således ikke umiddelbart. De enkelte søgeord adskilles med komma. Der er ingen validering.
Publiceringsdato publiceringsdato Datetime Ja Formularvarianter, der oprettes efter overførsel af en publiceringsdato fra KL, vil få indsat denne publiceringsdato som default. Kan overskrives af løsningsleverandøren og virk-redaktionen.
Afpubliceringsdato afpubliceringsdato Datetime Ja Kopieres til formularvarianter. Afpublicering af alle underliggende formularvarianter forceres derved til den pågældende dato.
Form opgavenøgler formOpgaveNoegler Tekst Ja Dette felt publiceres ikke, men indgår i afrapportering og beregning af forskellige digitale nøgletal, herunder digitaliseringsgrad
Løsningsmetode loesningsmetode Tekst Ja Do.
Årlige Blanketter aarligeBlanketter Integer Ja Do.
Årlige Digitale Løsninger aarligeDigitaleLoesninger Integer Ja Do.
Årlige Digitale Løsninger Integreret På Virk aarligeDigitaleLoesningerIntegreretPaaVirk Integer Ja Do.
Årlige System Til System aarligeSystemTilSystem Integer Ja Do.
Myndighedens interne kommentarfelt internKommentar Tekst Ja Do.
Obligatorisk Digital obligatoriskDigital Boolean Ja Oplysninger i dette felt og de efterfølgende fire felter bliver brugt til afrapportering til regeringens økonomiudvalg.
Forventet obligatorisk digital forventetDigital Integer Nej Det angivne heltal [1..7] omsættes til en tekst efter følgende liste:
  1. Ikke besluttet
  2. Er sket
  3. 2014 – Første halvår
  4. 2014 – Andet halvår
  5. 2015 – Første halvår
  6. 2015 – Andet halvår
  7. Senere
Forventet idriftsat forventetIdriftSat Integer Nej Do.
Forventet tilgængelig på Virk.dk forventetTilgaengelig Integer Nej Do.
Forventet integreret på Virk.dk forventetIntegreret Integer Nej Do.

Eksempel

$ curl https://api.virk.dk/dia/2/formular/61966617/kb7921ff

Eksempel på JSON response

{
  "diaId": "30351.1",
  "titel": "Ansøgning om/bevilling af tilskud til mentorfunktion",
  "kortBeskrivelse": "Virksomheden anvender indberetningen, når de vil ansøge om tilskud til mentorfunktion.",
  "beskrivelse": null,
  "forudsaetninger": null,
  "trin": null,
  "kontaktInformation": null,
  "urlTilLovstof": null,
  "utlTilVejledning": null,
  "skabelon": "integration-frameset-med-titel",
  "fritekst1": null,
  "fritekst2": null,
  "fritekst3": null,
  "hjaelp": null,
  "formularType": "integration-frameset-med-titel",
  "urlTest": "https://www.borgeronline.dk/Default.aspx?municipalityId={kommunekode}&groupId=34&formId=kb7921ff",
  "urlProd": "https://www.borgeronline.dk/Default.aspx?municipalityId={kommunekode}&groupId=34&formId=kb7921ff",
  "kraeverSSO": false,
  "eidPersonLinkProd": null,
  "eidVirksomhedLinkProd": null,
  "ssiLinkProd": null,
  "eidPersonLinkTest": null,
  "eidVirksomhedLinkTest": null,
  "ssiLinkTest": null,
  "startKnapTekst": null,
  "brugerdefineretJavascript": null,
  "forslagTilSoegeord": null,
  "alternativeTitler": null,
  "publiceringsdato": null,
  "afpubliceringsdato": null,
  "formOpgaveNoegler": null,
  "loesningsmetode": "Digital",
  "aarligeBlanketter": 0,
  "aarligeDigitaleLoesninger": 0,
  "aarligeDigitaleLoesningerIntegreretPaaVirk": 0,
  "aarligeSystemTilSystem": 0,
  "internKommentar": null,
  "obligatoriskDigital": false,
  "forventetDigital": "Ikke besluttet",
  "forventetIdriftsat": "Er sket",
  "forventetTilgaengelig": "Er sket",
  "forventetIntegreret": "Ikke besluttet",
  "udstillere": "ERST"
}

PUT: Opret eller Opdater en formular

URL

https://api.virk.dk/dia/2/formular/{leverandør-cvr}/{eget-id}

Felter

PUT anvender de samme felter, som GET.

Eksempel

$ curl -X PUT -H 'Content-Type: application/json' \
    -d '{ "titel": "Test titel" }'
  https://api.virk.dk/dia/2/formular/61966617/kb7921ff

Eksempel på JSON response

{
    "status": "Created",
    "code": 201,
    "message": "Formular med DIA ID '30531' blev opdateret.",
    "diaId": "30531"
}

DELETE: Slet en formular

URL

https://api.virk.dk/dia/2/formular/{leverandør-cvr}/{eget-id}

Beskrivelse

Slettemarkerer en formularvariant. Formularvarianten bliver ikke slettet fysisk.

Eksempel

$ curl -X DELETE https://api.virk.dk/dia/2/formular/61966617/kb7921ff

Eksempel på JSON response

{
    "status": "OK",
    "code": 200,
    "message": "Formular med egetId 'kb7921ff' blev slettet."
}