Vypracováno pro MV
IS o ISVS
Základní zadání IS o ISVS Sluţba poskytování dat IS o ISVS
podle pokynů objednatele vypracovala společnost
ASD Software, s.r.o.
dokument ze dne 5.12.2012, verze 1.00
Vypracováno pro MV
IS o ISVS
Sluţba poskytování dat IS o ISVS
Počet stran v dokumentu celkem: 14
Název souboru: Dokumentace rozhraní poskytování dat ISoISVS_20000_100 Copyright © ASD Software, s.r.o., 2012
2
Vypracováno pro MV
IS o ISVS
Obsah 1
ÚVOD ........................................................................................................................................................................ 4
2
GLOBÁLNÍ CHARAKTERISTIKA ŘEŠENÍ ...................................................................................................... 4 2.1
POSKYTOVÁNÍ SEZNAMU ISVS ............................................................................................................................... 4 TECHNICKÁ SPECIFIKACE ŘEŠENÍ ................................................................................................................ 5
3 3.1
POŽADOVANÉ STANDARDY PRO DATA A METADATA............................................................................................... 5
3.1.1 3.1.2 3.1.3 3.2 3.3 3.4 3.5 3.6
Přenosový formát dat ..................................................................................................................... 5 Formát popisu dokumentu ............................................................................................................. 5 Formát interní dokumentace schémat ............................................................................................ 5
PODPOROVANÉ ZÁKLADNÍ PŘENOSOVÉ PROTOKOLY............................................................................................... 5 POUŽITÁ STRUKTURA ZPRÁV (SOAP MESSAGING). ................................................................................................ 5 POUŽITÍ A UMÍSTĚNÍ METADAT O SLUŽBĚ (POPIS SLUŽBY VE FORMÁTU WSDL) ..................................................... 6 ZABEZPEČENÍ KOMUNIKACE ................................................................................................................................... 6 OBECNÁ PRAVIDLA ZPRACOVÁNÍ CHYB KOMUNIKACE............................................................................................ 6
3.6.1 3.6.2 3.6.3 3.6.4 3.6.5
Chyby na úrovni přenosového protokolu HTTPS.......................................................................... 7 Chyby při načtení zprávy SOAP .................................................................................................... 7 Chyby na úrovni validace pomocí XML Schema .......................................................................... 7 Chyby na úrovni aplikační ............................................................................................................. 7 Opakování chybných dotazů .......................................................................................................... 7
SPECIFIKACE PŘENÁŠENÝCH DAT ................................................................................................................ 8
4 4.1
DATOVÉ TYPY, POUŽÍVANÉ SLUŽBOU IS O ISVS .................................................................................................... 8
4.1.1 4.1.2 4.1.3 4.1.4 4.2
Základní bezvýznamové datové typy ISVS ................................................................................... 8 Obecné datové typy ISVS .............................................................................................................. 8 Datové typy ISVS pro popis ekonomického subjektu ................................................................... 9 Datové typy ISVS pro popis ISVS................................................................................................. 9
PŘEDÁNÍ SEZNAMU ISVS...................................................................................................................................... 10
4.2.1
Zpráva požadavku výpisu seznamu ISVS .................................................................................... 10
4.2.1.1
4.2.2
Validace pomocí schématu ............................................................................................................... 10
Odpověď služby IS o ISVS.......................................................................................................... 10
4.2.2.1
Validace pomocí schématu ............................................................................................................... 10
5
DETAILNÍ PRAVIDLA PŘENOSU ZPRÁV ...................................................................................................... 11
6
ZMĚNY OPROTI PŘEDCHOZÍ VERZI ............................................................................................................ 12
REFERENCE ................................................................................................................................................................... 13 6.1 6.2 6.3
REFERENCE........................................................................................................................................................... 13 POUŽITÉ POJMY .................................................................................................................................................... 13 POUŽITÉ ZKRATKY ................................................................................................................................................ 14
Název souboru: Dokumentace rozhraní poskytování dat ISoISVS_20000_100 Copyright © ASD Software, s.r.o., 2012
3
Vypracováno pro MV
IS o ISVS
1 Úvod Tato dokumentace obsahuje specifikaci služby IS o ISVS, která slouží k předávání informací o informačních systémech veřejné správy, např. pro potřeby Registru práv a povinností (RPP). Vymezuje základní podmínky pro přenášení informací z IS o ISVS. V této podobě se jedná o pracovní materiál; od konečné podoby se tento dokument může lišit úpravami, které budou reakcí na optimální realizaci služby v tomto dokumentu popsané.
2 Globální charakteristika řešení V této části dokumentace jsou formou slovního popisu, doplněného obrazovým schématem, charakterizovány procesy, probíhající při komunikaci pomocí vytvářené služby. Popis na této úrovni postihuje celé řešení, které je popsáno jako transakce, spuštěná iniciátorem transakce (např. osobou, časovou spouští apod.) Popis má v tomto oddíle globální charakter a vyhýbá se podrobnostem, které jsou řešeny v následujících částech. Slouží k pochopení celkového pojetí řešení a jako základ pro další části dokumentace.
2.1 Poskytování seznamu ISVS Obrázek č. 1 popisuje proces poskytnutí dat (seznamu ISVS) službou IS o ISVS klientské aplikaci (např. RPP): Zpráva s požadavkem na výpis Poskytování dat IS o ISVS
Klientská aplikace (RPP)
Odpověď IS o ISVS s daty ISVS
Obr. 1 – Poskytování dat o ISVS z IS o ISVS do klientské aplikace (RPP) 1. Na straně klientské aplikace je vygenerována zpráva, obsahující žádost o poskytnutí výpisu seznamu ISVS. Spuštění přenosu se děje ad hoc uživatelem nebo systémem klienta; to znamená, že služba IS o ISVS nepočítá s existencí časového plánu přenosů. 2. Zpráva je opatřena všemi náležitostmi dle této specifikace a je odeslána pomocí protokolu HTTP na adresu služby IS o ISVS (https://www.sluzby-isvs.cz/ISoisvs/isoisvs.svc). Spojení mezi komunikujícími stranami není přerušeno. 3. Služba aplikace IS o ISVS přijme zprávu s požadavkem a zpracuje ji v souladu s pravidly, stanovenými v této specifikaci. Zpět klientské straně odešle zprávu o s výsledkem zpracování dotazu (seznam ISVS / chybové hlášení).
Název souboru: Dokumentace rozhraní poskytování dat ISoISVS_20000_100 Copyright © ASD Software, s.r.o., 2012
4
IS o ISVS
Vypracováno pro MV
3 Technická specifikace řešení V této části dokumentace jsou popsány technická východiska řešení. Jsou deklarovány požadované technické standardy.
3.1 Požadované standardy pro data a metadata 3.1.1 Přenosový formát dat Přenosovým formátem dat bude ve všech případech zpráv služby IS o ISVS formát XML. Zprávy služby ve formátu XML musejí vyhovovat standardu XML 1.0, Second Edition. Kódová stránka XML zpráv služby bude UTF-8. Zprávy v kódování UTF-8 mohou obsahovat úvodní indikaci kódové stránky (Byte Order Mark - BOM). XML dokumenty zpráv budou mít připojenu deklaraci XML. 3.1.2 Formát popisu dokumentu Pro popis struktury zpráv a sémantiky dat, přenášených pomocí zpráv služby IS o ISVS, bude použit standard XML Schema. Implementace schémat se bude řídit metodickým dokumentem „Metodika tvorby XML schémat v oblasti informačních systémů veřejné správy“ [2]. 3.1.3 Formát interní dokumentace schémat Schémata budou dostatečně dokumentována. Interní dokumentace schémat bude založena na standardu RDF a Dublin Core.
3.2 Podporované základní přenosové protokoly Pro přenos všech typů XML zpráv služby IS o ISVS se bude používat pouze komunikační protokol HTTPS. Pravidla pro použití protokolu HTTP(S) se budou řídit podle kapitoly 5.4.1.1 dokumentu „Metodika komunikace na bázi XML - Použití ve finančních, kontrolních a podpůrných informačních systémech“[1]: Protokol HTTP musí obsahovat ve svém záhlaví indikaci kódové stránky neseného XML dokumentu pomocí parametru charset. Znaková stránka, uvedená v deklaraci XML pro XML dokument, by se měla shodovat s kódovou stránkou protokolu HTTP. V případě rozporu bude kódová stránka XML dokumentu vždy ignorována. Protokol HTTP musí obsahovat ve svém záhlaví indikaci typu obsahu neseného XML dokumentu pomocí parametru content-type. Tento parametr bude pro XML dokumenty zpráv IS o ISVS nabývat hodnoty „application/xml“. Pro přenos zpráv XML služby IS o ISVS se bude používat protokol HTTP verze 1.1. Pro přenos zpráv XML služby IS o ISVS se bude používat metoda HTTP POST. Použití záhlaví SoapAction protokolu HTTP pro službu IS o ISVS není povoleno. Služba IS o ISVS, komunikující pomocí protokolu HTTPS, bude používat TCP port 443. Služba IS o ISVS bude používat při komunikaci stavové kódy HTTP. Pro rozhodnutí o výsledku přenosu zpráv však bude závazný obsah zprávy XML; stavový kód HTTP bude považován pouze za informativní údaj.
3.3 Použitá struktura zpráv (SOAP messaging). Služba IS o ISVS bude nad internetovým protokolem HTTPS používat nadstavbový XML protokol SOAP ve verzi 1.1. Webová služba IS o ISVS bude protokol SOAP používat v souladu se specifikací organizace WS-Interoperability „Basic Profile Version 1.0a“. Struktura zprávy SOAP bude následující: Zpráva bude nesena zvoleným přenosovým protokolem HTTPS. Název souboru: Dokumentace rozhraní poskytování dat ISoISVS_20000_100 Copyright © ASD Software, s.r.o., 2012
5
IS o ISVS
Vypracováno pro MV
Zpráva bude obsahovat povinnou obálku SOAP ve standardním formátu (bez uživatelských elementů) podle specifikace standardu SOAP 1.1. Zpráva bude obsahovat povinné záhlaví SOAP 1.1. Zpráva bude obsahovat tělo zprávy SOAP. Zpráva bude obsahovat v těle zprávy SOAP buď element XML souboru příslušné zprávy IS o ISVS, nebo element
s indikací případného problému na úrovni komunikace. Element a elementy XML souborů zpráv se vylučují, zpráva tedy nesmí obsahovat data (elementy XML souborů zpráv) a element současně.
3.4 Použití a umístění metadat o službě (popis služby ve formátu WSDL) Webová služba IS o ISVS bude popsána ve formátu WSDL 1.1 v souladu s doporučeními specifikace WS-I „Basic Profile Version 1.0a“. Soubor WSDL bude umístěn na URL adrese: https://www.sluzby-isvs.cz/ISoisvs/ISOISVS.svc?wsdl=wsdl0
3.5 Zabezpečení komunikace Služba IS o ISVS bude mít implementované následující bezpečnostní funkce: důvěrnost přenášených dat integritu přenášených dat důvěrnost spojení integritu spojení Technické řešení implementovaných bezpečnostních funkcí bude zabezpečeno použitím protokolu HTTPS. Všechny operace a zprávy služby budou mít bezpečnostní funkce implementovány stejným způsobem.
3.6 Obecná pravidla zpracování chyb komunikace Zpracování chyb bude ošetřeno v souladu se zásadami uvedenými v [1], kap. 5.8.1. Dojde-li při zpracování zprávy k chybě na úrovni celé zprávy (není možno vrátit žádnou požadovanou informaci) a je vyžadována odpověď, služba odpoví zařazením elementu do těla zprávy odpovědi. Indikace důvodu chyby bude řešena výběrem ze seznamu chybových kódů. Seznam chybových kódů bude následující: VersionMismatch – nesouhlasí verze jmenného prostoru elementu obálky SOAP. MustUnderstand – přijímající strana dokonale neporozuměla elementu s atributem MustUnderstand=“1“, obsaženému v záhlaví dokumentu SOAP. Client – indikuje výskyt klientských chyb, např. dokument neodpovídá schématu, syntaktická chyba dokumentu apod. Server – indikuje výskyt chyb na straně služby. Client.RequestNamespace – nepodporovaná verze dotazu. Jmenný prostor dokumentu dotazu neodpovídá verzi, aktuálně podporované službou. Client.SchemaNamespace – nepodporovaná verze namespace pro validaci parserem. Client.Validity – chyba ověření validity dokumentu. Client.WellFormedness – chyba ověření správného strukturování dokumentu. Server.Program – interní chyba serverové aplikace Server.Service – obecná chyba serverové služby Client.Validity.Schema (chyba validace pomocí XML Schema) Třídy chyb Client a Server znamenají generické třídy chyb. Obvykle se samostatně nevyskytnou a jsou používány s extenzí; nic však v indikovaných případech nebrání jejich použití. Název souboru: Dokumentace rozhraní poskytování dat ISoISVS_20000_100 Copyright © ASD Software, s.r.o., 2012
6
Vypracováno pro MV
IS o ISVS
Seznam chybových kódů bude využit jak v elementu validačních šablon.
,
tak i případně ve výstupních dokumentech
Webová služba IS o ISVS může vložit k aktuální chybě doplňující informaci. Pokud je doplňující informace použita, bude vložena do subelementu odpovědi SOAP. 3.6.1 Chyby na úrovni přenosového protokolu HTTPS Chyby na úrovni přenosového protokolu HTTPS budou řešeny standardními mechanismy protokolu a sítí. Služba se nebude pokoušet zpracovat žádnou zprávu, u níž došlo k selhání přenosu na úrovni základního protokolu, ani nebude generovat zvláštní chybové zprávy. Služba také nebude zaznamenávat žádnou takovouto zprávu do logu příchozích zpráv. 3.6.2 Chyby při načtení zprávy SOAP Do této třídy chyb patří chyby, vzniklé při načítání SOAP dokumentu. Mohou to být chyby způsobené špatným formátováním dokumentu nebo neodpovídajícím jmenným prostorem SOAP 1.1. Tyto zprávy již budou logovány. Na klienta bude odeslána pouze chybová zpráva ve formátu SOAP. Chybový kód je v tomto případě VersionMismatch (chybný jmenný prostor SOAP) nebo Client.WellFormedness (chyby správné struktury dokumentu). 3.6.3 Chyby na úrovni validace pomocí XML Schema Při výskytu chyby na úrovni validace pomocí XML Schema je zpráva odmítnuta jako celek. Je odeslána chybová zpráva ve formátu SOAP; chybový kód je v tomto případě Client.Validity.Schema. 3.6.4 Chyby na úrovni aplikační Tyto chyby se týkají např. selhání aplikační databáze IS o ISVS, narušení referenční integrity či primárních klíčů aplikační databáze. Při výskytu chyby na úrovni validace pomocí vnitřní logiky aplikace IS o ISVS budou zprávy odmítány jako celek. Chybová zpráva ve formátu SOAP je odeslána zpět klientovi. Obecný chybový kód je v tomto případě Client.Validity.Application. Tento chybový kód bude extendován podle zásad, uvedených v [1], kap. 5.8.1. 3.6.5 Opakování chybných dotazů Za zopakování chybných dotazů je zodpovědný odesílatel zprávy.
Název souboru: Dokumentace rozhraní poskytování dat ISoISVS_20000_100 Copyright © ASD Software, s.r.o., 2012
7
Vypracováno pro MV
IS o ISVS
4 Specifikace přenášených dat V této části jsou specifikována přenášená data. Veškerá data, přenášená ve zprávách služby IS o ISVS, vycházejí z datových prvků ISVS, publikovaných v informačním systému o datových prvcích (IS DP). Pokud je datový prvek, definovaný v IS DP a publikovaný v XML schématech IS DP, možno použít přímo, je na takový prvek přímý odkaz ve schématech zpráv. V jednotlivých skupinách datových typů, uvedených dále v kapitole 4.1, jsou uvedeny jen ty datové typy, vyskytující se při komunikaci se službou IS o ISVS.
4.1 Datové typy, používané službou IS o ISVS V této kapitole jsou uvedeny veškeré datové typy, používané při komunikaci se službou IS o ISVS. 4.1.1 Základní bezvýznamové datové typy ISVS Základní bezvýznamové datové typy ISVS jsou používány pro XML schémata jednoduchých a komplexních datových typů ISVS a v rámci celého systému IS VS ČR. Satové typy vznikly na základě a s využitím filosofie schématu Core Component Types UBL (Universal Business Language). Ze základních datových typů vycházejí všechny ostatní datové typy ISVS, publikované v IS DP. XML schéma základních datových typů je dostupné na adrese http://www.sluzbyisvs.cz/isdp/xsd/CoreComponentTypes.xsd. Název
Typ
IdentifikatorType
xs:string
TextType
xs:string
Znakový obecně ve formátu volného textu i více slov; volitelně spolu s doplňkovou informací o jazyku.
DatumCasType
xs:string
Hodnota konkrétního bodu v časové ose volitelně spolu s doplňkovou informací o formátu údaje. Používá se pro datum a/nebo čas.
Popis Znakový řetězec jednoznačně identifikující instanci příslušného objektu od ostatních objektů v rámci jednoho identifikačního schématu; volitelně spolu s doplňkovými informacemi o údaji.
4.1.2 Obecné datové typy ISVS Obecné datové typy ISVS představují definice jednoduchých i složených datových prvků, používaných pro ostatní XML schémata ISVS včetně ostatních schémat datových prvků a v rámci celého systému ISVS ČR. Na rozdíl od bezvýznamových datových typů již většinou nesou konkrétní význam. Jsou používány napříč oblastmi veřejné správy. XML schéma obecných datových typů je dostupné na adrese http://www.sluzbyisvs.cz/isdp/xsd/isvs_common.xsd. Název
Typ
Od Do Maska Popis \d{4}-((02-([0][19]|[1Datum vyjadřuje den, měsíc, rok 2]\d))|(04|06|09|11 příslušného aktu, k němuž se DatumXMLType cct:DatumCasType 10 10 )-(30|[0][1-9]|[1vztahuje. Prezentace data odpovídá 2]\d)|(01|03|05|07| formátu xs:date XML Schema. 08|10|12)(30|31|[0][1-9]|[1Název souboru: Dokumentace rozhraní poskytování dat ISoISVS_20000_100 Copyright © ASD Software, s.r.o., 2012
8
Vypracováno pro MV
IS o ISVS
2]\d))
4.1.3 Datové typy ISVS pro popis ekonomického subjektu Tyto datové typy ISVS jsou používány pro identifikaci a popis ekonomického subjektu. XML schéma datových typů ekonomického subjektu je dostupné na adrese http://www.sluzbyisvs.cz/isdp/xsd/isvs_business.xsd. Název
Typ
Od Do Maska
SubjektICOType cct:IdentifikatorType 8
SubjektObchodniJ cct:TextType menoType
1
8
\d{8}
Popis Identifikační číslo (IČ) je číslicový pořadový kód, který slouží k jednoznačné identifikaci ekonomických subjektů. Ekonomickým subjektem je každá právnická osoba a dále fyzické osoby, které mají podle zvláštního předpisu postavení podnikatele. Obchodním jménem se rozumí název, pod kterým podnikatel činí právní úkony při své podnikatelské činnosti. Obchodní jméno fyzické osoby je její jméno a příjmení, popř. dodatek, odlišující osobu podnikatele nebo druh podnikání. Obchodní jméno obchodních společností a družstev je název, pod kterým jsou zapsány v obchodním rejstříku resp. živnostenském rejstříku. Součástí obchodního jména právnické osoby je i dodatek označující jejich právní formu. Obchodním jménem právnické osoby, která se nezapisuje do obchodního rejstříku, je název, pod kterým byla zřízena..
255
4.1.4 Datové typy ISVS pro popis ISVS Tyto datové typy ISVS jsou používány pro identifikaci a popis informačního systému veřejné správy. XML schéma datových typů informačního systému veřejné správy je dostupné na adrese http://www.sluzby-isvs.cz/isdp/xsd/isvs_isvs.xsd. Název
Typ
Od Do Maska
InformacniSystem cct:IdentifikatorType 7 IdentifikatorType
7
InformacniSystem cct:IdentifikatorType 1 NazevType
255
\d{1,7}
Název souboru: Dokumentace rozhraní poskytování dat ISoISVS_20000_100 Copyright © ASD Software, s.r.o., 2012
Popis Unikátní identifikační kód v systému, který přiděluje ministerstvo; přidělován je každému ISVS. Jedná se o bezvýznamový identifikátor ve formátu celého čísla. Název ISVS, který používá správce daného systému. 9
Vypracováno pro MV
IS o ISVS
InformacniSystem cct:IdentifikatorType 1 VerzeType
25
Verze daného ISVS, odpovídající aktuálnímu zápisu v IS o ISVS.
InformacniSystem bus:SubjektObchodniJ 1 SpravceType menoType
255
Název orgánu veřejné správy, který je správcem ISVS.
4.2 Předání seznamu ISVS 4.2.1 Zpráva požadavku výpisu seznamu ISVS Název kořenového elementu zprávy: VypisISVSPozadavek Seznam subelementů: Název VypisOdDatum Popis
struktury
Typ/Odkaz cmn:DatumXMLType zprávy
je
definován
Min. vyskyt Max. vyskyt 0 1 schématem
zprávy,
dostupným
na
URL
adrese
http://www.sluzby-isvs.cz/ISoISVS/schemas/ISVS_request.xsd 4.2.1.1 Validace pomocí schématu
Zpráva je validována schématem, dostupným na URL adrese http://www.sluzby-isvs.cz/ISoISVS/schemas/ISVS_request.xsd
4.2.2 Odpověď služby IS o ISVS Zpráva přenáší odpověď po přijetí požadavku na výpis seznamu ISVS. Název kořenového elementu zprávy: VypisISVSOdpoved Seznam subelementů: Nazev
Typ/Odkaz
Min. vyskyt Max. vyskyt
ISVSSeznam
1
1
ISVS
0
n
Identifikator
isvs:InformacniSystemIdentifikatorType
1
1
Nazev
isvs:InformacniSystemNazevType
1
1
Verze
isvs:InformacniSystemVerzeType
1
1
SpravceNazev
isvs:InformacniSystemSpravceType
1
1
SpravceIC
bus:SubjektICOType
1
1
PlatnostOdDatum
cmn:DatumXMLType
1
1
Popis
struktury
zprávy
je
definován
schématem
zprávy,
dostupným
na
URL
adrese
http://www.sluzby-isvs.cz/ISoISVS/schemas/ISVS_response.xsd 4.2.2.1 Validace pomocí schématu
Zpráva je validována schématem, dostupným na URL adrese http://www.sluzby-isvs.cz/ISoISVS/schemas/ISVS_response.xsd
Název souboru: Dokumentace rozhraní poskytování dat ISoISVS_20000_100 Copyright © ASD Software, s.r.o., 2012
10
IS o ISVS
Vypracováno pro MV
5 Detailní pravidla přenosu zpráv Tato část dokumentace upřesňuje, jak zprávy, definované v části specifikace dat (4), jsou přenášeny v souladu s technickou specifikací (3). Detailní pravidla přenosu zpráv pro každý typ přenášené zprávy stanoví striktní pravidla životního cyklu zprávy. Životní cyklus zprávy na straně služby lze podrobně rozepsat v následujících bodech: 1. Odesílající strana (např. klient RPP) vygeneruje zprávu, přenášející data dotazu. 2. Klient se prostřednictvím sítě Internet spojí protokolem HTTPS se službou na adrese https://www.sluzbyisvs.cz/ISoisvs/isoisvs.svc a odešle zprávu. Pokud dojde k selhání přenosu na úrovni protokolu HTTPS, služba negeneruje chybovou zprávu SOAP (nemusí k ní zpráva dorazit). Indikace chybového stavu bude provedena standardními postupy pro daný protokol. V tomto případě musí detekovat problém odesílatel a odeslat případně zprávu znovu. 3. Zpráva je přijata službou a je možno odeslat chybovou zprávu klientovi. Selže-li převzetí zprávy službou z důvodů chyby přijímající aplikace, je klientovi zaslána chybová zpráva SOAP s chybovým kódem Server.Program. Příchozí zpráva je odmítnuta jako celek. Selže-li převzetí zprávy službou z důvodů chyby ve zprávě, je klientovi zaslána chybová zpráva SOAP s chybovým kódem Client.General. Příchozí zpráva je odmítnuta jako celek. 4. Obálka SOAP je načtena parserem. Selže-li parsování zprávy službou z důvodů chyby přijímající aplikace, je klientovi zaslána chybová zpráva SOAP s chybovým kódem Server.Program. Příchozí zpráva je odmítnuta jako celek. Selže-li parsování zprávy službou z důvodů porušení pravidla správného formátování, je klientovi zaslána chybová zpráva SOAP s chybovým kódem Client.WellFormedness. Příchozí zpráva je odmítnuta jako celek. Selže-li parsování zprávy službou z důvodů porušení pravidla verze jmenného prostoru SOAP, je klientovi zaslána chybová zpráva SOAP s chybovým kódem VersionMismatch. Příchozí zpráva je odmítnuta jako celek. 5. Zpráva je validována proti schématu. Selže-li tento krok z důvodů chyby přijímající aplikace, je klientovi zaslána chybová zpráva SOAP s chybovým kódem Server.Program. Příchozí zpráva je odmítnuta jako celek. Selže-li tento krok z důvodů chyby validace schématem, je klientovi zaslána chybová zpráva SOAP s chybovým kódem Client.Validity.Schema. Příchozí zpráva je odmítnuta jako celek. 6. Zpráva je zpracována procedurami přijímající aplikace IS o ISVS a je vygenerována odpověď. Selže-li tento krok z důvodů chyby přijímající aplikace, je klientovi zaslána chybová zpráva SOAP s chybovým kódem Server.Program. Příchozí zpráva je odmítnuta jako celek. 7. Klientovi je zaslána standardní zpráva SOAP s odpovědí.
Chování klientské strany v případě komplikací s přenosem se bude řídit podle logiky, uvedené v následujícím odstavci. Za zopakování přenosu je vždy zodpovědný odesílatel zprávy. V zásadě může odesílající strana detekovat tyto situace: 1. Služba vrátila požadovaná data. V tomto případě je zpracování v pořádku, není vyžadována žádná další akce. Název souboru: Dokumentace rozhraní poskytování dat ISoISVS_20000_100 Copyright © ASD Software, s.r.o., 2012
11
Vypracováno pro MV
IS o ISVS
2. Služba vrátila potvrzení chybného přijetí zprávy nebo potvrzení chybného zpracování zprávy, kdy zpráva je odmítnuta jako celek. Chování klientské strany se řídí v tomto případě kódem chyby v elementu . Kód Server.Program - v tomto případě klientská strana zopakuje zprávu znovu se stejným obsahem jako v původní zprávě. Kód Client.General - v tomto případě klientská strana odstraní nedostatky ve zprávě, upřesněné v elementu obálky SOAP, a odešle opravenou zprávu znovu s odlišným obsahem. Kód Client.WellFormedness - v tomto případě klientská strana odstraní nedostatky ve zprávě a odešle opravenou zprávu znovu s odlišným obsahem jako v původní zprávě. Kód VersionMismatch - v tomto případě klientská strana odstraní nedostatky ve zprávě a odešle opravenou zprávu znovu s odlišným obsahem jako v původní zprávě. Kód Client.Validity.Schema - v tomto případě klientská strana odstraní nedostatky ve zprávě a odešle opravenou zprávu znovu s odlišným obsahem jako v původní zprávě. 3. Služba nevrátila žádnou zprávu V tomto případě klientská strana zopakuje zprávu znovu se stejným obsahem jako v původní zprávě.
6 Změny oproti předchozí verzi Č.
Popis změny
Název souboru: Dokumentace rozhraní poskytování dat ISoISVS_20000_100 Copyright © ASD Software, s.r.o., 2012
Verze
Datum
12
IS o ISVS
Vypracováno pro MV
Reference 6.1 Reference [1] Standardy komunikace na bázi XML XML - Standardy komunikace na bázi XML - Použití ve finančních a podpůrných informačních systémech. Verze 3.00 ASD Software, s.r.o. 2004. Viz. http://www.mfcr.cz/download/xml/xmlkomunikace.zip [2] Metodika XML schémat ISVS Metodika tvorby XML schémat v oblasti informačních systémů veřejné správy. Ministerstvo informatiky ČR, 25.ledna 2004 URL: http://www.mvcr.cz/clanek/metodika-tvorby-xml-schemat-v-oblasti-informacnich-systemu-verejnespravy.aspx
6.2 Použité pojmy Dokument definice sluţby (service description document) – dokument, obsahující popis služby, který je využitelný klientskou aplikací pro automatické navázání spojení se službou. Sestává se z popisu rozhraní, sémantiky a popisu zpráv, vyměňovaných během scénáře výměny zpráv. Důvěrnost (confidentiality) – charakteristika informace, která znemožňuje odhalení informace neautorizovanou entitou. Informační systém – funkční celek nebo jeho část zabezpečující cílevědomou a systematickou informační činnost. Každý informační systém zahrnuje data, která jsou uspořádána tak, aby bylo možné jejich zpracování a zpřístupnění, a dále nástroje umožňující výkon informačních činností. Informační systém veřejné správy (ISVS) – ve smyslu zákona č. 365/2000 Sb., o informačních systémech veřejné správy nebo dle kontextu více informačních systémů veřejné správy ve smyslu tohoto zákona. Interoperabilita (interoperability) – schopnost informačního systému využívat funkčnost jiných informačních systémů a/nebo poskytovat vlastní funkčnost pro využití jinými informačními systémy. Odesílatel zprávy (message sender) – agent, vytvářející a odesílající zprávu Příjemce zprávy (message recipient) – agent, stanovený odesílatelem zprávy jako adresát (consumer) zprávy. Poskytovatel sluţby (service provider) – subjekt, poskytující službu Scénář výměny zpráv (message exchange pattern) – minimální sada zpráv, zahrnující jak zprávy odesílatele zpráv, tak příjemce zpráv, vyměňovaná během jednoho použití služby. Sémantika (semantics) – význam, smysl či faktický obsah nějakého konceptu. Sluţba (service) – sada úkolů, tvořící z pohledu poskytovatele služby i žadatele služby jeden celek. Subjekt – entita s právní subjektivitou (právnická či fyzická osoba). Syntaxe (syntax) – způsob zápisu určité informace. Sémanticky identický popis entity (např. datové) může být zapsán v různé syntaxi (např. v relačním modelu, hierarchickém modelu) Webová sluţba (web service) – softwarová aplikace, identifikovaná pomocí URI, jejíž veřejná rozhraní jsou definována a popsána pomocí XML. Jiné aplikace mohou interagovat s webovou službou způsobem předepsaným její definicí pomocí zpráv XML, předávaných pomocí internetových protokolů.
Název souboru: Dokumentace rozhraní poskytování dat ISoISVS_20000_100 Copyright © ASD Software, s.r.o., 2012
13
Vypracováno pro MV
IS o ISVS
Zpráva (message) – základní jednotka výměny dat mezi agenty (odesílatelem zprávy a příjemcem zprávy). Ţadatel (service requester) – subjekt nebo jiná entita, dotazující se na službu.
6.3 Použité zkratky BOM DTD HTML HTTP HTTPS IETF IS IS DP IS o ISVS ICT ISVS RDF SOAP UBL URI URL URN W3C WS WSDL WWW XML
XSLT
Byte Order Mark Document Type Definition Hypertext Markup Language HyperText Transfer Protocol. HyperText Transfer Protocol Secure Internet Engineering Task Force
Informační systémy Informační systém datových prvků Informační systém o informačních systémech veřejné správy Informační a komunikační technologie Informační systémy veřejné správy Resource Description Format Simple Object Access Protocol Universal Business Language Uniform Resource Identifier Uniform Resource Locators Uniform Resource Names World Wide Web Consortium Web Services Web Services Description Language World Wide Web Extensible Markup Language Extensible Stylesheet Language for Transformations
Název souboru: Dokumentace rozhraní poskytování dat ISoISVS_20000_100 Copyright © ASD Software, s.r.o., 2012
14