LEFI Online, system till system (Leverera Förmånsinformation) WEBBSERVICE/SHS/SSEK

Transkript

1 LEFI Online, system till system (Leverera Förmånsinformation) WEBBSERVICE/SHS/SSEK Gränssnittsspecifikation Försäkringskassan IT

2 1 (11) Ändringsförteckning Nedanstående tabell redovisar ändringshistoriken för detta dokument. Ändring Rev A Första fastställda utgåva Bilage- och referensförteckning Nummer Titel, dokumentid, sökväg LEFI Online, Beskrivning av person- och förmånsinformation o Copyright, Försäkringskassan IT 1 (1)

3 Innehållsförteckning Ändringsförteckning...1 Bilage- och referensförteckning Beskrivning Översikt Förutsättningar Användning Felhantering Tjänsten kan inte kontaktas Timeout Valideringsfel Övriga fel Parametrar Anropsparametrar Generellt fält Personuppgifter Efterfrågade förmåner Returparametrar Generellt fält Tolkning av kundstatus Personuppgifter Förmånsförteckning Förmånslista Meddelandeelementet... 2 Förmånselementen Gränssnitt (11) 3.1 XML-Schema...2 Copyright, Försäkringskassan IT 2 (2)

4 3 (11) 1 Beskrivning Detta dokument beskriver LEFI Onlines system till system-gränssnitt mellan Försäkringskassan och externa intressenter. Gränssnittsbeskrivningen nedan är, i största möjliga mån, oberoende av transportprotokoll. 1.1 Översikt LEFI Online har som uppgift att leverera förmånsinformation för efterfrågad person och period. När frågan anländer hämtas, sammanställer och i vissa fall förädlas förmånsinformation från försäkringskassans olika förmånssystem. Förmånssystemen finns både i den gamla och i den nya teknikmiljön. Beroende på det avtal som den frågande organisationen har filtreras viss information bort innan den levereras. 1.2 Förutsättningar För att kunna nyttja tjänsten måste den externa intressenten ha ett avtal med försäkringskassan och ett giltigt e-certifikat. 1.3 Användning Tjänsten anropas via nedan beskrivet gränssnitt. Tjänsten erbjuds över tre olika transportprotokoll, SHS, SSEK och som Webservice. För specifika detaljer om dessa protokoll hänvisas till de standarder som beskriver dem. Följande begränsningar och regler gäller för användandet av tjänsten: 1. Timeout från tjänsten ligger på 15 sekunder, ställ därför inte om frågan förrän den tiden har löpt ut och svar inte erhållits. 2. Frågeperioden får maximalt vara två år. Ifall frågeperiod är utanför denna gräns justeras fromtiden. 3. Frågan måste validera mot XML-Schemat, annars accepteras inte frågan. 4. Tjänsten är endast för online-frågor, ej batchkörningar. 5. Det ankommer på klientsidan att hantera överlast från sina system ut mot tjänsten så att anropen mot tjänsten följer den trafikmodell som SLA:et definerar eller andra överenskomna trafikmodeller mellan producent och konsument av tjänsten. Copyright, Försäkringskassan IT 3 (3)

5 1.4 Felhantering Felhantering i detta avseende är vad som kan uppstå ifall tjänsten inte kan leverera ett svar från förmånsförmedlingen. Detta avser inte i de fall enstaka förmåner inte kan svara, utan det behandlas som ett normalt svar från tjänsten. 4 (11) Tjänsten kan inte kontaktas I detta fall kommer klienten antingen att inte få kontakt med tjänsten och det kommer att gå fel på en gång eller att en timer löser ut. Detta är beroende på den klient som används för att konsumera tjänsten Timeout I det fall klienten kommer åt tjänsten men den genererar inte svaret inom en viss tid så blir det ett timeoutfel. <FK.Emot.ErrorResponse xmlns=" <error>timeout</error> </FK.Emot.ErrorResponse> Detta är inget stoppande fel utan samma fråga kan ställas igen vid ett senare tillfälle Valideringsfel I de fall frågan som ställs inte överensstämmer med det XML-schema som gäller så genererar tjänsten ett valideringsfel som innehåller vad som inte validerar. Felmeddelandet innehåller texten Valideringsfel, följt av vad som inte validerade. <FK.Emot.ErrorResponse xmlns=" <error>valideringsfel: cvc-complex-type.2.4.b: The content of element 'ext:generelltfalt' is not complete. One of '{" is expected.</error> </FK.Emot.ErrorResponse> Detta är stoppande fel, d.v.s. det hjälper inte att ställa om frågan eftersom antingen är frågan felaktigt ställd eller också misstämmer schemat Övriga fel I de övriga fall ett felmeddelande kommer har ett tekniskt fel uppstått i tjänsten. Frågan kan ställas om vid ett senare tillfälle. <FK.Emot.ErrorResponse xmlns=" <error>internt tekniskt fel</error> </FK.Emot.ErrorResponse> Copyright, Försäkringskassan IT 4 (4)

