Snitfladebeskrivelse HentYdelseInformation BYS P11-4 KMD Børneydelse Version 1.0.0,

Transkript

1 Snitfladebeskrivelse HentYdelseInformation BYS P11-4 KMD Børneydelse Version 1.0.0,

2 Indholdsfortegnelse Indholdsfortegnelse Ændringer i forhold til forrige version Brug af snitfladebeskrivelsen Formål og målgrupper Hvad er formålet med snitfladerne? Hvem er målgrupperne? Snitfladens arkitektur Teknisk implementering Tekniske betingelser for anvendelse af snitfladen Garantier Protokol for dataudveksling Service kontrakt (.wsdl) Datastrømmene Datastrømmene Request Response Generelle datatyper (.xsd) Børneydelsesbevilling request Børneydelsesbevilling response Børneydelsesudbetaling request Børneydelsesudbetaling response Hvilke dataformater skal anvendes? Validering af data Hvilke krav stilles der til validiteten af data? Hvordan håndteres fejl? Sikkerhed KMD. Alle rettigheder forbeholdes. Dette materiale er ophavsretligt beskyttet og må ikke kopieres i videre omfang end forudsat i ophavsretsloven.

3 Brug af snitfladebeskrivelsen Ændringer i forhold til forrige version Snitfladebeskrivelse indsat i standard template i forbindelse med projekt Objektiv Sagsbehandling HPL: afsnit 5.4.4: Feltet Loftbelob udgået ved gennemgang af data ifm. aflevering til ATP Side 2

4 Brug af snitfladebeskrivelsen 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 Børneydelse baseret på snitfladerme HentBoernFamilieYdelseBevillinger og HentBoernFamilieYdelseUdbetalinger. 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. Henvendelser vedrørende snitfladen rettes hos KMD til: Domænechef, Børneydelse, Mette Pind Sonne (MPS) Udlån til andre leverandører. Kontakt til KMD. KMD Ballerup Lautrupparken Ballerup Telefon Henvendelser vedrørende snitfladen rettes hos Kommuner til: KOMBIT A/S: Kontakt hos Kommuner. Tlf. nr.: klippekort@kombit.dk Side 3

5 Formål og målgrupper 2 Formål og målgrupper 2.1 Hvad er formålet med snitfladerne? Snitfladerne er KMD Børneydelse bidrag til at gøre det muligt for en sagsbehandler, at skabe et overblik over en borgers samlede relationer med kommunen. De kommunikerede informationer giver et overbliksbillede af borgerens modtagne økonomiske ydelser fra KMD Børneydelse, såvel seneste udbetalinger samt betalinger tilbage som frem i tiden. Informationerne kan hentes ved angivelse af et personnummer,kommune nummer og en tidsperiode, hvori der ønskes informationer. Dersom både SoegePeriodeFraDato og SoegePeriodeTilDato er angivet leveres der information for den angivne periode. Dersom hverken SoegePeriodeFraDato eller SoegePeriodeTilDato angivet, leveres der information om seneste dannede udbetaling (indeværende kvartal). 2.2 Hvem er målgrupperne? Kommuner og deres it leverandører 3 Snitfladens arkitektur Batch eller Online eksekvering: Online Kanal: http (xml,wsdl) dvs. Webservice der grundlæggende er defineret ved xml-schema og wsdl filer typisk e2e i sikkerhedsrammer som f.eks. OWSA-model-T. Termen http inkluderer https Medie: Web 3.1 Teknisk implementering Snitfladen er en web service realiseret efter OIO OWSA model T B2B scenariet; der henvises til Tekniske betingelser for anvendelse af snitfladen Konsumenten skal anvende validt OCES certifikat. 4 Garantier KMD A/S garanterer, at kunden får et varsel på mindst 3 måneder i forbindelse med eventuelle ændringer af datastrukturer i snitfladen. Ved lovændringer kan der dog blive tale om kortere varsel. 5 Protokol for dataudveksling Side 4

