Snitfladebeskrivelse for Snitfladebeskrivelse STD-8 KMD Boligstøtte Version 1.0.0,

Transkript

1 Snitfladebeskrivelse for Snitfladebeskrivelse STD-8 KMD Boligstøtte Version 1.0.0,

2 Indholdsfortegnelse Ændringer i forhold til forrige version Brug af snitfladebeskrivelsen Formål og målgrupper Hvad er formålet med snitfladen? Hvem er målgrupperne? Snitfladens arkitektur Teknisk implementering Betingelser for anvendelse af snitfladen Garantier Protokol for dataudveksling Hvordan opbygges datastrømmen? Hvilke(t) tegnsæt skal anvendes? Hvilke datastrukturer skal anvendes? Hvilke dataformater skal anvendes? Inddata Uddata som følge af forespørgsel Validering af data Hvilke krav stilles der til validiteten af data? Hvordan håndteres fejl? Sikkerhed Registrering af benyttelse... 15

3 Ændringer i forhold til forrige version Version Bemærkning Første udgave

4 1 Brug af snitfladebeskrivelsen Denne snitfladebeskrivelse udgør grundlaget for indgåelse af konkrete aftaler med KMD's kunder om udveksling af data med KMD Boligstøtte baseret på snitfladen Snitfladebeskrivelse STD-8. Grundlag for indgåelse af aftaler. Den er desuden et praktisk arbejdsredskab til støtte for kommunikationen mellem kunderne og KMD om snitfladens anvendelse. Beskrivelsen må ikke overdrages eller kopieres i videre omfang end forudsat i ophavsretsloven men kun udlånes til softwareleverandører i forbindelse med etablering af snitfladen samt ved fremtidige ændringer. Udlån til andre leverandører. Henvendelser vedrørende snitfladen rettes til: Kontakt til KMD. KMD Team Boligstøtte Niels Bohrs Allé Odense SØ bolig@kmd.dk Telefon

5 2 Formål og målgrupper 2.1 Hvad er formålet med snitfladen? Det er et kommunalt ønske, at skabe overblik over borgerens samlede interaktioner med kommunen. Dette overblik skal skabes på tværs af sagsområder og fagsystemer, og præsenteres på en overskuelig og lettilgængelig måde. Snitfladen leverer nøgledata vedrørende ydelsesområdet boligstøtte på en lettilgængelig måde via et web-service API. 2.2 Hvem er målgrupperne? Løsningen er tænkt som redskab for sagsbehandlere eller andre, hvis fokus er omkring borgeren og dennes husstand, husstandens indkomst- og boligforhold, verserende sager samt de ydelser husstanden modtager i form af boligstøtte.

6 3 Snitfladens arkitektur Kommunikation til bruger af snitfladen sker vha. OIO xml webservice. Certifikat udbyder OIO xml Arbejdsstation Sagsbehandler KMD Certifikat kontrol Forespørgsel Ekstern Web Server Boligstøtte

7 4 Teknisk implementering Adgang sker via en ekstern OIO webservice etableret af KMD. OIO-xml benyttes i kommunikationen i henhold til aktuel standard: OIOXML som åben, obligatorisk standard - uddybende vejledning Se desuden afsnit 9 Sikkerhed og afsnit 10 Registrering af benyttelse.

8 5 Betingelser for anvendelse af snitfladen Snitfladen er beregnet til enkeltstående online opslag. I forbindelse med udlevering af snitfladebeskrivelsen skal der indgås en aftale med KMD om benyttelse af snitfladen, og overholdelse af de forudsætninger som er knyttet hertil. Det er snitfladeabonnentens ansvar at transaktionerne er afsendt til og modtaget fra KMD i overensstemmelse med denne snitfladebeskrivelse. I tilfælde af fejlagtige forespørgselstransaktioner er KMD villig til, mod betaling, at rådgive med henblik på at få transaktionerne korrekte.

9 6 Garantier Med mindre andet er aftalt, vil der være et varsel på 3 måneder for ændringer i snitfladen, der medfører at kunden har behov for at tilpasse sin XML snitflade. Udvidelser i eksisterende snitflade, der ikke medfører funktionalitetsændringer, vil blive varslet med en måned. KMD drifter og vedligeholder disse web services, med en rådighed i døgnets 24 timer 365 dage om året, kun afbrudt af servicevinduer og afvikling af batchkørsler, som typisk foregår om natten mellem kl. 21 og 7, hvor der kan forekomme ustabilitet eller manglende adgang til data. KMD tilstræber at disse web services har en meget høj oppetid på alle tider af døgnet.

10 7 Protokol for dataudveksling 7.1 Hvordan opbygges datastrømmen? Kommunikation og datastrøm foregår via webservice beskrevet ved "HentYdelseInformationBoligstoette.wsdl" som er publiceret på Hvilke(t) tegnsæt skal anvendes? <?xml version="1.0" encoding="utf-8"?> 7.3 Hvilke datastrukturer skal anvendes? Datastrømmen er organiseret i en struktur, som igen indeholder en inputog en outputstruktur. Strukturerne er publiceret på digitaliser.dk med følgende: Input: Output: Strukturerne er nærmere beskrevet på denne placering. 7.4 Hvilke dataformater skal anvendes? Inddata Forudsætninger: 1. Der hentes kun aktiv sag, hvor personnummer er ansøger eller er aktivt husstandsmedlem pr. udbetalingsdato. 2. Er der ingen aktiv sag returneres tom struktur med en relevant returkode. 3. På den fundne sag hentes udbetalingsoplysninger for de udbetalinger som ligger i perioden mellem Udbetaling-fra og Udbetaling-til dato. 4. Anvenderen af snitfladen har ansvaret for sikkerhed; dvs. benyttes denne service er det forudsat at brugeren har autorisation til at se oplysningerne. Kommunenummer Nuværende kendte kommunenumre Personnummer Personnummer for en som enten kan være ansøger, eller kan være husstandsmedlem på en