6 2 Parametrar Nedan beskrivs parametrar som förekommer i fråga och svar. Fråga och svar är en XML struktur som beskrivs av en XSD. Det finns tre varianter av XSD:n beroende på vilken organisation man tillhör, detta dokument beskriver dock tjänsten utifrån ett generellt perspektiv. Mer detaljerad information, hur datat tolkas verksamhetsmässigt, om de element som ingår i frågan och svaret finns beskriven i LEFI Online, Beskrivning av person- och förmånsinformation. 5 (11) 2.1 Anropsparametrar Generellt fält /FK.Online.Fraga/generelltfalt Element Typ Obligatorisk Format Beskrivning organisationsnummer unsignedlong Ja 10 siffror Identifierar vem som gör anropet Personuppgifter Detta element beskriver den efterfrågade individen och dess period som frågan avser. /FK.Online.Fraga/informationsfalt/person/ Element Typ Obligatorisk Format Beskrivning personnummer unsignedlong Ja 12 siffror Personnummer avseende för den person uppgifterna. from xs:date Ja ÅÅÅÅ-MM- DD tom xs:date Ja ÅÅÅÅ-MM- DD Periodens startdatum. Periodens slutdatum Efterfrågade förmåner Detta element anger vilka förmåner man frågar efter för den personen och period frågan avser. /FK.Online.Fraga/informationsfalt/formansforteckning/ Element Typ Obligatorisk Format Systembegrepp arbetsskadelivranta xs:boolean Nej 0/1 Arbetsskadelivränta Copyright, Försäkringskassan IT 5 (5)

7 /FK.Online.Fraga/informationsfalt/formansforteckning/ Element Typ Obligatorisk Format Systembegrepp sjukochaktivitetsersattning xs:boolean Nej 0/1 Sjuk och aktivitetesersättning pension xs:boolean Nej 0/1 Pensionupgifter prognos xs:boolean Nej 0/1 Prognosuppgifter tillfalligforaldrapenning xs:boolean Nej 0/1 Tillfällig föräldrapenning TFP sjukpenninggrundandeinkomst xs:boolean Nej 0/1 Sjukpenninggrundande inkomst SGI levnadsintyg xs:boolean Nej 0/1 Levnadsintyg sjukpenning xs:boolean Nej 0/1 Sjukpenning foraldrapenning xs:boolean Nej 0/1 Föräldrapenning rehabersattning xs:boolean Nej 0/1 Rehabiliteringsersättning smittbararersattning xs:boolean Nej 0/1 Smittbärarersättning havandeskapspenning xs:boolean Nej 0/1 Havandeskapspenning narstaendepenning xs:boolean Nej 0/1 Närståendepenning dagpenningtilltotalforsvarspliktiga xs:boolean Nej 0/1 Dagpenning till totalförsvarspliktiga aktivitetsstod xs:boolean Nej 0/1 Aktivitetsstöd barnbidrag xs:boolean Nej 0/1 Barnbidrag bostadsbidrag xs:boolean Nej 0/1 Bostadsbidrag bostadstillagg xs:boolean Nej 0/1 Bostadstillägg efterlevandepension xs:boolean Nej 0/1 Efterlevandepension handikappersattning xs:boolean Nej 0/1 Handikappersättning 6 (11) Copyright, Försäkringskassan IT 6 (6)

8 /FK.Online.Fraga/informationsfalt/formansforteckning/ Element Typ Obligatorisk Format Systembegrepp generellpersoninformation xs:boolean Nej 0/1 Generell personinformation. Detta levereras alltid av tjänsten oavsett om den begärs eller inte, det har att göra med att skyddad identitet skall alltid levereras för att säkerställa säkerheten. underhallsstod xs:boolean Nej 0/1 Underhållsstöd utbetalning xs:boolean Nej 0/1 Utbetalningsinformation vardbidrag xs:boolean Nej 0/1 Vårdbidrag yrkesskadelivranta xs:boolean Nej 0/1 Yrkesskadelivränta 7 (11) 2.2 Returparametrar Generellt fält Detta generella fält som alltid levereras i svaret innehåller information om vem som frågade, vilket datum svaret skapades samt status på svaret. /FK.Online.Svar/generelltfalt Element Typ Obligatorisk Format Beskrivning organisationsnummer xs:unsignedlong Ja 10 siffror Identifierar vem som gjorde anropet. skapades xs:unsignedlong Ja ÅÅÅÅMMDD Det datum som svaret skapades. kundstatus kundstatusid Ja Siffra mellan 1 och 10 Status på svaret Tolkning av kundstatus Beroende på kundstatus så innehåller svaret olika information. Den skall tolkas enlig tabellen nedan. Värdet på kundstatus Förklaring Copyright, Försäkringskassan IT 7 (7)

