Webová služba aplikace ISIR Popis způsobu používání webové služby Zpracoval: CCA Group a.s.
Verze: 1.9 Verze 1.0 1.1 1.2 1.3 1.4 1.5 1.6 1.7 1.8 1.9
Stručný popis změn
Datum
Verze dokumentu předložená k oponentuře objednateli Aktualizace dokumentu dle aktuálního stavu webové služby Aktualizace dokumentu dle aktuálního stavu webové služby Aktualizace dokumentu dle aktuálního stavu webové služby Aktualizace dokumentu dle aktuálního stavu webové služby (k verzi XSD poznámky 1.6 platné od 30.8.2011) Doplnění přechodů mezi stavy, informace o připojení Úprava URL v kapitole 1.7 Připojení Přidání hodnoty do popisu číselníku VĚŘIT-NAVR Doplnění datového modelu, zahrnutí všech změn XSD popsaných původně v samostatných dokumentech Doplnění popisu elementu idOsoby
.
17.1.2008 28.2.2008 5.1.2009 1.7.2011 22.11.2011 24.11.2011 23.7.2012 5.10.2012 25.9.2013 22.9.2014
Webová služba aplikace ISIR
Popis způsobu používání webové služby
Obsah 1.
2.
3.
Popis webové služby pro publikování údajů aplikace ISIR
3
1.1
Věc
3
1.2
Událost vs. Akce
3
1.3
Poznámka
4
1.4
Poznámky a události/akce
4
1.5
Typické akce 1.5.1 Založení spisu 1.5.2 Založení osoby v řízení 1.5.3 Zpožděné doplnění dokumentu 1.5.4 Změna osoby/adresy 1.5.5 Rušení záznamů o událostech, věcech, osobách 1.5.6 Změna číselníku událostí 1.5.7 Změna poznámky
5 5 6 6 7 8 9 9
1.6
Datový model 1.6.1 Volání webové služby 1.6.2 Rozhraní webové služby 1.6.3 Poznámka 1.6.4 Událost 1.6.5 Věc 1.6.6 Osoba 1.6.7 Adresa
9 9 9 11 12 15 17 19
1.7
Připojení
20
1.8
Chybové stavy 1.8.1 Webová služba 1.8.2 Stažení souboru 1.8.3 Struktura chyby vracené webovou službou 1.8.4 Poslední výpadek webové služby
20 20 20 21 21
1.9
Přenášení dokumentů
21
1.10
Zabezpečení
21
1.11
Zamezení zahlcení serveru webovou službou
22
Příklady komunikace s Webovou službou
23
2.1
Příklad 1 – první dotaz podle id
23
2.2
Příklad 2 – další dotaz podle id
24
2.3
Příklad 3 – dotaz podle kalendářního data/času
25
2.4
Příklad 4 – chyba
26
Seznam datových typů
strana 2 ze 29 verze: 1.9
27
Ministerstvo spravedlnosti ČR a CCA Group
Webová služba aplikace ISIR
Popis způsobu používání webové služby
1. POPIS WEBOVÉ SLUŽBY PRO PUBLIKOVÁNÍ ÚDAJŮ APLIKACE ISIR Webová služba poskytuje podobné informace jako webové rozhraní aplikace ISIR, přizpůsobené pro automatickou strojovou komunikaci. Zveřejňuje údaje o věcech insolvenčního řízení. Je určená pro subjekty, které potřebují automatické zpracování informací, zpočátku především pro banky. Služba je navržená tak, aby poskytovala maximální množství informací při zachování vysoké dostupnosti. Informace o insolvenčním řízení jsou v databázi ISIR uložená formou událostí/akcí, ke kterým v průběhu řízení dochází. Každá akce má své unikátní číslo generované sekvenčně při zápisu události do systému ISIR. Webová služba poskytuje dva typy dotazu – podle unikátního čísla akce nebo podle data, kdy akce nastala. Vrací chronologický seznam akcí s vyšším unikátním číslem, než je zadané, nebo s vyšším datem vzniku akce. Služba předpokládá vytvoření vlastních kopií databází na straně uživatelů. Důvodem je požadavek vysoké dostupnosti.
1.1 Věc Věcí se rozumí jedno insolvenční řízení vedené proti konkrétní osobě. Věc popisují její atributy a události, které ve věci nastaly. Webové rozhraní uživateli zobrazuje atributy věcí a vybrané události.
1.2 Událost vs. Akce Ve smyslu popisu předchozího odstavce je událost brána jako vlastnost věci, ne jako přenosová jednotka pro webovou službu. Pro tento účel nyní zavádíme pojem Akce. Srovnání: Událost: -
zadává ji uživatel protože uživatel může udělat chybu, může být i událost zrušená jako mylný zápis identifikována druhem oddílu, číslem v druhu oddílu a spisovou značkou
Akce: -
akci generuje automaticky systém jako prvek přenosu dat je neměnná. Pokud obsahuje data k věci/události, tato data lze změnit jinou akcí stejného nebo podobného typu identifikována číselným identifikátorem
Z hlediska číselníku typů je číselník akcí shodný s číselníkem událostí.
Ministerstvo spravedlnosti ČR a CCA Group
strana 3 ze 29 verze: 1.9
Webová služba aplikace ISIR
Popis způsobu používání webové služby
1.3 Poznámka Aby byla webová služba co nejobecnější a přitom odolná proti častým změnám rozhraní, obsahuje samotné volání pouze základní údaje pro identifikaci události, které se akce týká. Samotná přenášená data obsahuje poznámka. Data jsou v poznámce strukturována formou XML dokumentu. Strukturu poznámky definuje XSD schéma. Každá poznámka má uvedený atribut schemaLocation, který obsahuje URI XSD souboru, který se vztahuje k dané verzi poznámky. První verze poznámky je dostupná na URI https://isir.justice.cz:8443/isir_ws/xsd/poznamka.xsd Další verze budou odlišeny číslem verze v názvu poznámky, např.: https://isir.justice.cz:8443/isir_ws/xsd/poznamka_1_1.xsd Každá poznámka bude mít připojenou verzi schématu vztahující se k okamžiku, kdy vznikla příslušná akce. Pokud se tedy např. k poslednímu lednu změní struktura poznámky ze schématu https://isir.justice.cz:8443/isir_ws/xsd/poznamka_3_9.xsd na 3_10, pak budou poznámky u akcí do konce ledna mít URI validačního schématu (schemaLocation): https://isir.justice.cz:8443/isir_ws/xsd/poznamka_3_9.xsd, poznámky od konce ledna: https://isir.justice.cz:8443/isir_ws/xsd/poznamka_3_10.xsd.
1.4 Poznámky a události/akce Přenos jsme navrhli tak, aby u většiny událostí nebyla poznámka vůbec nebo aby u těchto akcí byla stejná s minimem údajů potřebných k událostem. Z tohoto hlediska dělíme číselník událostí/akcí na dvě skupiny: 1. Události/akce podle dodaného číselníku -
obsahují informace o samotných zveřejňovaných událostech. Akce vznikají na základě zápisu události uživatelem poznámka je prázdná nebo pouze s minimem informací o události jako takové neobsahují informace o osobách ani věci samotné
2. servisní události/akce -
servisní události/akce generuje automaticky systém servisní události/akce obsahují informace o řízení – data o osobách a věci servisní události/akce mohou měnit vlastnosti jiných událostí – ukončit jejich platnost v případě mylného zápisu servisní události mohou měnit samotný číselník událostí
strana 4 ze 29 verze: 1.9
Ministerstvo spravedlnosti ČR a CCA Group
Webová služba aplikace ISIR
Popis způsobu používání webové služby
1.5 Typické akce 1.5.1 Založení spisu Spis se založí první běžnou událostí, která má být zobrazena na webu. Stejná událost bude publikována webovou službou. Hned po této události půjde servisní událost pro založení osoby dlužníka. <soapenv:Envelope xmlns:soapenv=“http://schemas.xmlsoap.org/soap/envelope/“> <soapenv:Header /> <soapenv:Body> <ns1:getIsirPub0012Response xmlns:ns1=“urn:IsirPub001/types“>
2007-11-01T00:00:00.000Z 522 < dálost >
KSJIMBM&l t;druhStavRizeni>KONK.PROHL dálost > <spisZnacka>INS 86/2007 3 Insolvenční návrh A <poradiVOddilu>1 2007-11-01T00:00:00.000Z 523 < dálost >
KSJIMBM HERMA JAN 230581 3DLUŽNÍKHerma&l t;druhOsoby>F<jmeno>JanIng.123456&l t;/ic>DIC123456810523/2817 dálost > <spisZnacka>INS 86/2007 1 změna údajů o osobě
Ministerstvo spravedlnosti ČR a CCA Group
strana 5 ze 29 verze: 1.9
Webová služba aplikace ISIR
Popis způsobu používání webové služby
První akce v poznámce obsahuje pouze základní informace o řízení:
KSJIMBM KONK.PROHL
Druhá akce nese informace o dlužníkovi:
KSJIMBM HERMA
JAN 230581
3
DLUŽNÍK Herma F <jmeno>Jan Ing. 123456 DIC123456 810523/2817
1.5.2 Založení osoby v řízení Osoby nebudou zakládány běžnými událostmi, ale servisní událostí po události, se kterou souvisejí. Založení osoby dlužníka jde servisní událostí hned po založení věci. Podobnou servisní událostí budou zakládány adresy osob. Příklad založení osoby v události je uveden v předchozím bodu. Element idOsoby slouží jako jednoznačný identifikátor pouze v rámci dané organizace (insolvenčního soudu). Pro jednoznačnost v centrální databázi (tj. napříč všemi podněty obdrženými webovou službou) je nutné kombinovat s obsahem elementu
.
1.5.3 Zpožděné doplnění dokumentu Protože pro zveřejnění insolvenčního řízení jsou dané krátké lhůty a protože některé dokumenty je při zveřejnění nutno „anonymizovat“ (vymazat důvěrné údaje) a tento krok by mohl zveřejnění zdržet, je možné publikovat událost bez dokumentu s tím, že bude doplněn později. Pro tuto akci nebude speciální servisní událost – pokud není vyplněný dokument, není zatím připraven. Doplnění dokumentu půjde změnou události – akce se stejným typem a identifikací události, jenom s vyplněným URI dokumentu. <soapenv:Envelope xmlns:soapenv=“http://schemas.xmlsoap.org/soap/envelope/“> <soapenv:Header />
strana 6 ze 29 verze: 1.9
Ministerstvo spravedlnosti ČR a CCA Group
Webová služba aplikace ISIR
Popis způsobu používání webové služby
<soapenv:Body> <ns1:getIsirPub0012Response xmlns:ns1=“urn:IsirPub001/types“> 2007-11-01T00:00:00.000Z 526 http://jmeno_serveru.justice.cz/ws/doc/kod_dokumentu < dálost > dálost > <spisZnacka>INS 86/2007 3 Insolvenční návrh A <poradiVOddilu>1
1.5.4 Změna osoby/adresy Změny údajů o osobách a jejich adresách půjdou stejnými servisními událostmi jako založení osoby/adresy. Tyto změny budou generovány pravidelně jednou za den. Element idOsoby slouží jako jednoznačný identifikátor pouze v rámci dané organizace (insolvenčního soudu). Pro jednoznačnost v centrální databázi (tj. napříč všemi podněty obdrženými webovou službou) je nutné kombinovat s obsahem elementu . <soapenv:Envelope xmlns:soapenv=“http://schemas.xmlsoap.org/soap/envelope/“> <soapenv:Header /> <soapenv:Body> <ns1:getIsirPub0012Response xmlns:ns1=“urn:IsirPub001/types“> 2007-11-01T00:00:00.000Z 527 < dálost >
KSJIMBM HERMA JAN 230581 3DLUŽNÍKHerma&l t;druhOsoby>F<jmeno>JanIng.123456&l t;/ic>DIC123456810523/2817 dálost > <spisZnacka>INS 86/2007 1 změna údajů o osobě
Ministerstvo spravedlnosti ČR a CCA Group
strana 7 ze 29 verze: 1.9
Webová služba aplikace ISIR
Popis způsobu používání webové služby
1.5.5 Rušení záznamů o událostech, věcech, osobách Typicky v případě mylného zápisu do systému vyvstane požadavek zrušení záznamu v databázi. Není to příliš častý případ, nicméně je nutno s ním pracovat. Rušení záznamů se dotýká událostí, věcí, osob a jejich adres. Událost zruší akce se stejným typem, jaká ji založila. Akce bude obsahovat datum zrušení události a identifikaci události, která se ruší – druh oddílu, pořadové číslo v oddílu a spisovou značku. <soapenv:Envelope xmlns:soapenv=“http://schemas.xmlsoap.org/soap/envelope/“> <soapenv:Header /> <soapenv:Body> <ns1:getIsirPub0012Response xmlns:ns1=“urn:IsirPub001/types“> 2007-11-02T00:00:00.000Z 528 < dálost >
KSJIMBM2007-11-10T00:00:00.000Z dálost > <spisZnacka>INS 86/2007 4 Návrh na povolení
reorganizace
A <poradiVOddilu>2
Poznámka obsahuje datum zrušení události. KSJIMBM 2007-11-10T00:00:00.000Z
Osobu ruší servisní událost datumOsobaVeVeciZrusena.
strana 8 ze 29 verze: 1.9
pro
změnu
osoby
s vyplněným
Ministerstvo spravedlnosti ČR a CCA Group
elementem
Webová služba aplikace ISIR
Popis způsobu používání webové služby
1.5.6 Změna číselníku událostí Servisní událost bez spisové značky, bude obsahovat: -
číslo postižené události podle číselníku popis postižené události podle číselníku popis změny datum platnosti postižené události od datum platnosti postižené události do příznak, zda se jedná o servisní událost (servisní se nezobrazují na webu)
Kompletní číselník událostí je uveden na adrese https://isir.justice.cz/isir/help/Cis_udalosti.xls.
1.5.7 Změna poznámky Pro změnu formátu poznámky bude speciální servisní událost „Změna poznámky“ s typem 330. Událost bude obsahovat datum, od kdy změna platí, nové URI souboru se schématem poznámky a popis změny. Podrobnější informace o změnách XSD poznámky jsou vždy uvedeny na adrese https://isir.justice.cz/isir/common/stat.do?kodStranky=NASTENKA.
1.6 Datový model 1.6.1 Volání webové služby Webová služby podporuje dva typy volání – ze zadaným posledním ID akce nebo se zadaným datem akce.
getIsirPub001 – Volání webové služby s parametrem typu datum. Vrací všechny akce s časem >= zadanému datu. getIsirPub0012 – Volání webové služby s parametrem typu long. Vrací všechny akce s id > než je zadané číslo.
1.6.2 Rozhraní webové služby Tabulka popisuje strukturu události, jak ji vrací webová služba. Služba bude vracet pole těchto událostí. Popis prvků:
Název elementu
Popis
Cas
Datum a čas vzniku události. Bude ve formátu dateTime – standard pro webové služby.
Id
Unikátní sekvenční číslo události v ISIRu. Číslo bude generovat aplikace při zápisu události do
Ministerstvo spravedlnosti ČR a CCA Group
strana 9 ze 29 verze: 1.9
Webová služba aplikace ISIR
Popis způsobu používání webové služby
aplikace. idDokument
Adresa dokumentu – služba nebude vracet obsah dokumentů. Pro ten bude vyhrazená jiná cesta. Element idDokument bude obsahovat URI dokumentu.
Poznamka
Poznámka – obsahuje strukturované údaje k události – pro vybrané události zobrazuje formou XML dokumentu údaje např. o dlužníkovi. Struktura poznámky bude součástí definice číselníku událostí. Poznámka bude pouze u omezeného počtu událostí.
spisZnacka
Spisová značka řízení, ke kterému událost patří. Bude ve formátu / , např. ISN 56 / 2007. Spisová značka spojuje události, které k sobě patří.
Typ
Typ události podle číselníku událostí.
typText
Popis události podle číselníku událostí.
Oddil
Oddíl, do kterého událost patří.
poradiVOddilu
Pořadové číslo v rámci oddílu, spolu se spisovou značkou a oddílem identifikuje událost.
strana 10 ze 29 verze: 1.9
Ministerstvo spravedlnosti ČR a CCA Group
Webová služba aplikace ISIR
Popis způsobu používání webové služby
1.6.3 Poznámka class Poznamka_1_9
«XSDcomplexType» udalostComplexType «XSDelement» + idOsobyPuvodce :string + datumUdalostZrusena :dateTime [0..1] + obecnyText :string [0..1] + datumPravniMoci :date [0..1] + priznakAnVedlejsiUdalost :string [0..1] + priznakAnVedlejsiDokument :string [0..1] + bcVecHlavni :unsignedInt [0..1] + druhVecHlavni :string [0..1] + rocnikHlavni :unsignedInt [0..1] + datumSpojeni :date [0..1] + datumOddeleni :date [0..1] + druhOddilPrihl :string [0..1] + cisloOddiluPrihl :unsignedInt [0..1] + osobaVeritel :string [0..1] + priznakPlatnyVeritel :string [0..1] + priznakMylnyZapisVeritelPohled :string [0..1] + datumUstanoveniSpravce :date [0..1] + datumZverejneniOpraveneUdalosti :date [0..1] + datumVyskrtnuti :date [0..1] + bcVecVsNs :unsignedInt [0..1] + druhVecVsNs :string [0..1] + rocnikVsNs :unsignedInt [0..1] + senatVsNs :unsignedInt [0..1] + bcVecICm :unsignedInt [0..1] + druhVecICm :string [0..1] + rocnikICm :unsignedInt [0..1] + senatICm :unsignedInt [0..1] +cis_udalost «XSDattribute» + verzeXsd :string
«XSDcomplexType» osobaComplexType
+osoba
«XSDelement» + idOsoby :string + druhRoleVRizeni :string + druhSpravce :string [0..1] + nazevOsoby :string + nazevOsobyObchodni :string [0..1] + druhOsoby :string + druhPravniForma :string [0..1] + jmeno :string [0..1] 0..1 + titulPred :string [0..1] + titulZa :string [0..1] + ic :string [0..1] + dic :string [0..1] + rc :string [0..1] + datumOsobaVeVeciZrusena :dateTime [0..1] + datumNarozeni :date [0..1]
+poznamkaXSD
0..1
+vec
«XSDcomplexType» poznamkaXSDComplexType «XSDelement» + datumPlatiOd :dateTime + URI :string + popisZmeny :string
0..1 «XSDcomplexType» cis_udalostComplexType 0..1 «XSDelement» + idCisUdalostiProWs :int + popisCisUdalosti :string + popisZmeny :string [0..1] + datumZalozeniCisUdalosti :dateTime [0..1] + datumZruseniCisUdalosti :dateTime [0..1] + priznakAnInterniCisUdalost :string
Ministerstvo spravedlnosti ČR a CCA Group
«XSDcomplexType» v ecComplexType «XSDelement» + druhStavRizeni :string [0..1] + datumVecZrusena :dateTime [0..1]
strana 11 ze 29 verze: 1.9
Webová služba aplikace ISIR
Popis způsobu používání webové služby
1.6.4 Událost Klíč spisZnacka
string
50
oddil
string
10
poradiVOddilu
int
Atributy idOsobyPuvodce
string
datumUdalostZrusena
datetime
obecnyText
string
datumPravniMoci
date
priznakAnVedlejsiUdalost
string
1
priznakAnVedlejsiDokument
string
1
bcVecHlavni
unsignedI nt
6
druhVecHlavni
string
10
Toto datum určuje, kdy tato událost s dokumentem nabyla právní moci a stává se vykonatelná. Datum právní moci se zasílá v samostatném podnětu. Dle povinných položek lze jednoznačně určit, ke které události a spisové značce patří. příznak rozlišuje, zda se jedná o vedlejší událost. Vedlejší událost se zveřejňuje bez dokumentu a jejím smyslem je zveřejnění všech dalších důležitých skutečností, obsažených v dokumentu. Každá vedlejší událost se zasílá v samostatném podnětu. Vedlejších událostí může být k jedné „hlavní“ zveřejněno více. Vedlejší události mají stejný oddíl a pořadí v oddílu, jako událost „hlavní“. Dle povinných položek lze jednoznačně určit, ke které události a spisové značce patří. rozlišuje, zda se jedná o vedlejší dokument. Ten se zveřejňuje bez události a jeho smyslem je zveřejnění ostatních pomocných dokumentů, které se dané události týkají. Typickým příkladem jsou doručenky, referáty a přílohy. Vedlejší dokument je zveřejněn až po zveřejnění „hlavního“ dokumentu. Vedlejší dokument může být pouze jeden, a to k hlavní“ události. Dle povinných položek lze jednoznačně určit, ke které události a spisové značce patří. běžné číslo - část spisové značky připojené hlavní věci. Spisová značka věci hlavní se zasílá vždy v podnětu u vedlejší věci s odpovídajícím dokumentem při spojení věcí. druh věci - část spisové značky připojené hlavní věci
rocnikHlavni
unsignedI nt
4
ročník - část spisové značky připojené hlavní věci
datumSpojeni
date
datumOddeleni
date
strana 12 ze 29 verze: 1.9
20
soud, kde událost vznikla datum zrušení události
4000
Text vyplňovaný v informativním podnětu webové služby.
obsahuje datum, kdy bylo provedeno spojení věcí. Toto datum určuje, že ve věci bylo tento den vydáno usnesení o spojení věcí ke společnému projednání. Datum spojení je posíláno spolu s událostí o spojení věci u věci vedlejší. obsahuje datum, kdy bylo provedeno oddělení věcí. Toto datum určuje, že ve věci bylo tento den vydáno usnesení o oddělení věcí a tím byla vedlejší věc od hlavní věci oddělena. Datum oddělení je posíláno spolu s událostí o oddělení věci u věci vedlejší.
Ministerstvo spravedlnosti ČR a CCA Group
Webová služba aplikace ISIR
Popis způsobu používání webové služby
druhOddilPrihl
string
10
element obsahuje druh oddílu, ve kterém bude zapsána přihláška věřitele (vždy „Px“, kde x je číslo od 1 do n a udává číslo věřitele). Spojením s elementem cisloOddiluPrihl vznikne označení oddílu, ve kterém bude zapsána přihláška spolu s jedním věřitelem nebo i s více věřiteli. Správně by měla být přihláška spolu s věřitelem případně věřiteli zapsána vždy v oddílu Px-1.
cisloOddiluPrihl
number
6
Element bude obsahovat pořadové číslo v rámci druhu oddílu.
osobaVeritel
string
255
priznakPlatnyVeritel
string
1
Položka osobaVeritel bude obsahovat jméno nebo název věřitele, zapsaného k přihlášce. Přihláška je vždy identifikována oddílem. element obsahuje informaci, zda je věřitel v přihlášce platný. Věřitel může být zneplatněn v případě úmrtí, postoupení celé přihlášky apod.
priznakMylnyZapisVeritelPohled
string
1
datumUstanoveni
date
Položka datumUstanoveni bude obsahovat datum ustanovení insolvenčního správce ve věci INS.
datumZverejneniOpraveneUdalosti
date
Element datumZverejneniOpraveneUdalosti se odesílá pouze v případě, že se jedná o opravovanou událost, ve které se datum zveřejnění opravy shoduje s původním datem zveřejnění. Uživatel systému má možnost při opravě události zadat, zda se má datum události aktualizovat. Pokud se jedná o drobnou opravu události – uživatel volí volbu NEAKTUALIZOVAT, v tomto případě bude element vyplněn hodnotou původního data události.
element obsahuje informaci o mylném zápisu věřitele v přihlášce. Tzn. daná osoba věřitele byla k přihlášce zapsána omylem.
Pokud se jedná o opravu, která má faktický vliv na zveřejněnou událost, uživatel volí volbu AKTUALIZOVAT a tento element se tedy neposílá a aktuální datum je posláno elementem Cas (obsažen v complex type IsirPub001Data) jako při zveřejnění jakékoliv jiné události a element datumZverejneniOpraveneUdalosti není v tomto případě vložen vůbec. datumVyskrtnuti
date
senatVsNs
int
6
číslo senátu věci VSNS – část senátní značky. Po složení souvisejících elementů v uvedeném pořadí vzniká celá senátní značka připojeného řízení VSNS. Senátní značkou se označuje řízení vrchního nebo nejvyššího soudu, který vstupuje do insolvenčního řízení, ke zveřejnění dochází v okamžiku vstupu příslušného soudu. Senátní značka se váže na událost, se kterou je odeslána tzn., že jedno insolvenční řízení může obsahovat více senátních značek
druhVecVsNs
string
10
druh věci VSNS – část senátní značky
Ministerstvo spravedlnosti ČR a CCA Group
Element datumVyskrtnuti bude poskytovat informaci o znepřístupnění údajů o daném řízení dlužníka dle §425 Insolvečního zákona. Od uvedeného data se již daná věc dlužníka přestane zobrazovat na webu IR, nebude ji možné vylustrovat přes CzechPOINT ani v lustraci ISIR v soudních aplikacích. Informace o vyškrtnutém řízení by již neměly být poskytovány dalším stranám ani z lokálních databází odběratelů WS.
strana 13 ze 29 verze: 1.9
Webová služba aplikace ISIR
Popis způsobu používání webové služby
bcVecVsNs
int
6
běžné číslo věci VSNS – část senátní značky
rocnikVsNs
int
4
ročník věci VSNS – část senátní značky
senatICm
int
6
číslo senátu věci ICM – část spisové značky ICM Po složení elementů v uvedeném pořadí vzniká celá spisová značka připojeného incidenčního sporu (řízení). Spisová značka incidenčního sporu bude pro insolvenční řízení odeslána právě tolikrát, kolik bude v INS řízení incidenčních sporů.
druhVecICm
string
10
druh věci ICM – část spisové značky ICM
bcVecICm
int
6
běžné číslo věci ICM – část spisové značky ICM
rocnikICm
int
4
ročník věci ICM – část spisové značky ICM
strana 14 ze 29 verze: 1.9
Ministerstvo spravedlnosti ČR a CCA Group
Webová služba aplikace ISIR
Popis způsobu používání webové služby
1.6.5 Věc Klíč spisZnacka
string
50
Atributy druhStavRizeni
string
10
datumVecZrusena
datetime
stav řízení datum zrušení věci (mylný zápis)
Číselníky druhStavRizeni
Popis
NEVYRIZENA
nevyřízená
před rozhodnutím o úpadku
MORATORIUM
moratorium
povoleno moratorium
ÚPADEK
úpadek
v úpadku
KONKURS
konkurs
prohlášený konkurs
ODDLUŽENÍ
oddlužení
povoleno oddlužení
REORGANIZ
reorganizace
povolena reorganizace
VYRIZENA
vyřízená
vyřízená věc
PRAVOMOCNA
pravomocná
pravomocně skončená věc
ODSKRTNUTA
odškrtnutá
odškrtnutá - skončená věc
ZRUŠENO VS
zrušeno vrchním soudem
zrušeno vrchním soudem
K-PO ZRUŠ.
konkurs po zrušení
prohlášený konkurs po zrušení VS
OBZIVLA
obživlá
obživlá věc
MYLNÝ ZÁP.
mylný zápis
mylný zápis do rejstříku
NEVYR-POST
postoupená věc
postoupená věc
Přechody mezi stavy
Legenda: 1. plné – obecně povolené přechody mezi stavy 2. přerušované – obecně nepovolené přechody mezi stavy, jen na určenou událost (postoupení, přikázání, pokračování v řízení) 3. čerchované – přechod na základě rozhodnutí VS/NS, kdy se nejedná o obecně povolený přechod mezi stavy 4. tečkované – přechod na základě dovolání
Ministerstvo spravedlnosti ČR a CCA Group
strana 15 ze 29 verze: 1.9
Webová služba aplikace ISIR
MYLNÝ ZÁP.
Popis způsobu používání webové služby
NEVYRIZENA
NEVYR-POST
MORATORIUM
OBZIVLA
ÚPADEK
ZRUŠENO VS
K-PO ZRUŠ.
KONKURS
ODDLUŽENÍ
VYRIZENA
PRAVOMOCNA
ODSKRTNUTA
strana 16 ze 29 verze: 1.9
Ministerstvo spravedlnosti ČR a CCA Group
REORGANIZ.
Webová služba aplikace ISIR
Popis způsobu používání webové služby
1.6.6 Osoba class Osoba
«XSDcomplexType» osobaComplexType
«XSDcomplexType» adresaComplexType
«XSDelement» + idOsoby :string + druhRoleVRizeni :string + druhSpravce :string [0..1] + nazevOsoby :string + nazevOsobyObchodni :string [0..1] + druhOsoby :string + druhPravniForma :string [0..1] + jmeno :string [0..1] + titulPred :string [0..1] + titulZa :string [0..1] + ic :string [0..1] + dic :string [0..1] + rc :string [0..1] + datumOsobaVeVeciZrusena :dateTime [0..1] + datumNarozeni :date [0..1]
+adresa
«XSDelement» + druhAdresy :string + datumPobytOd :date + datumPobytDo :date [0..1] + mesto :string [0..1] + ulice :string [0..1] + cisloPopisne :string [0..1] 0..1 + okres :string [0..1] + zeme :string [0..1] + psc :string [0..1] + telefon :string [0..1] + fax :string [0..1] + textAdresy :string [0..1] + idAdresy :string
Klíč spisZnacka
string
50
Spisová značka, identifikátor věci
jednoznačný
idOsoby
string
20
Identifikátor osoby, jednoznačný v rámci dané organizace (insolvenčního soudu)
Atributy druhRoleVRizeni
string
10
role v jaké osoba ve spise vystupuje
druhSpravce
string
10
druh správce
nazevOsoby
string
255
přesný název osoby
nazevOsobyObchodni
string
255
obchodní název osoby
druhOsoby
string
10
druh osoby (fyzická organizace /…)
druhPravniForma
string
10
kód právní formy osoby
Jmeno
string
40
křestní jméno osoby
titulPred
string
50
tituly osoby před jménem
titulZa
string
50
tituly osoby za jménem
Ic
string
9
identifikační číslo
Dic
string
14
daňové identifikační číslo
Rc
string
11
rodné číslo
datumOsobaVeVeciZrusena
datetime
datum zrušení osoby ve věci
datumNarozeni
date
datum narození osoby
Ministerstvo spravedlnosti ČR a CCA Group
/
právnická
/
strana 17 ze 29 verze: 1.9
Webová služba aplikace ISIR
Popis způsobu používání webové služby
Číselníky druhRoleVRizeni
popis
DLUŽNÍK
dlužník
SPRÁVCE
správce
VĚŘITEL
věřitel
VĚŘIT-NAVR
věřitel, který podal návrh na insolvenci
druhSpravce
popis
ODDĚL SPR
oddělený správce
INS SPRÁV
insolvenční správce
ZVL SPRÁV
zvláštní správce
ZÁST INS S
zástupce správce
PREDB.SPR.
předběžný správce
VYR SPRÁV
vyrovnací správce
druhOsoby
popis
ADVOKÁT
advokát
F
fyzická
O
organizace resortu
P
právnická
SPRÁV_INS
ins. správce
PODNIKATEL
podnikatel
POLICIE
policie
SPRÁVCE_KP
správce konkursní podstaty
EXEKUTOR
soudní exekutor
DAN_PORAD
daňový poradce
OST_OVM
ostatní orgány veřejné moci (OVM)
PAT_ZAST
patentový zástupce
S
soudní komisař, notář
SPR_ORGAN
správní orgán
U
soudní přísedící
Z
zaměstnanec
ZNAL_TLUM
znalec, tlumočník
druhPravniForma
popis
a.s.
akciová společnost
strana 18 ze 29 verze: 1.9
Ministerstvo spravedlnosti ČR a CCA Group
Webová služba aplikace ISIR
Popis způsobu používání webové služby
k. s.
komanditní společnost
o.p.s.
obecně prospěšná společnost
s.p.
státní podnik
s.p. likv
státní podnik v likvidaci
s.r.o.
společnost s ručením omezeným
v.o.s.
veřejná obchodní společnost
1.6.7 Adresa Klíč spisZnacka
string
50
idAdresy
string
20
String
10
Atributy druhAdresy
kód druhu adresy ('TRVALÁ','PRECHODNÁ',...)
datumPobytOd
Date
datum začátku platnosti adresy
datumPobytDo
Date
datum konce platnosti adresy
mesto
String
255
město / obec
ulice
String
255
ulice
cisloPopisne
String
10
číslo popisné
okres
String
30
okres
zeme
String
255
země
psc
String
6
PSČ
telefon
String
30
telefon
fax
String
30
fax
textAdresy
String
255
text adresy e-mailu, URL apod.
Číselníky druhAdresy
popis
E-MAIL
email
ODDĚLENÍ
oddělení
OSTATNÍ
ostatní
POBOČKA
pobočka
PŘECHODNÁ
přechodná
SÍDLO FY
sídlo firmy
SÍDLO ORG.
sídlo organizace
TRVALÁ
trvalá
Ministerstvo spravedlnosti ČR a CCA Group
strana 19 ze 29 verze: 1.9
Webová služba aplikace ISIR
Popis způsobu používání webové služby
1.7 Připojení Webová služba pracuje na adrese https://isir.justice.cz:8443/isir_ws/services/IsirPub001 a poskytuje 2 metody. První z metod omezuje vrácené akce podle jejich id - tato metoda má název getIsirPub0012 a má 1 číselný parametr "long_1". Url pro dotaz na webovou službu v tomto případě vypadá následovně: https://isir.justice.cz:8443/isir_ws/services/IsirPub001/getIsirPub0012?long_1=1246. Druhá z metod omezuje vrácené akce podle zadaného data – tato metoda má název getIsirPub001 a má 1 datumový parametr " Calendar_1". Url pro dotaz na webovou službu v tomto případě vypadá následovně: https://isir.justice.cz:8443/isir_ws/services/IsirPub001/getIsirPub001?Calendar_1=2004-1018T00:00:00.000 Dočasná adresa pro stažení dokumentu je https://isir.justice.cz:8443/isir_ws/doc/Document?idDokument=1246 kde si za číslo dokumentu dosaďte číslo akce, na kterou se dotazujete.
1.8 Chybové stavy 1.8.1 Webová služba Kód
Text
Popis
WS1
neznámý parametr služby
chybné volání webové služby, zadaný neočekávaný parametr
WS2
nenastavený služby
SQL1
chyba databáze
parametr chybně nastavený argument volání webové služby chyba při vyhledání dat z databáze
SERVER1 prázdný atribut
není vyplněný některý z povinných parametrů
SERVER2 chyba aplikace
ostatní neočekávané chyby
SERVER3 neznámá verze poznámky
interní chyba webové služby – chybně nastavená verze poznámky
1.8.2 Stažení souboru Kód
Text
HTTP 404
Identifikátor dokumentu má identifikátor dokumentu není číslo nesprávný tvar. Není zadán dokumentu.
strana 20 ze 29 verze: 1.9
Popis
identifikátor identifikátor dokumentu není zadán
Dokument nenalezen.
dokument nenalezen
Vnitřní chyba databáze.
neočekávaná chyba SQL
Vnitřní chyba aplikace.
neočekávaná chyba aplikace Ministerstvo spravedlnosti ČR a CCA Group
Webová služba aplikace ISIR
Popis způsobu používání webové služby
1.8.3 Struktura chyby vracené webovou službou Webová služba buď vrátí data, která odpovídají zadaným kritériím nebo vrátí chybu jako standardní SOAP Fault. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header /> <soapenv:Body> <soapenv:Fault xmlns:axis2="http://ws.apache.org/namespaces/axis2"> axis2:WS2 Nenastavený parametr služby <detail> <Exception>org.apache.axis2.AxisFault: Nenastavený parametr služby
at cz.cca.isir.ws.isirPub001.IsirPub001Skeleton.getIsirPub0012(IsirPub001Skeleton.java:74)
at cz.cca.isir.ws.isirPub001.IsirPub001MessageReceiverInOut.invokeBusinessLogic(IsirPub001MessageReceiv erInOut.java:55)
at org.apache.axis2.receivers.AbstractInOutSyncMessageReceiver.receive(AbstractInOutSyncMessageReceiver .java:39)
at org.apache.axis2.engine.AxisEngine.receive(AxisEngine.java:497)
at ......
1.8.4 Poslední výpadek webové služby Informace o posledním výpadku webové služby je uvedena na https://isir.justice.cz/isir/common/stat.do?kodStranky=NASTENKA.
1.9 Přenášení dokumentů Obsah dokumentů nebude přímo přenášen webovou službou. Je to kvůli zajištění maximální dostupnosti webové služby a omezení množství dat přenášeného službou. Zpráva o události bude obsahovat pouze URI dokumentu. Pro automatické stažení dokumentu bude vytvořen kanál mimo webovou službu, kde bude možné pomocí zadaného URI programově vyhledat a stáhnout dokument.
1.10 Zabezpečení Webová služba bude volně přístupná všem subjektům z internetu. Nebude obsahovat žádné zabezpečení přístupu zvenku. Přístup na webovou službu bude prostřednictvím protokolu HTTPS. Externí subjekty tak budou moci ověřit, že pracují se správným serverem. Ministerstvo spravedlnosti ČR a CCA Group
strana 21 ze 29 verze: 1.9
Webová služba aplikace ISIR
Popis způsobu používání webové služby
1.11 Zamezení zahlcení serveru webovou službou Protože webová služba je veřejná a přístup na ni není nijak omezen, může se stát, že bude terčem útoků z Internetu. Nesmí se stát, že by útok na webovou službu znepřístupnil i webové rozhraní aplikace ISIR. Webová služba proto bude pracovat jako samostatná aplikace na separátním serveru oddělená od zbytku aplikace ISIR. Připojení do databáze pro webovou službu bude nastaveno tak, aby nebylo možné databázi zahltit velkým množstvím dotazů. Z důvodu omezení nároků na výkon serveru doporučujeme interval dotazů na webovou službu od jednoho subjektu nastavit na minimálně 10 minut.
strana 22 ze 29 verze: 1.9
Ministerstvo spravedlnosti ČR a CCA Group
Webová služba aplikace ISIR
Popis způsobu používání webové služby
2. PŘÍKLADY KOMUNIKACE S WEBOVOU SLUŽBOU Následující příklady ukazují princip komunikace s webovou službou. Nejsou určeny pro vytvoření klienta webové služby, pouze ilustrují princip komunikace. Pro účel vygenerování klienta podle standardů webových služeb je zveřejněný WSDL popis služby na adrese https://isir.justice.cz:8443/isir_ws/services/IsirPub001?wsdl Pro účel tohoto dokumentu předpokládejme jako vygenerovaného klienta třídu: IsirStub001 getIsirPub001 getIsirPub0012
Metody jsou popsány v kapitole 1.6 Datový model : „Webová služby podporuje dva typy volání – ze zadaným posledním ID akce nebo se zadaným datem akce
getIsirPub001 – volání webové služby s parametrem typu datum. Vrací všechny akce s časem >= zadanému datu
getIsirPub0012 – volání webové služby s parametrem typu long. Vrací všechny akce s id > než je zadané číslo“
Všimněte si rozdílných znamének pro nerovnost, zatímco v případě dotazu podle ID program nevrátí zadané ID, ale první větší, v případě data se může vrátit i akce, která nastala přesně v zadaném čase.
2.1 Příklad 1 – první dotaz podle id Typickým dotazem na webovou službu je dotaz podle ID akce. První dotaz, který bude vracet akce od startu systému bude se zadaným id -1: stub.getIsirPub0012(-1);
Ministerstvo spravedlnosti ČR a CCA Group
strana 23 ze 29 verze: 1.9
Webová služba aplikace ISIR
Popis způsobu používání webové služby
volání program převede na dotaz (priklad_1_dotaz_id.xml): <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header /> <soapenv:Body> <ns1:getIsirPub0012 xmlns:ns1="urn:IsirPub001/types"> -1
Webová služba vrátí prvních 1000 akcí z databáze. V našem příkladu (priklad_1_odpoved.xml) vrátila všech 967 záznamů z aplikace ISIR (příklad je z interního testovacího prostředí CCA). Pro další příklad je důležité poslední číslo události id=1233. POZOR! Přestože program vrátil pouze 967 záznamů, je poslední id=1233. Je to proto, že číselná řada ID nemusí být souvislá.
2.2 Příklad 2 – další dotaz podle id Pro opakované načítání dat z aplikace ISIR použijte opět metodu getIsirPub012. Jako argument použijte poslední vrácené id z předchozího volání (viz příklad 1): stub.getIsirPub0012(1233);
Volání program převede na dotaz (priklad_2_dotaz_id.xml): <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header /> <soapenv:Body> <ns1:getIsirPub0012 xmlns:ns1="urn:IsirPub001/types"> 1233
strana 24 ze 29 verze: 1.9
Ministerstvo spravedlnosti ČR a CCA Group
Webová služba aplikace ISIR
Popis způsobu používání webové služby
Protože jsme v předchozím volání vybrali všechny záznamy z aplikace a mezi tímto voláním žádný nepřibyl, nevrátí webová služba žádný záznam (priklad_2_odpoved.xml): <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header /> <soapenv:Body> <ns1:getIsirPub0012Response xmlns:ns1="urn:IsirPub001/types" />
Pokud by v prvním případě bylo v databázi více než 1000 záznamů, dostali bychom při druhém volání neprázdnou odpověď.
2.3 Příklad 3 – dotaz podle kalendářního data/času Webovou službu lze volat také s datem, od kterého chce uživatel získat akce. Pro tento účel webová služba poskytuje metodu getIsirPub001 s parametrem typu datetime. Tento typ volání pro pravidelnou práci s webovou službou ale nedoporučujeme – časový údaj je v databázi uložen s přesností na vteřiny, což znamená, že v jednom čase může nastat více akcí. Volání: stub.getIsirPub0012(datum); // nechť proměnná datum obsahuje datum a // cas 2008-01-01T00:00:00.000Z
Volání program převede na dotaz (priklad_3_dotaz_datum.xml): <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header /> <soapenv:Body> <ns1:getIsirPub001 xmlns:ns1="urn:IsirPub001/types"> 2008-01-01T00:00:00.000Z
Program vrátí podobný výsledek jako v příkladě 1 (viz priklad_3_odpoved.xml) Ministerstvo spravedlnosti ČR a CCA Group
strana 25 ze 29 verze: 1.9
Webová služba aplikace ISIR
Popis způsobu používání webové služby
2.4 Příklad 4 – chyba Pro ilustraci chyby jsme nasimulovali v našem interním prostředí interní chybu aplikace. Pokud při volání webové služby dojde k chybě, webová služba chybu ohlásí jako standardní SOAP Fault. Pro vyvolání webové služby jsme použili stejné volání jako v případě 1: stub.getIsirPub0012(-1);
Protože jsme měli v okamžiku volání úmyslně chybně nastavenou databázi, došlo k chybě. Odpověď byla (priklad_4_odpoved_chyba.xml): <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header /> <soapenv:Body> <soapenv:Fault xmlns:axis2="http://ws.apache.org/namespaces/axis2"> axis2:SERVER3 Neznámá verze poznámky <detail> <Exception>org.apache.axis2.AxisFault: Neznámá verze poznámky
at cz.cca.isir.ws.isirPub001.IsirPub001Skeleton.getIsirPub0012(IsirPub001Skeleton.java:105)
…
Seznam chybových zpráv obsahuje kapitola 1.8 Chybové stavy.
strana 26 ze 29 verze: 1.9
Ministerstvo spravedlnosti ČR a CCA Group
at
Webová služba aplikace ISIR
Popis způsobu používání webové služby
3. SEZNAM DATOVÝCH TYPŮ id
int
spisZnacka
String(50)
cas
DateTime
idDokument
String(2000)
typ
String (10)
typText
String (255)
oddil
String(10)
poradiVOddilu
int
idOsobyPuvodce
String (20)
datumUdalostZrusena
DateTime
druhStavRizeni
String (10)
datumVecZrusena
DateTime
idOsoby
String(20)
druhRoleVRizeni
String(10)
druhSpravce
String(10)
nazevOsoby
String(255)
nazevOsobyObchodni
String(255)
druhOsoby
String(10)
druhPravniForma
String(10)
jmeno
String(40)
titulPred
String(50)
titulZa
String(50)
ic
String(9)
dic
String(14)
rc
String(11)
datumOsobaVeVeciZrusena
DateTime
datumNarozeni
Date
druhAdresy
String(10)
datumPobytOd
Date
datumPobytDo
Date
mesto
String(255)
ulice
String(255)
cisloPopisne
String(10)
Ministerstvo spravedlnosti ČR a CCA Group
strana 27 ze 29 verze: 1.9
Webová služba aplikace ISIR
Popis způsobu používání webové služby
okres
String(30)
zeme
String(255)
psc
String(6)
telefon
String(30)
fax
String(30)
textAdresy
String(255)
idAdresy
String(20)
idCisUdalostiProWs
Int
popisCisUdalosti
String(4000)
popisZmeny
String(4000)
datumZalozeniCisUdalosti
DateTime
datumZruseniCisUdalosti
DateTime
priznakAnInterniCisUdalost
String(1)
datumPlatiOd
DateTime
URI
String(4000)
obecnyText
string (4000)
datumPravniMoci
date
priznakAnVedlejsiUdalost
string (1)
priznakAnVedlejsiDokument
string (1)
bcVecHlavni
unsignedInt (6)
druhVecHlavni
string (10)
rocnikHlavni
unsignedInt (4)
datumSpojeni
date
datumOddeleni
date
druhOddilPrihl
string (10)
cisloOddiluPrihl
int (6)
osobaVeritel
string (255)
priznakPlatnyVeritel
string (1)
priznakMylnyZapisVeritelPohled
string (1)
datumUstanoveni
date
datumZverejneniOpraveneUdalosti
date
datumVyskrtnuti
date
senatVsNs
int (6)
druhVecVsNs
string (10)
bcVecVsNs
int (6)
strana 28 ze 29 verze: 1.9
Ministerstvo spravedlnosti ČR a CCA Group
Webová služba aplikace ISIR
Popis způsobu používání webové služby
rocnikVsNs
int (4)
senatICm
int (6)
druhVecICm
string (10)
bcVecICm
int (6)
rocnikICm
int (4)
Ministerstvo spravedlnosti ČR a CCA Group
strana 29 ze 29 verze: 1.9