6 Protokol for dataudveksling 5.1 Service kontrakt (.wsdl) De to services er beskrevet i HentBoernFamilieYdelseBevillinger.wsdl Det anvendte namespace udleveres af KMD ved kontraktindgåelse. 5.2 Datastrømmene De to webservices er dokumenteret ved følgende artefact: wsdl - xml-request - xml-response Datastrømmene Request Response 5.4 Generelle datatyper (.xsd) Datatyper for webservices er defineret i overensstemmelse med KMD standardsnitfladebeskrivelser Børneydelsesbevilling request <s:complextype name="hentboernfamiliebevillingkombitlistrequeststrukturtype"> <s:element minoccurs="0" maxoccurs="1" name="requestresponseidentifier" type="s:string" /> <s:element minoccurs="1" maxoccurs="1" name="kommunenummer" type="s:string" /> <s:element minoccurs="1" maxoccurs="1" name="personnummer" type="tns:personcivilregistrationidentifiertype" /> RequestResponseIdentifier STRING Identifikation af session request værdien overføres til response Side 5

7 Protokol for dataudveksling KommuneNummer STRING(3) Kommunenummer PersonNummer STRING(10) Personnummer på tilskudsmodtager Børneydelsesbevilling response <s:complextype name="hentboernfamiliebevillingkombitlistresponsestrukturtype"> <s:element minoccurs="0" maxoccurs="1" name="requestresponseidentifier" type="s:string" /> <s:element minoccurs="0" maxoccurs="unbounded" name="hentboernfamiliebevillingerkombitresponse" type="tns:kombitbevillingresponsetype" /> <s:element minoccurs="1" maxoccurs="1" name="returnmessage" type="tns:returnmessagetype" /> RequestResponseIdentifier STRING Identifikation af session request værdien overføres til response HentBoernFamilieBevillinger- KombitResponse KombitBevil- lingresponse- Type Responsestruktur indeholdende bevillingsoplysninger ReturnMessage ReturnMessageType Message struktur indeholdende returkoder og retur meddelelse <s:complextype name="kombitbevillingresponsetype"> <s:element minoccurs="1" maxoccurs="1" name="ydelsesperson" type="tns:personcivilregistrationidentifiertype" /> <s:element minoccurs="1" maxoccurs="1" name="ydelsestype" type="tns:kombitboernefamilieydelsestypekodetype" /> <s:element minoccurs="1" maxoccurs="1" name="bevillingerperiodefra" type="s:date" /> <s:element minoccurs="1" maxoccurs="1" name="bevillingerperiodetil" type="s:date" /> <s:element minoccurs="1" maxoccurs="1" name="stopaarsag" type="tns:kombitstopaarsagkodetype" /> <s:element minoccurs="1" maxoccurs="1" name="fritagelsesmarkering" type="s:string" /> Side 6

8 Protokol for dataudveksling YdelsesPerson STRING(10) Personnummer for den ydelsesberettigede typisk barnet til tilskudsmodtager YdelsesType KombitBoerne- FamilieYdel- sestypekode- Type Værdisæt Børneydelse Ekstra børnetilskud til enlige Ordinært børnetilskud til enlige Flerbørnstilskud Stort Særligt børnetilskud Særligt børnetilskud Ordinært børnetilskud-pensionister Særligt børnetilskud-pensionister UT Særligt børnetilskud-pensionister MT Særligt børnetilskud-uddannelsessøgende3 Særligt børnetilskud-uddannelsessøgende2 Særligt børnetilskud-uddannelsessøgende Adoptionstilskud Ungeydelse Modregning Uoplyst BevillingerPeriodeFra DATE Bevilling er tildelt fra denne dato BevillingerPeriodeTil DATE Bevilling er tildelt frem til den dato StopAarsag Fritagelsesmarkering KombitStop- AarsagKode- Type CHAR(1) Værdisæt ingen stopaarsag uddanelsesplan ikke overholdt sprogstimulering uoplyst J/N til om bevillingen er fritaget fra beregning i forbindelse med optjeningsprincippet Børneydelsesudbetaling request <s:complextype name="hentboernfamilieudbetalingkombitlistrequeststrukturtype"> <s:element minoccurs="0" maxoccurs="1" name="requestresponseidentifier" type="s:string" /> <s:element name="personnummer" minoccurs="1" maxoccurs="1" type="tns:personcivilregistrationidentifiertype" /> <s:element name="kommunenummer" type="s:string" minoccurs="1" maxoccurs="1" /> <s:element name="udbetalingsperiodefra" type="s:date" minoccurs="0" maxoccurs="1" /> <s:element name="udbetalingsperiodetil" type="s:date" minoccurs="0" maxoccurs="1" /> Side 7