9 8 (11) Värdet på kundstatus Förklaring 1 Ok, förmånsinformation finns i svaret för den efterfrågade personen. 2 Används ej, reserverad. 3 Personen saknas i försäkringskassans kundregister, ingen information om personen finns i svaret. Alternativt att personnumret inte validerar och är felaktigt. 4 Kan ej leverera förmånsinformation, personen har bytt personnummer. 5 Angivet fromdatum är ett datum i framtiden, korrigera frågan och ställ om den. 6 Angivet tomdatum är ett datum i framtiden, korrigera frågan och ställ om den. 7 Angivet from- eller tomdatum är felaktigt, korrigera frågan och ställ om den. Exempelvis att fromdatum är efter tomdatum. 8 Angiven period är större än två år. Tjänsten korrigerar frågans datum genom att skapa ett fromdatum som är två år före tomdatum och returnerar ett svar för den efterfrågade personen. 9 Tekniskt fel, vårt system är nere. Detta tekniska fel har alltså uppstått längre ned i anropskedjan än de tekniska fel som anges i kapitlet om felhantering. Det har uppstått ett fel i tjänsten, frågan kan ställas om men är detta bestående skall tjänsteleverantören kontaktas. 10 Tekniskt fel, vårt svar validerar inte mot XML-schemat. Det är ett fel i tjänsten och skall rapporteras till tjänsteleverantören Personuppgifter De personuppgifter som frågas efter returneras i personuppgiftselementet. För detaljerad information om personuppgifter se LEFI Onlines SBK Förmånsförteckning Svaret innehåller en kopia av den förmånsförteckning som efterfrågades i frågan, se kapitel Förmånslista Svaret innehåller en lista med data från alla efterfrågade förmåner, varje förmån har ett eget element i förmånslistan, se kapitel Samtliga förmånselement innehåller även ett meddelandeelement som beskriver status på förmånsinformationen. Detta för att man skall kunna avgöra om förmånssystemet levererat den efterfrågade informationen eller om förmånssystemet är nere. Copyright, Försäkringskassan IT 8 (8)

10 Meddelandeelementet Detta meddelandeelement ingår i samtliga förmåner och beskriver status på förmånsinformationen. /FK.Online.Svar/informationsfalt/formansinformation/<förmån>/ Element Typ Obligatorisk Format Beskrivning meddelande formansmeddelandeid Ja 1 eller 2 Status på förmånsinformationen Status på förmånens id ges av följande tabell: 9 (11) Värdet på meddelande Förklaring 1 Ok, informationen för förmånen finns i förmånselementet. 2 Förmånssystemet är ej tillgängligt. Frågan kan ställas om med den saknade förmånen senare. Är detta ett bestående fel kontakta tjänsteleverantören Förmånselementen För en mer detaljerad bild av innehållet i respektive förmånselement se förmånerna i LEFI Online, Beskrivning av person- och förmånsinformation. /FK.Online.Svar/informationsfalt/formansinformation/ Element Obligatorisk Systembegrepp arbetsskadelivranta 0..1 Arbetsskadelivränta AS sjukochaktivitetsersattning 0..1 Sjuk och aktivitetsersättning SA pension 0..1 Pension prognos 0..1 Prognos tillfalligforaldrapenning 0..1 Tillfällig föräldrapenning TFP sjukpenninggrundandeinkomst 0..1 Sjukpenninggrundande inkomst SGI levnadsintyg 0..1 Levnadsintyg sjukpenning 0..1 Sjukpenning foraldrapenning 0..1 Föräldrapenning rehabersattning 0..1 Rehabiliteringsersättning smittbararersattning 0..1 Smittbärarersättning Copyright, Försäkringskassan IT 9 (9)

11 /FK.Online.Svar/informationsfalt/formansinformation/ Element Obligatorisk Systembegrepp havandeskapspenning 0..1 Havandeskapspenning narstaendepenning 0..1 Närståendepenning 10 (11) dagpenningtilltotalforsvarspliktiga 0..1 Dagpenning till totalförsvarspliktiga aktivitetsstod 0..1 Aktivitetsstöd barnbidrag 0..1 Barnbidrag bostadsbidrag 0..1 Bostadsbidrag bostadstillagg 0..1 Bostadstillägg efterlevandepension 0..1 Efterlevandepension handikappersattning 0..1 Handikappersättning generellpersoninformation 1 Generell personinformation, detta element finns alltid med oavsett om den frågas efter eller inte. Anledningen är för att man skall kunna garanatera att särskildprövning ingår i uppgifterna. underhallsstod 0..1 Underhållstöd utbetalning 0..1 Utbetalningsinformation vardbidrag 0..1 Vårdbidrag yrkesskadelivranta 0..1 Yrkesskadelivränta YL 3 Gränssnitt 3.1 XML-Schema De finns publicerade på och heter: exi_online_frage_svar.xsd exi_online_frage_svar_fbolag.xsd exi_online_frage_svar_kfm.xsd exi_online_frage_svar_kom.xsd Copyright, Försäkringskassan IT 10 (10)