Specifikace služby IS CEDR pro poskytování informací z IS CEDR III, veřejná část

Transkript

1 PRO INTERNÍ POTŘEBU Specifikace služby IS CEDR pro poskytování informací z IS CEDR III, veřejná část vypracovala společnost ASD Software, s.r.o. dokument ze dne , verze 1.00

2 Specifikace služby IS CEDR pro poskytování informací z IS CEDR III, veřejná část Počet stran v dokumentu celkem : 22 Rozdělovník : Číslo Počet výtisků Předáno Převzal 1 1 x MF, odbor 38 Ing. Hana Domínová Copyright ASD Software, s.r.o.,

3 OBSAH 1. ÚVOD USE-CASE STUDIE TECHNICKÉ ŘEŠENÍ PŘENOSOVÝ FORMÁT DAT VALIDACE A POPIS XML DOKUMENTŮ XML Schema Jmenné prostory TRANSPORTNÍ PROTOKOLY Základní transportní protokol Adresa služby SOAP protokol MODEL PŘENOSU ZPRÁV POPIS SLUŽBY VE FORMÁTU WSDL ŘEŠENÍ BEZPEČNOSTI ZPRACOVÁNÍ CHYB Chyby na úrovni přenosového protokolu HTTP Chyby při načtení zprávy SOAP Chyby vzniklé exspirací zprávy Chyby na úrovni validace pomocí XML Schema Chyby na úrovni aplikační POPIS PŘEDÁVANÝCH DAT USTANOVENÍ PRO DEFINICI PLATNOSTI ELEMENTŮ PŘEDÁVÁNÍ INFORMACÍ Z IS CEDR III Popis schémat SLUŽBA POSKYTUJÍCÍ VEŘEJNÉ ÚDAJE Dotaz na veřejné údaje Atributy dotazu Atribut pole ObchodníJmeno Odpověď na veřejné údaje PříjemceDotace - identifikace subjektu Obchodní jména Adresa sídla subjektu Adresa kódy Objekt číslo domovní Adresa text Projekt Finanční částky zdroj Atributy odpovědi Finanční částka období Částky uvolněné Platba Částky čerpané Částky vrácené Kalendář splátek Splátky plánované Splátky skutečné...17 Copyright ASD Software, s.r.o.,

4 5. PODROBNÝ POPIS ŽIVOTNÍHO CYKLU ZPRÁV DOTAZY NA DATABÁZI IS CEDR III PŘÍLOHY ADRESA SLUŽBY STRUKTURA XMLSCHEMA PRO VEŘEJNÝ DOTAZ STRUKTURA XMLSCHEMA PRO ODPOVĚĎ NA VEŘEJNÝ DOTAZ REFERENCE NÁVRHY PRO DALŠÍ VERZE SLUŽBY...22 Copyright ASD Software, s.r.o.,

5 1. Úvod Tato dokumentace obsahuje popis služby IS CEDR, poskytující informace o evidovaných dotacích a příjemcích dotací v IS CEDR III. Tento materiál popisuje automatickou HTTP službu, která na základě předaných požadavků vrací zpět uživateli požadované informace o příjemcích dotací a jejich dotacích ze státního rozpočtu, státních fondů a prostředků EU. Poskytovatelem této služby je Ministerstvo financí, v jehož plné kompetenci je také definice popisované služby. Vlastní řešení je rozděleno na dvě samostatné služby, první poskytuje veřejné informace a je přístupná bez omezení, druhá služba poskytuje komplexní informace a oprávněnost přístupu ke službě se ověřeje certifikátem. V této podobě se jedná o pracovní materiál, od konečné podoby se tento dokument může lišit úpravami, které jsou reakcí na optimální realizaci služeb v tomto dokumentu popsaných. Předpokladem je, že služba bude využívána řadou klientských aplikací; proto jsou zvoleny taková architektonická řešení a technologie, které umožní relativně jednoduché dosažení interoperability (Serviceoriented architektura, XML formát dat, webové služby). Copyright ASD Software, s.r.o.,

