tilbage

REST API version 1

Indledning

DIA Formular API bruges af Indholdsleverandører og myndigheder til at hente, oprette, redigere og slette formularvarianter.

URL

Resourcen formular master tilgås vha flg. url

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

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

Bemærk: GET metoden er ikke implementeret pt.

HTTP Metoder

HTTP Metode Url Beskrivelse
GET /dia/1/formular/{DIA-ID} Hent en eksisterende formularvariant
POST /dia/1/formular Opret en ny formularvariant
PUT /dia/1/formular/{EGET-ID} Opdater en formularvariant. Formularvarianten tilgås med en selvvalgt nøgle.
DELETE /dia/1/formular/{EGET-ID} Slet en formular master. Ved sletning bliver varianten slettemarkeret, og afpubliceret. Den slettes ikke fysisk. Formular masteren tilgås med en selvvalgt nøgle.

Get: Hent en eksisterende formularvariant

URL

https://api.virk.dk/dia/1/formular/{dia-id}

Beskrivelse

Felter

Eksempel

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

Eksempel på JSON response

{
  "diaId": "30272.1",
  "name": "Anmeld jordflytning",
  "afpubliceretPaaProduktion": false,
  "publiceretPaaProduktion": true,
  "publiceringsdato": "2015-12-14T12:59:00+0100",
  "formulartype": "integration-frameset-med-titel",
  "leverandoer": "Dafolo",
  "loesningsmetode": "Digital løsning",
  "permalink": "Anmeld_jordflytning",
  "udstillere": [
    {
      "myndighedsid": "870",
      "myndighedsforkortelse": "Ringkoebing-Skjern",
      "myndighedsnavn": "Ringkøbing-Skjern Kommune",
      "cvr": "29189609",
      "myndighedstype": "kommune",
      "kommunekode": "760",
      "formUrl": "https://indberet.virk.dk/myndigheder/kommuner/Ringkoebing-Skjern/Anmeld_jordflytning",
      "kraeverSSO": true,
      "loesningsUrl": "https://indberet.virk.dk/nemlogin/login?f=/integration/Ringkoebing-Skjern/Anmeld_jordflytning"
    },
    {
      "myndighedsid": "897",
      "myndighedsforkortelse": "Aeroe",
      "myndighedsnavn": "Ærø Kommune",
      "cvr": "28856075",
      "myndighedstype": "kommune",
      "kommunekode": "492",
      "formUrl": "https://indberet.virk.dk/myndigheder/kommuner/Aeroe/Anmeld_jordflytning",
      "kraeverSSO": true,
      "loesningsUrl": "https://indberet.virk.dk/nemlogin/login?f=/integration/Aeroe/Anmeld_jordflytning"
    }
  ]
}

POST: Opret en ny formular

URL

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

Beskrivelse

Felter

Feltnavn (GUI) Felt (JSON) Type Null? Beskrivelse Øvrige kommentarer
Master ID masterId Ja Sammen med Create skal det angives, hvilken formularmaster, som varianten skal knyttes til. Ved Update og Delete er det tilstrækkeligt at referere til Eget ID.
Eget ID egetId Tekst[40] Nej Entydig reference (primærnøgle) for den enkelte formular mellem løsningsleverandørens system til metadata og DIA. Hvis der sendes en ændring eller sletning til et Eget ID, som DIA ikke kender, returneres en fejl.
Titel titel Tekst[255] Nej Den titel, som kommer til at stå på Virk.dk’s introside for indberetningsløsningen. Før publicering første gang vil titlen også generere url’en til introsiden.
KL-default med ISA-mulighed for overtrumfning.
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. KL-default med ISA-mulighed for overtrumfning.
Beskrivelse beskrivelse Tekst[?] Ja Denne beskrivelse præsenteres på introsiden for en specifik løsning (efter valg af kommune). Der er ingen validering. Håndtering?  KL-default med ISA-mulighed for overtrumfning.
Valgte myndigheder valgteMyndigheder Liste Nej Liste af kommunenumre. Integer/Tekst[2]/Tekst[3]?. Numrene omsættes af DIA til den interne nøgle for den pågældende kommune. Hvis Valgte myndigheder ikke er med i dataoverførslen, så ændres feltet ikke, jf ovenfor. Hvis Valgte myndigheder indgår i dataoverførslen, så oprettes nye relationer til kommuner, og eventuelt eksisterende relationer slettes, hvis kommunen ikke er nævnt i listen.
Hav følgende parat forudsaetninger ”longtext” Ja Ingen validering. KL-default med ISA-mulighed for overtrumfning.
Trin trin ”longtext” Ja Ingen validering (dog ingen java-script). Hver linje udgør et punkt i en punktliste.
KL-default med ISA-mulighed for overtrumfning.
Url til lovstof urlTilLovstof Ja KL-default med ISA-mulighed for overtrumfning.
Url til vejledning urlTilVejledning Ja KL-default med ISA-mulighed for overtrumfning.
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:
  • "integration-iframe-gl"
  • "integration-iframe-med-titel"
  • "integration-iframe-uden-titel"
  • "integration-frameset-med-titel"
  • "integration-frameset-uden-titel"
  • "integration-ekstern-link
  • 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.
    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.

    Eksempel

    $ curl -X POST -H 'Content-Type: application/json' \
        -d '{"masterId": "30009", \
             "egetId": "456", \
             "titel": "Test titel"}' \
      http://api.virk.dk/dia/1/formular
    

    Eksempel på JSON response

    {
        "status": "Created",
        "code": 201,
        "message": "Formular med DIA ID '1234' blev oprettet."
    }
    

    PUT: Opdater en formular

    URL

    https://api.virk.dk/dia/1/formular/{eget-id}
    

    Felter

    PUT bruger de samme felter, som POST.

    $ curl -X PUT -H 'Content-Type: application/json' \
        -d '{"masterId": "30009", \
             "egetId": "456", \
             "titel": "Test titel"}' \
      http://api.virk.dk/dia/1/formular/123
    

    Eksempel på JSON response

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

    DELETE: Slet en formular

    URL

    https://api.virk.dk/dia/1/formular/{eget-id}
    

    Beskrivelse

    Slettemarkerer en formularvariant. Formularvarianten bliver ikke slettet fysisk.

    Eksempel

    $ curl -X DELETE https://api.virk.dk/dia/1/formular/123 
    

    Eksempel på JSON response

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