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.
-
GetFormServiceAreaList (Returnerer liste med
FORM-serviceområder) - dette kan hentes fra form-onlines rest
service med
-
GetFormTaskAreaList (Returnerer liste med
FORM-opgaveområder ) - denne operation var ikke implementeret og
returnerede altid en tom liste
-
GetFormTaskList (Returnerer liste med FORM-tjenester)
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