6 2. Use-case studie Služba na straně IS CEDR bude podporovat možnost vznášení dotazů na uložená data v IS CEDR tak, jak je uvedeno na obr. 1: Dotaz na službu CEDR Zpracování dotazu CEDR Klient služby Odpověď služby CEDR Obr. 1 Dotazy klientů na databázi IS CEDR V tomto případě (obr. 1) probíhají globální procesy následujícícm způsobem: 1. Na straně klienta je vygenerována zpráva, obsahující dotaz na aplikaci IS CEDR III. Spuštění přenosu se děje ad hoc uživatelem; to znamená, že neexistuje časový plán dotazů. 2. Zpráva (dotaz) je opatřena všemi náležitostmi dle této specifikace a je odeslána pomocí protokolu HTTP na adresu aplikace IS CEDR III (bude upřesněna po dokončení realizace služby). Spojení mezi komunikujícími stranami není přerušeno. 3. Aplikace IS CEDR III přijme dotaz a zpracuje jej v souladu s pravidly, stanovenými v této specifikaci. Zpět klientské straně odešle zprávu o výsledku zpracování dotazu. Copyright ASD Software, s.r.o.,

7 3. Technické řešení 3.1 Přenosový formát dat Jako formát pro přenos dat bude použit standard XML 1.0, Second Edition [2]. Přenášené XML dokumenty musejí splňovat všechny požadavky standardu. 3.2 Validace a popis XML dokumentů XML Schema Veškeré přenášené XML zprávy mají pro účely validace vytvořen popis formátu zprávy dle standardu SAML 2.0 [4]. Validace XML dokumentů dle XML Schema [3] bude prováděna vždy při převzetí zprávy službou. Také veškeré odchozí zprávy služby musejí být před odesláním validovány. Všechny předávané zprávy XML musejí mít v kořenovém elementu dokumentu deklarován jmenný prostor schématu daného dokumentu. Pomocí atributu xsi:schemalocation musí být také uvedena fyzická lokalizace schématu. Chybějící jmenný prostor nebo lokalizace schématu ve zprávě je důvodem k odmítnutí zprávy, i když bude jinak vyhovovat schématu Jmenné prostory Všechny jmenné prostory schémat, popisujících přenášené XML dokumenty popisované služby, budou ve formátu URN. 3.3 Transportní protokoly Základní transportní protokol Základním transportním protokolem pro popisovanou službu bude protokol HTTP. Komunikace při přenosu zpráv mezi klientem a službou nebude přerušena, dotaz a přenos odpovědi služby ke klientovi proběhne tedy v rámci jednoho spojení Adresa služby Adresa služby je dána od používané verze služby a schémat. Výčet adres je uveden v kapitole SOAP protokol Nad protokolem HTTP bude použit rozšiřující XML protokol SOAP ve verzi 1.1 [1]. Struktura zpráv při použití SOAP protokolu je dána specifikací [4]. 3.4 Model přenosu zpráv Jako model pro přenos zpráv bude použit model request-response. Vzhledem k on-line komunikaci nejsou implementovány informativní zprávy služby. 3.5 Popis služby ve formátu WSDL Služba IS CEDR III, přebírající dotazy, bude popsána ve formátu WSDL. Soubor WSDL bude umístěn na adrese Řešení bezpečnosti Pro veřejnou službu nebudou implementovaný žádné bezpečností prostředky. Copyright ASD Software, s.r.o.,

8 3.7 Zpracování chyb Zpracování chyb bude ošetřeno v souladu se zásadami uvedenými ve specifikaci [4] a [5] Chyby na úrovni přenosového protokolu HTTP Chyby na úrovni přenosového protokolu HTTP 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 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. Na klienta bude odeslána pouze chybová zpráva ve formátu SOAP Chyby vzniklé exspirací zprávy Tyto chyby jsou způsobeny vypršením lhůty v elementech WS-security utility v elementu <wsu:timestamp> nebo špatnou synchronizací časů jak na straně serveru tak na straně Agenta. Zpráva je odmítnuta jako celek. Chybová zpráva ve formátu SOAP je odeslána klientovi. Chybový kód je v tomto případě soap:server 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. ErrorText Dokument není validní Chyby na úrovni aplikační Tyto chyby se týkají např. selhání aplikační databáze CEDR, 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 CEDR bude v této verzi dotaz odmítnut. Chybová zpráva ve formátu SOAP je odeslána zpět klientovi. Obecný chybový kód je v tomto případě soap:server. Copyright ASD Software, s.r.o.,

