Loading…
Tilbage

Tilpasninger til FORM understøttelsen i artikeleksporten på Borgerguide V3


30-03-2012 13:41:50

Artikeleksporten bevarer SOAP formatet på Borgerguide V3, men i forhold til FORM laver vi nogle tilpasninger, da der er sket meget med FORM siden Borger.dk begyndte at anvende FORM version 1.1 fra september 2008 (Se evt. under FORM gamle versioner).

Fremover anvendes nøglernes UuidIdentifikator som id'er og ikke de logiske NummerIdentifikatorer

I den eksisterende implementation angives nøgler med den logiske FORM notation som f.eks.

<a:FormTask>
<a:FormTaskName>Udstedelse af pas</a:FormTaskName>
<a:FormTaskNumber>01.3.12.04</a:FormTaskNumber>
</a:FormTask>

som i den aktuelle version af FORM findes under 08.15.05.50 

<Opgave>
<VersionIdentifikator>2.1</VersionIdentifikator>
<OprettetDato>2011-03-28</OprettetDato>
<UuidIdentifikator>82e54e2b-4e46-11e0-a272-0050c2490048</UuidIdentifikator>
<NavnTekst>Pas</NavnTekst>
<BeskrivelseTekst>Rejselegitimation for danske statsborgere. Andre landes pas- og visumregler, se forvaltningsopgave 03.05.05.15</BeskrivelseTekst>
<OpgaveNummerIdentifikator>08.15.05.50</OpgaveNummerIdentifikator>

Her vil fremover bliver benyttet GUID'en 82e54e2b-4e46-11e0-a272-0050c2490048 og ikke  08.15.05.50, efter anbefaling fra FORM redaktionen da disse er mere stabile/persistente og bevares selvom nøgle flyttet internt i FORM hierakiet.

FORM har 4 niveauer men Borger.dk bruger kun det nederste - opgaver

I FORM 1.1 havde vi følgende områder

  • Serviceområde
  • Opgaveområde
  • Opgaver 

mens der er i den nuværende FORM (2.2) er:

  • Serviceområde
  • Hovedområde
  • OpgaveOmråde
  • Opgave

Dette ekstra niveau betyder dog reelt ikke noget da det ikke anvendes af Borger.dk. Læs nedest om service operationerne til søgning.

Service operationer

Artikeleksportens SOAP interface har 6 operationer som vedrører FORM, fordelt på hhv. 3 som giver lister med oversigt over nøglerne (på de tre niveauer) og 3 som giver artikelsøgninger på de modsvarende niveuaer.

Nederst er vedhæftet eksempler på SOAP svar fra disse 6 operationer.

Service operationer som giver lister med oversigt over FORM nøgler

Service operationer som giver lister med oversigt over FORM nøgler skal fremover hentes fra form-online, enten via det normale web-interface form-online.dk eller via de REST services som udstilles. Borgerguide V3 bruger selv internt form-onlines REST services, og der ingen grund til at artikeleksporten skal proxy disse oplysninger, som autoritativt kommer fra form-online.

Service operationer til FORM baseret søgning efter artikler

  • GetArticleIDsByFormServiceArea (Returnerer liste med artikel-ID’er) - denne bliver ikke implementeret, da den ikke modsvarer en anvendelse på Borger.dk! 
  • GetArticleIDsByFormTaskArea (Returnerer liste med artikel-ID’er) - denne operation var ikke implementeret og vil heller ikke bliver det!
  • GetArticlesByFormTasks (Returnerer liste med artikler med indhold) - denne vil fortsat være understøttet.

Hvis nogen ønsker at lave en søgning på et andet niveau end opgave niveauet må de selv lave denne aggregering ved at søgning på alle de relevate underliggende nøgler.

Filer og referencer

Titel Type
GetFormTaskList-response.xml text/xml
GetFormServiceAreaList-response.xml text/xml
GetFormTaskAreaList-response.xml text/xml
GetArticleIDsByFormServiceArea-01-response.xml text/xml
GetArticlesByFormTasks-01.3.12.04-response.xml text/xml
GetArticleIDsByFormTaskArea-response.xml text/xml
Profilbillede

FORM-online's REST service understøtter nu kald med 'UuidIdentifikator'

Brian Nielsen

FORM-onlines REST API understøtter nu at man kan kalde med såvel UUID/UuidIdentifikator som FORM-nummer/OpgaveNummerIdentifikator. Det er beskrevet i online dokumentationen til FORM-RESTHermed er det nu muligt direkte at relatere FORM-opmærkningen i artikeleksporten med FORM-online. Eksempelvis opgaven"Rejselegitimation for danske statsborgere." (08.15.05.50) kan hentes med http://www.form-online.dk:8080/FORM-REST/resources/08.15.05.50?dybde=1såvel som http://www.form-online.dk:8080/FORM-REST/resources/82e54e2b-4e46-11e0-a272-0050c2490048?dybde=1giver


2.2
2012-04-02
82e54e2b-4e46-11e0-a272-0050c2490048
Pas
Rejselegitimation for danske statsborgere. Andre landes p>
08.15.05.50

Bek. af lov om pas til danske statsborgere m.v.
A20080090029


Ambassader
Ambassader


Justitsministeriet
Justitsministeriet


Kommune
Kommune


Udenrigsministeriet
Udenrigsministeriet


ændret af Brian Nielsen (21.05.2012)