9 Protokol for dataudveksling RequestResponseIdentifier STRING Identifikation af session request værdien overføres til response PersonNummer STRING(10) Personnummer på tilskudsmodtager KommuneNummer STRING(3) Kommunenummer UdbetalingsPeriodeFra DATE Hent udbetalinger der dækker en periode fra UdbetalingsPeriodeTil DATE Hent udbetalinger der dækker en periode til Børneydelsesudbetaling response <s:complextype name="hentboernfamilieudbetalingkombitlistresponsestrukturtype"> <s:element minoccurs="0" maxoccurs="1" name="requestresponseidentifier" type="s:string" /> <s:element minoccurs="0" maxoccurs="unbounded" name="hentboernfamilieudbetalingkombitresponse" type="tns:kombitudbetalingresponsetype" /> <s:element minoccurs="1" maxoccurs="1" name="returnmessage" type="tns:returnmessagetype" /> RequestResponseIdentifier STRING Identifikation af session request værdien overføres til response HentBoernFamilieUdebetalingKombitResponse KombitUdbeta- lingresponse- Type Responsestruktur indeholdende udbetalingsoplysninger (effektueringer) ReturnMessage ReturnMessageType Message struktur indeholdende returkoder og retur meddelelse <s:complextype name="kombitudbetalingresponsetype"> <s:element minoccurs="1" maxoccurs="1" name="ydelsesperson" type="tns:personcivilregistrationidentifiertype" /> <s:element minoccurs="1" maxoccurs="1" name="ydelsestype" type="tns:kombitboernefamilieydelsestypekodetype" /> <s:element minoccurs="1" maxoccurs="1" name="udbetalingsperiodefra" type="s:date" /> Side 8

10 Protokol for dataudveksling <s:element minoccurs="1" maxoccurs="1" name="udbetalingsperiodetil" type="s:date" /> <s:element minoccurs="1" maxoccurs="1" name="belob" type="s:decimal" /> <s:element minoccurs="0" maxoccurs="1" name="dispositionsdato" type="s:date" /> <s:element minoccurs="0" maxoccurs="1" name="loftbelob" type="s:decimal" /> YdelsesPerson STRING(10) Personnummer for den ydelsesberettigede typisk barnet til tilskudsmodtager YdelsesType KombitBoerne- FamilieYdel- sestypekode- Type Værdisæt Børneydelse Ekstra børnetilskud til enlige Ordinært børnetilskud til enlige Flerbørnstilskud Stort Særligt børnetilskud Særligt børnetilskud Ordinært børnetilskud-pensionister Særligt børnetilskud-pensionister UT Særligt børnetilskud-pensionister MT Særligt børnetilskud-uddannelsessøgende3 Særligt børnetilskud-uddannelsessøgende2 Særligt børnetilskud-uddannelsessøgende Adoptionstilskud Ungeydelse Modregning Uoplyst UdbetalingsPeriodeFra DATE Effektueringer dækker et kvartal. Dato er den første dag i dette kvartal. UdbetalingsPeriodeTil DATE Effektueringer dækker et kvartal. Dato er den sidste dag i dette kvartal. Belob DispositionsDato NUMERIC DATE Nettobeløb til udbetaling Dato for hvor udbetaling kommer til udbetaling 5.5 Hvilke dataformater skal anvendes? Se ovenfor Side 9

11 Validering af data 6 Validering af data Dokumenteres kun for indgående snitflader. 6.1 Hvilke krav stilles der til validiteten af data? Se dokumentation på digitaliser.dk 6.2 Hvordan håndteres fejl? Se dokumentation på digitaliser.dk 7 Sikkerhed Sikkerheden styres af KMD Børneydelse som et request/response scenarie indenfor OWSA model T B2B rammer. Anvender af grænsesnittet, herefter benævnt Anvender, skal være oprettet i KMDs sikkerhedssystem og adgangen vil være baseret på et OCES-certifikat. Anvender indhenter tilladelse fra relevante kommuner og forpligtiger sig derved på grænsesnittet kun at rette forespørgsler på personer, der er dækket af de indgåede aftaler. KMD og Anvender indgår aftale der afspejler ovennævnte forhold; i denne aftale fremgår det ligeledes at KMD's logning på grænsesnittet kun relaterer sig til Anvender og IKKE til brugere af Anvenders egen it-løsning. Det er Anvenders ansvar selv at føre logning af de slutbrugere eller andre itløsninger der anvender snitfladens data via Anvenders egen it-løsning Side 10