9 4. Popis předávaných dat 4.1 Ustanovení pro definici platnosti elementů Zkratka I P N Význam Nebere se v úvahu (ignore) Povinné Nepovinné Označení povinnosti předávání jednotlivých elementů a v nich předávaných dat je uvedeno v následující tabulce. První znak v použité zkratce udává povinnost elementu, druhý udává platnost dat nebo-li hodnotu elementu. Zkratka Význam Podrobný popis PP Povinný Element Povinná Data Element i data jsou povinná NP Nepovinný Element Povinná Data Element je volitelný ale pokud je uveden jsou povinná i data. NN Nepovinný Element Nepovinná Data Pokud je element uveden není nutné uvádět data. To je vhodné např. pro UPDATE kdy je zapotřebí hodnotu přepsat. Nejsou-li data u elementu uvedena je nutné nastavit atribut null na hodnotu true. NI Nepovinný Element Ignorují se Data Element je nepovinný, ale pokud bude uveden data budou ignorována. Např. při operaci DELETE je nutný pouze primární klíč a ostatní hodnoty jsou ignorovány. 4.2 Předávání informací z IS CEDR III Popis schémat Pro veřejnou část služby jsou definována dvě schémata. Jedno schéma je využíváno při dotazu na IS CEDR III a druhé při návratu odpovědi. 4.3 Služba poskytující veřejné údaje Jedná se o webovou službu, která uživateli poskytuje veřejné informace o subjektech a dotacích těchto subjektů evidovaných v IS CEDR III Dotaz na veřejné údaje Služba podporuje tři typy dotazů v závislosti na zvoleném klíči pro vyhledávání. Lze zvolit vyhledávání dle ICO nebo obchodního jména nebo dle kombinace jména a příjmení osoby. Pro dotaz na získání kontrolních informací je vytvořeno schéma 6.2, které obsahuje následující datové položky : Poř.č. Jméno položky Typ Node Typ Platnost 1 ICO bus:subjekticotype Element NP* 2 ObchodniJmeno ObchodniJmenoType Element NP* 3 Prijmeni per:osobaprijmenitype Element NP* 4 Jmeno per:osobajmenotype Element NP* Copyright ASD Software, s.r.o.,

10 5 PravniFormaKod bus:subjektpravniformakodtype Element NP 6 PoskytovatelKod fkis:dotaceposkytovatelkodtype Element NP 7 SmlouvaCislo cmn:spiscislojednacitype Element NP 8 RozpoctoveObdobi cmn:roktype Element NP 9 PocetVet xs:int Element NP * alespoň jenda kombinace je zadána dle zvoleného dotazu 1 Identifikační číslo bude mít formát, který stanovují standardy ČR ke dni odsouhlasení této služby. 2 Název subjektu, lze zadat i podřetězec. Minimální délka řetězce je 4 znaky. 3 Příjmení příjemce dotace. 4 Jméno příjemce dotace. 5 Právní forma subjektu, hodnota z číselníku právních forem. 6 Kod poskytovatele dat, hodnota z číselníku poskytovatelů. Subjekt, který je oprávněn poskytovat finanční prostředky. 7 Jednoznačný identifikátor projektu,neinvestiční dotace, akce (rgistrační číslo pro ISPROFIN, číslo projektu pro MSSF). 8 Rok, ve kterém byla dotace poskytnuta. 9 Maximální počet vrácených záznamů pro dotaz implicitně 10, maximálně 100. Pokud počet vyhovujících záznamů vznesené dotazem přesáhne hodnotu maximálního počtu vracených záznamů, bude v odpovědi obsaženo prvních X záznamů, kde X se rovná hodnotě elementu MaxPocetVet. Celkový počet záznamů vyhovující danému dotazu je uveden v odpovědi v samostatném elementu PocetVyhovujicichZaznamu Atributy dotazu Dotaz obsahuje další dodatečné informace v podobě atributů. Atributy dotazu : Poř.č. Jméno položky Typ Platnost 1 davkasestavenidatumcas crd:datumcastype PP 2 validation_xslt crd:davkaxsltvalidationtype NP 1 Datum a čas vytvoření dotazu 2 Umístění dodatečné validační šablony Atribut pole ObchodníJmeno Pro pole ObchodniJmeno lze použít atribut pouzitlike. Tento atribut umožňuje přepínání způsobu vyhledávání obchodního jména v databázi. Defaultně je nastaven na rovno 0, což signifikuje vyhledávání na rovnost. Služba vrací jen záznamy s exaktní hodnotou. Při hodnotě atributu rovno 1,2,3 se použije vyhledávací klauzule Like, která vrací záznamy, kde se hledaný řetězec vyskytuje i jako podřetězec. Poř.č. Jméno položky Typ Platnost 1 pouzitlike xs:boolean NP 1 Volba vyhledávání hledané hodnoty v poli ObchodniJmeno. Defaultně rovno 0. Význam hodnoty: 0 - přesný výraz 1 - like z obou stran, viz *hl.hodnota* 2 - like zprava, viz hl.hodnota* Copyright ASD Software, s.r.o.,