11 aktiv sag Udbetalingsdato-fra Dato for forespurgt udbetalingsdato (altid den første i en måned) periode start Udbetalingsdato-til Dato for forespurgt udbetalingsdato (altid den sidste kalenderdag i en måned) periode slut Udbetalingsdato-til skal være lig med eller større end Udbetalingsdato-fra Uddata som følge af forespørgsel En gruppe med op til 24 elementer. Hvert element indeholder Status Aktiv sag pr. udbetalingsdato Svarende til Boligstøtte status: 0 aktiv Udbetalingsdato Udbetaling vedrørende måned Ex: udbetalingsdato vedrørende januar Periode fra Første dato i udbetalings måned Periode til Sidste dato i udbetalings måned Næste udbetalingsdato Den næste måneds Første dag Nettoudbetaling Beløb til udbetaling efter regulering og andre betalinger Skattepligtig fast n/a Skattepligtig - regulering n/a Skattefri fast Beregnet boligstøtte for måned

12 Skattefri regulering Summen af alle reguleringer svarende til Nettoudbetaling - Skattefri-fast - Andre betalinger Indeholder reguleringer og bevægelser på mellemværende, herunder bl.a. indbetaling, tilbageført støtte og acontoudbetalinger. ATP og SP n/a A-skat n/a Andre betalinger Træk i udbetalingen som følge af loft over kontanthjælp Sagssted Lokalkontor med de betegnelser som anvendes af KMD's boligstøttesystem Ingen tildeling af sager til sagsbehandler er registreret i systemet Ydelsesmeddelelse Ydelsestype (Boligsikring, Boligydelse, Boligsikring til førtidspensionister) Antal Voksne, antal børn (pr. udbetalingsdato) på sagen som personen tilhører Advisering om personen er ansøger, eller om personen er husstandsmedlem, og i så fald på hvilken sag.

13 8 Validering af data 8.1 Hvilke krav stilles der til validiteten af data? Der valideres efter følgende regler: Kommunenummer 4 cifret evt. med foranstillet 0 (nul). Teknisk definition: Personnummer 10 cifre med formatet ddmmååååxxxx Teknisk definition: Udbetalingsdato-fra Mindre end eller lig med Udbetalingsdato-fra; 8 cifre med formatet ååååmmdd Teknisk definition: Udbetalingsdato-til Udbetalingsdato-til skal være defineret og være større end eller lig med Udbetalingsdato-fra; 8 cifre med formatet ååååmmdd Teknisk definition: Alle inddata felter kræves udfyldt. 8.2 Hvordan håndteres fejl? Der returneres fejlkoder, intern fejltekst og brugervendte tekster (brugervendte tekster nedenfor i citationstegn) Return Reason Tekst 1 1 Udbetalinger returneret -Ingen brugervendt tekst-

14 1 10 OK - 24 hentet - og der er flere til returnering Ingen data fundet "Systemet kan ikke vise alle oplysninger på én gang - afgræns resultatet, fx. ved at dele søgeperioden i flere intervaller." "Personnummeret $Data$ er ikke på en aktiv sag for perioden $Data$ til $Data$ i kommune $Data$ Ingen adgang med dette kommunenummer "Bruger er ikke godkendt i kommunen" Kommunenummer ikke udfyldt "Kommunenummer skal være udfyldt" Journalnummer ikke udfyldt "Personnummer skal være udfyldt" Udbetal-fradato skal være mindre tildato "Udbetalingsdato-til skal ligge tidsmæssigt efter Udbetalingsdato-fra" Deadlock eller timeout Database fejl "Systemet er optaget i øjeblikket forsøg igen lidt senere" "Der er sket en fejl under forespørgslen - det er ikke muligt at returnere et svar" Boligstøttesystemet kører ikke i øjeblikket "Systemet er desværre ikke tilgængeligt i øjeblikket det er ikke muligt at returnere et svar"

15 9 Sikkerhed Anvendelse af snitfladen via webservice skal ske via krypteret forbindelse, https. Adgang til løsningen sker vha. certifikat. Certifikatet skal være godkendt og registreret i KMD's sikkerhedssystem (KSP-CICS). Anvenderen af snitfladen har herudover ansvaret for overholdelse af gældende lovgivning ved anvendelsen, herunder begrænset adgang til løsningen, samt logning af alle personer som anvender løsningen.

16 10 Registrering af benyttelse Ved forespørgsel logges via den centrale systemafvikling hos KMD (mainframe): Anvendt Certifikat (identifikation af certifikatet) Tidspunkt for forespørgsel Kommunenummer Hvilket cpr nummer forespørgslen omfatter Udbetalingsdato-fra Udbetalingsdato-til Anvenderen af snitfladen har ansvaret for sikkerhed; det betyder, at hvis denne service benyttes er det forudsat, at kun personer (=brugere) med godkendt adgang til personrelaterede data kan tilgå data, og at personens (=brugerens) identitet logges i snitfladeanvenderens domæne.