11 3 - like zleva, viz *hl.hodnota Odpověď na veřejné údaje Pro odpověď na výše definovaný dotaz na získání kontrolních informací je vytvořeno schéma 6.3, které obsahuje následující datové položky : 1 PocetVyhovujicichZaznamu xs:int Element 1 PP 2 PrijemciDotaci PrijemceDotaceStructure Structure NP 1 Počet záznamů vyhovující výběrové podmínce. 2 Seznam příjemců dotací PříjemceDotace - identifikace subjektu 1 ICO bus:subjekticotype Element 0..1 NP* 2 ObchodniJmena ObchodniJmenaStrukture Structure 0..n NP* 3 Prijmeni per:osobaprijmenitype Element 0..1 NP* 4 Jmeno per:osobajmenotype Element 0..1 NP* 5 SidloAdresa AdresaStructure Structure 0..1 PP 6 PravniFormaKod bus:subjektpravniformakodtype Element 1 PP 7 PravniFormaNazev fkis:subjektpravniformanazevtype Element 1 PP 8 Projekt ProjektStructure Structure 1..n PP * Alespoň jeden, nebo více elementů je uvedeno v závislosti na právní formě subjektu. 1 Identifikační číslo subjektu. 2 Obchodní jména subjektu. Rozdělené dle jazykové mutace. 3 Příjmení subjektu 4 Jméno subjektu 5 Zde je uvedena adresa subjektu. Pro právnicé osoby se uvádí sídlo firmy (hodnota kvalifikátoru adresy = 1). U fyzických osob a fyzických osob podnikajících se uvádí trvalé bydliště (hodnota kvalifikátoru adresy = 4). U cizinců (právní forma 421) mohou být uvedeny oba typy adresy. Pokud je uveden StatKod!= 'CZ' a typ právní formy je 1 nebo 2 bude v SidleAdresa očekáván typ adresy 4. Při insertu je element povinný a závisí na typu právní formy. Při modifikaci je nepovinný. 6 Právní forma subjektu podle číselníku PF 7 Název pravní formy podle číselníku PF 8 Seznam projektů Každý uzel PrijemceDotace obsahuje atribut ID. Tento atribut identifikuje jednotlivé příjemce dotace v rámci skupiny vyhovujících záznamů v uzlu PrijemciDotaci. Poř.č. Jméno položky Typ Platnost 1 ID xs:int PP 1 Atribut obsahující identifikaci příjemce dotace Copyright ASD Software, s.r.o.,

12 Obchodní jména 1 ObchodniJmeno bus:subjektobchodnijmenotype Element 1 PP 2 jazykkod jazyktype Atribut 1 PP 1 Obchodní jméno příjemce dotace 2 Kód jazyku v němž je zadán název Adresa sídla subjektu 1 AdresaKody AdresaVystupniKodyBaseStructure Structure 0..1 NP* 2 AdresaText ObjektAdresaTextBaseStructure Structure 0..1 NP* * alespoň jedna větev musí být uvedena 1 Adresa zadána kody dle UIR, viz dále Adresa zadána textem, viz dále Adresa kódy 1 AdresaPredavaciKod spa:objektadresapredavacikodtype Element 0..1 NP* 2 AdresaKvalifikatorKod spa:adresakvalifikatorkodtype Element 0..1 NP 3 ShodaKod AdresaShodaKod Element 0..1 NP 4 CastObcePredavaciKod spa:castobcekodtype Element 0..1 NP* 5 MestskaCastPredavaciKod cmn:roktype Element 0..1 NP* 6 ObjektCisloDomovni spa:objektcislodomovnistructure Structure 0..1 NP* 7 UlicePredavaciKod spa:ulicepredavacikodtype Element 0..1 NP* 8 UliceNazev spa:ulicenazevtype Element 0..1 NP* 9 ObjektCisloOrientacni spa:objektcisloorientacnitype Element 0..1 NP* 10 PSC spa:psctype Element 0..1 NP* * Položka 1 nebo položky 4 až 10 jsou vráceny 1 Předávací kód adresy stavebního objektu je jednoznačné číselné vyjádření konkrétních hodnot (výskytů) adresy stavebního objektu ve smyslu vymezení v odst Standardu ISVS k prostorové identifikaci. Předávací kód adresy stavebního objektu je jedinečný v rámci ČR 2 Datový prvek pro upřesnění věcného obsahu adresy. Prvek nabývá věcného významu ve spojení s adresou. Je určen k upřesnění věcného obsahu adresy, tj. toho, co či kdo se nachází na místě určeném adresou, resp. k čemu údaj o adrese slouží.kvalifikátor adresy: 1 adresa organizace, 2 adresa provozní jednotky, 3 pracoviště, 4- trvalé bydliště u fyz.osoby, 5-přechodné bydliště, 9- doručovací adresa. V případě modifikace záznamu bude kód ignorován. 3 Kód shody informací o adrese ověřených v externích systémech 4 Předávací kód části obce je číselný prostorový identifikátor standardního prvku prostorové identifikace "část obce". Standardní prvek prostorové identifikace "část obce" je vymezen v kap. 3 Standardu ISVS k prostorové identifikaci. Předávací kód části obce je určován po vzniku části obce číselníkem v rámci Územně identifikačního registru základních sídelních jednotek, provozovaného v garanci Ministerstva pro místní Copyright ASD Software, s.r.o.,

13 rozvoj. Předávací kód části obce je jedinečný v rámci České republiky. Pozn. Předávací kód části obce vzniká reálně fixací stávajícího kódu části obce (katalogový list AA0056) k počátku roku Tím je umožněn bezproblémový přechod uživatelů z dosud v čase proměnného kódu části obce na v čase neproměnný předávací kód 5 Předávací kód městské části resp. městského obvodu je číselný prostorový identifikátor standardního prvku prostorové identifikace "městská část resp. městský obvod". Standardní prvek prostorové identifikace "městská část resp. městský obvod" je vymezen v kap. 3 Standardu ISVS k prostorové identifikaci. Předávací kód městské části resp. městského obvodu je určen číselníkem. Předávací kód městské části resp. městského obvodu je jedinečný v rámci České republiky. 6 Struktura složená z DruhKod - Kód druhu čísla domovního je číselný kvalifikátor pro upřesnění, zda se jedná o číslo popisné či číslo evidenční.í a Hodnota - Hodnota čísla domovního je společný název pro číselnou hodnotu prostorového identifikátoru AA0065 Číslo popisné a prostorového identifikátoru AA0066 Číslo evidenční. Viz dále Předávací kód ulice a veřejného prostranství je číselný prostorový identifikátor standardního prvku prostorové identifikace "ulice a veřejné prostranství". Standardní prvek prostorové identifikace "ulice a veřejné prostranství" je vymezen v kap. 3 Standardu ISVS k prostorové identifikaci. Předávací kód ulice a veřejného prostranství je jedinečný v rámci České republiky. 8 Název ulice a veřejného prostranství je slovní prostorový identifikátor standardního prvku prostorové identifikace "ulice a veřejné prostranství". Standardní prvek prostorové identifikace "ulice a veřejné prostranství" je vymezen v kap. 3 Standardu ISVS k prostorové identifikaci. Název ulice a veřejného prostranství je určen obcí. Název ulice a veřejného prostranství je jedinečný v rámci obce, ne v rámci České republiky ani okresu. 9 Číslo orientační je číselný prostorový identifikátor standardního prvku prostorové identifikace "stavební objekt", pokud jde o stavební objekt, který je označen číslem orientačním. Standardní prvek prostorové identifikace "stavební objekt" je vymezen v kap. 3 Standardu ISVS k prostorové identifikaci. Číslo orientační je přidělováno rozhodnutím obecního úřadu. Číslo orientační je jedinečné pouze v rámci ulice nebo veřejného prostranství. 10 Datový prvek pro číslicové vyjádření směrovacích údajů, zajišťující dodávání zásilek do objektu v ČR, nebo samostatné poštovní směrovací číslo přidělené organizaci Objekt číslo domovní 1 DruhKod CisloDomovniDruhKodType Element 1 PP 2 Hodnota CisloDomovniHodnotaType Element 1 PP 1 Kód druhu čísla domovního je číselný kvalifikátor pro upřesnění, zda se jedná o číslo popisné či číslo evidenční 2 Hodnota čísla domovního je společný název pro číselnou hodnotu prostorového identifikátoru AA0065 Číslo popisné a prostorového identifikátoru AA0066 Číslo evidenční Adresa text 1 StatKod StatKodType Element 0..1 NP 2 AdresaText spa:adresatexttype Element 0..1 NP 3 AdresaKvalifikatorKod spa:adresakvalifikatorkodtype Element 0..1 NP * alespoň jedna větev musí být uvedena 1 Datový prvek pro kódové označení státu. Pozn.: Kód musí být ve tvaru třímístný abecední. 2 Adresa textem je nestrukturovaný zápis adresy jedním řádkem textu. Používá se v případech, kdy není možno Copyright ASD Software, s.r.o.,

14 dodržet strukturování adres podle požadavků (např. pro zahraniční adresy). 3 Datový prvek pro upřesnění věcného obsahu adresy. Prvek nabývá věcného významu ve spojení s adresou. Je určen k upřesnění věcného obsahu adresy, tj. toho, co či kdo se nachází na místě určeném adresou, resp. k čemu údaj o adrese slouží.kvalifikátor adresy: 1 adresa organizace, 2 adresa provozní jednotky, 3 pracoviště, 4- trvalé bydliště u fyz.osoby, 5-přechodné bydliště, 9 doručovací adresa Projekt 1 ProjektNazev fkis:projektnazevtype Element 0..1 NP 2 SmlouvaCislo cmn:spiscislojednacitype Element 1 PP 3 SmlouvaPodpisDatum cmn:datumxmltype Element 1 PP 4 OperacniProgramKod fkis:operacniprogramkodtype Element 0..1 NP* 5 OperacniProgramNazev fkis:financnirozvahapolozkanazevtype Element 0..1 NP* 6 FinancniCastky FinancniCastkyZdrojStructure Structure 0..n NP 1 Název projektu 2 Jednoznačný identifikátor projektu,neinvestiční dotace, akce (rgistrační číslo pro ISPROFIN, číslo projektu pro MSSF). 3 Datum podpisu smlouvy. 4 Kód operačního programu 5 Název operačního programu 6 Výpis finančních částek dle zdroje. Každý uzel Projekt obsahuje atribut ID. Tento atribut identifikuje jednotlivé projekty v rámci skupiny vyhovujících záznamů v uzlu Projekty. Poř.č. Jméno položky Typ Platnost 1 ID xs:int PP 1 Atribut obsahující identifikaci projektu Finanční částky zdroj 1 FinancniZdrojKod fkis:financnizdrojkodtype Element 1 PP 2 FinancniZdrojNazev fkis:financnizdrojnazevtype Element 1 PP 3 PoskytovatelKod fkis:dotaceposkytovatelkodtype Element 0..1 NP 4 PoskytovatelNazev fkis:dotaceposkytovatelnazevtype Element 0..1 NP 5 InvesticeIndikator fkis:financnicastkainvesticeindikatortype Element 0..1 PP 6 NavratnostIndikator fkis:financnicastkanavratnostindikatortype Element 0..1 PP 7 CastkaRozhodnuta cmn:financnicastkatype Element 1 PP 8 FinancniCastkyObdobi FinancniCastkyObdobiStructure Structure 0..n NP 9 KalendarSplatek KalendarSplatekStructure Structure 0..1 NP 1 Finanční zdroj hodnota z číselníku zdojů finančních prostředků. 2 Název finančního zdroje dle číselníku Copyright ASD Software, s.r.o.,

15 3 Kód poskytovatele čerpaný z číselníku poskytovatelů. 4 Název poskytovatele čerpaný z číselníku poskytovatelů 5 Kód investice: 0 - neinvestiční, 1 investiční 6 Kód návratnosti : 0 - nenávratná,1 - návratná 7 Výše přiznaných finančních prostředků (dle rozhodnutí) pro období. 8 Struktura finančních částek dle období 9 Struktura obsahuje informace o splátkovém kalendáři pro daného přijemce dotace Atributy odpovědi Struktura odpovědi obsahuje dodatečné informace v podobě atributů elementu. Poř.č. Jméno položky Typ Platnost 1 davkasestavenidatumcas crd:datumcastype PP 2 validation_xslt crd:davkaxsltvalidationtype NP 1 Datum a čas vytvoření odpovědi. 2 Umístění dodatečné validační šablony Finanční částka období Poř.č. Jméno položky Typ Node Typ Násobnost Platnost 1 DotaceTitulKod fkis:dotacetitulkodtype Element 0..1 NP 2 DotaceTitulNazev fkis:dotacetitulnazevtype Element 0..1 NP 3 RozpoctoveObdobi cmn:roktype Element 1 PP 4 CastkaSpotrebovana cmn:financnicastkatype Element 0..1 NP 5 CastkyUvolnene FinancniCastkyUvolnenaStructure Structure 0..n NP 6 CastkyCerpane FinancniCastkyCerpanaStructure Structure 0..n NP 7 CastkyVracene FinancniCastkyVracenaStructure Structure 0..n NP 1 Kód dotačního titulu. 2 Název dotačního titulu. 3 Období v kterém byla dotace poskytnuta 4 Výše účelně vynaložených poskytnutých finančních prostředků. 5 Struktura s informacemi o uvolněných částkách v daném období. 6 Struktura s informacemi o čerpaných částkách v daném období. 7 Struktura s informacemi o vrácených částkách v daném období Částky uvolněné 1 UvolneniDatum cmn:datumxmltype Element 1 PP 2 OperaceDruhKod fkis:operacedruhkodtype Element 0..1 NP 3 DoplatekIndikator fkis:doplatekindikatortype Element 1 PP 4 Platba PlatbaStructure Structure 1 PP 1 Datum uvolnění finančních prostředků. 2 Příznak, jde-li o vystavení limitky nebo převod prostředků (0-limit, 1-čerpání). 3 Příznak doplatku - vyjadřuje skutečnost, kdy příjemci byla přiznána nějaká výše prostředků podle určité Copyright ASD Software, s.r.o.,

16 smlouvy, ale nebyla vyčerpána celá z prostředků běžného roku a rozdíl mezi poskytnutou a čerpanou částkou se vyplácí z prostředků následujícího roku podle původní smlouvy. 4 Struktura s informacemi kdy z jakého účtu a na jaký účet byla částka uvolněna Platba 1 CastkaVyse cmn:financnicastkatype Element 1 PP 2 SplatnostDatum cmn:datumxmltype Element 0..1 NP 1 Výše částky 2 Datum splatnosti platby Částky čerpané 1 CerpaniDatum cmn:datumxmltype Element 0..1 NP 2 CastkaVyse cmn:financnicastkatype Element 0..1 NP 1 Datum, kdy byla částka čerpána. 2 Výše čerpané částky Částky vrácené 1 VraceniDatum cmn:datumxmltype Element 0..1 NP 2 CastkaVyse cmn:financnicastkatype Element 0..1 NP 1 Datum, kdy byla částka vrácena. 2 Výše čerpané částky Kalendář splátek 1 UroceniIndikator fkis:kalendarsplatekuroceniindikatortype Element 0..1 NP 2 SplatkyPlanovane SplatkyPlanovaneStructure Structure 0..n NP 3 SplatkySkutecne SplatkySkutecneStructure Structure 0..n NP 1 Indikátor úročení částek platebního kalendáře. 2 Struktura s informacemi o naplánovaných splátkách pro daného příjemce dotace. Počet splátek skutečných nemusí souhlasit s počtem splátek naplánopvaných. 3 Struktura s informacemi kdy daný příjemce dotace splatill naplánované částky a v jaké výši platbu provedl. Počet splátek skutečných nemusí souhlasit s počtem splátek naplánopvaných. Copyright ASD Software, s.r.o.,

17 Splátky plánované Struktura přebírá strukturu Platby Splátky skutečné Struktura přebírá strukturu Platby. Copyright ASD Software, s.r.o.,

18 5. Podrobný popis životního cyklu zpráv 5.1 Dotazy na databázi IS CEDR III Tato kapitola je zpřesněním kapitoly 2. tohoto dokumentu s přihlédnutím ke kapitole 3. Technické řešení. Popisuje detailně procesy při přenosu zpráv včetně ošetření chybových stavů. Řešení je možno popsat následujícím blokovým schématem: Start generování dotazu Agentem Zpráva s dotazem na službu SP odeslání dotazu na službu SP přijem zprávy službou SP Ano Ne Obsahuje zpráva elementy WSaddressing? Ano Ne Obsahuje zpráva elementy time stamp? Ano chybová zpráva generování chybové zprávy Ano Zpráva expirovala? Ne Ne Je podporován daný typ dotazu? generování odpovědi službou SP Zpracování dotazu na službou SP Ano zpráva s odpovědí odeslání odpovědi Agentovi Konec Obr.2 Podrobný popis životního cyklu zpráv - dotazy na databázi IS CEDR Copyright ASD Software, s.r.o.,

19 Životní cyklus zprávy na straně služby, vyjádřený na obr.2, lze podrobně rozepsat v následujících bodech: 1. Odesílající strana (Agent) vygeneruje zprávu s dotazem na službu. 2. Agent se prostřednictvím sítě Internet / intranet spojí protokolem HTTPS se službou na adrese uvedené v kapitole [Chyba! Nenalezen zdroj odkazů.] 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. Pokud je zpráva přijata službou je možno provést vstupní kontroly a je možno odeslat chybovou zprávu Agentovi. 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 soap:server. 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 soap:server. 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 tato chyba indikována pomocí HTTP protokolu chybovým kódem 400 Bad request. 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 tato chyba indikována pomocí HTTP protokolu chybovým kódem 400 Bad request. Příchozí zpráva je odmítnuta jako celek. Pokud zpráva neobsahuje elementy wsa:action, wsa:messageid, wsa:to je klientovi tato chyba indikována pomocí HTTP protokolu chybovým kódem 400 Bad request. Příchozí zpráva je odmítnuta jako celek. Pokud zpráva neobsahuje element wsa:replyto je klientovi zaslána chybová zpráva SOAP s chybovým kódem q0:security. Příchozí zpráva je odmítnuta jako celek. Selže-li ověření časových a identifikačních údajů v SOAP obálce z důvodů chyby přijímající aplikace, je klientovi zaslána chybová zpráva SOAP s chybovým kódem soap:server. Příchozí zpráva je odmítnuta jako celek. Má-li příchozí zpráva proexspirovaný čas zpracování v elementu <wsu:timestamp>, bude zpráva odmítnuta jako celek. Klientovi zaslána chybová zpráva SOAP s chybovým kódem soap:server. 4. Na základě předané zprávy je vyhodnocen typ dotazu a zda je tento dotaz službou podporován. Selže-li tento krok, je klientovi zaslána chybová zpráva SOAP s chybovým kódem soap:client. Příchozí zpráva je odmítnuta jako celek. 5. Zpráva je zpracována aplikací 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 soap:server. Příchozí zpráva je odmítnuta jako celek. 6. Klientovi je zaslána standardní zpráva SOAP s odpovědí. Chování odesílající strany v případě komplikací s přenosem se nemusí řídit žádnou předem stanovenou logikou. Vzhledem k tomu, že cyklus dotaz-odpověď nemá charakter typické transakce, je možno stanovit ošetření chyb na klientské straně prakticky libovolně. Copyright ASD Software, s.r.o.,

20 6. Přílohy 6.1 Adresa služby Struktura XMLSchema pro veřejný dotaz Struktura XMLSchema pro odpověď na veřejný dotaz Copyright ASD Software, s.r.o.,

21 7. Reference [1] SOAP Simple Object Access Protocol (SOAP) 1.1 W3C Note 08 May Viz [2] XML Extensible Markup Language (XML) 1.0 (Second Edition). W3C Recommendation 6 October Viz [3] XML Schema XML Schema Part 0: Primer. W3C Recommendation, 2 May 2001 Viz [4] SAML Asssertion and Protocol SAML Asssertion and Protocol 2.0 (SAML-Core-2.0) Viz. [5] Basic Profile Basic Profile Version 1.1 Viz. Copyright ASD Software, s.r.o.,

22 8. Návrhy pro další verze služby V tomto odstavci jsou definovány návrhy pro úpravy a rozšíření následující verze. Copyright ASD Software, s.r.o.,