Popis egon služ by. E231 - rppvypisseznamukonunazadost. Název dokumentu: Popis egon služeb Verze: Datum aktualizace: Správa základních registrů

Transkript

1 Popis egon služ by E231 - rppvypisseznamukonunazadost Název dokumentu: Popis egon služeb Verze: Autor: Správa základních registrů Datum aktualizace: Účel: Popis egon služeb v rámci základních registrů Počet stran:

2 Obsah 1 Účel dokumentu Funkcionalita služby Základní informace o službě Historie služby Účel služby - detailní popis Věcná pravidla vztahující se ke zpracování služby Obecné vlastnosti služeb RPP 4 7 Rozpad egon služby na primitivní služby Seznam a popis využívaných primitivních služeb Workflow zpracování služby 4 8 Vstupní údaje ZadostInfo Zadost 5 9 Kontroly při volání služby Příklad volání služby Příklad volání služby 5 11 Výstupní údaje OdpovedInfo Stavy RppOdpoved 6 12 Příklad odpovědi Příklad odpovědi 7 13 Notifikace změn Chybová hlášení Odkazy na další dokumenty Definice služby Egon služby 13 Na Vápence 14 Strana 2 z 13

3 1 Účel dokumentu Účelem tohoto dokumentu je především poskytnout orgánům veřejné moci, obecně uživatelům Základních registrů, jednoduchý a srozumitelný popis jak používat příslušnou egon službu, včetně informací pro IT pracovníky orgánů veřejné moci. Změny provádí SZR. 2 Funkcionalita služby Služba vrátí seznam úkonů na žádost, které vyhovují výběru podle hodnot zadaných ve vstupních parametrech. 3 Základní informace o službě Název služby Označení služby rppvypisseznamukonunazadost E231 Verze služby V1.0 Publikována v katalogu služeb od verze Platnost od Platnost do Stav služby Nahrazena službou Nahrazuje službu Třída služby Dostupnost služby, potřebná oprávnění Režim služby SLA služby Aktivní S4 synchronní i asynchronní SLA-04 4 Historie služby V tabulce níže jsou uvedeny údaje o všech verzích dané služby, jejím životním cyklu v produkčním prostředí a popis změn mezi jednotlivými verzemi. Verze služby Aktuální stav verze Publikovaná v produkčním prostředí Od V1.0 Aktivní Prvotní verze Do Popis změn oproti předchozí verzi Na Vápence 14 Strana 3 z 13

4 5 Účel služby - detailní popis Služba E231 rppvypisseznamukonunazadost vrátí seznam úkonů na žádost, které vyhovují výběru podle hodnot zadaných ve vstupních parametrech. 6 Věcná pravidla vztahující se ke zpracování služby Služba je předána na RPP, kde jsou provedeny věcné kontroly a vlastní vykonání služby. Data výstupu služby jsou předána volajícímu AIS. Věcné kontroly RPP: Pro výběr musí být zadán alespoň jeden vstupní parametr pro podmínku výběru. Služba vrací maximálně 1000 záznamů (počet vrácených záznamů může uživatel snížit zadáním hodnoty do parametru MaximalniPocet). 6.1 Obecné vlastnosti služeb RPP Veškerá volání služeb RPP jsou logována v RPP. 7 Rozpad egon služby na primitivní služby 7.1 Seznam a popis využívaných primitivních služeb V rámci zpracování jsou využívány následující interní služby: - P74 rppvypisseznamukonunazadost vrátí seznam úkonů na žádost. 7.2 Workflow zpracování služby 8 Vstupní údaje Vstupní údaje obsahují položky definované v datovém typu RppVypisSeznamUkonuNaZadostType. Bez správného vyplnění vstupních údajů nelze transakci zpracovat. 8.1 ZadostInfo Položka ZadostInfo představuje standardní hlavičku datové zprávy dotazu, která je odesílána ke zpracování. Struktura a obsah hlavičky zprávy jsou dány datovým typem ZadostInfoType. Obsahuje údaje, které ISZR vyžaduje pro ověření přístupu ke službě. Povinné položky musí být vyplněny. Na Vápence 14 Strana 4 z 13

5 8.2 Zadost Položka Zadost slouží k detailní specifikaci požadavků na službu. Vstupní parametry jsou uvedeny v elementu RppVypisSeznamUkonuNaZadostData. V tomto elementu se specifikují parametry pro vyhledání úkonů na žádost. Všechny parametry jsou nepovinné: výpis k datu (KDatu) pokud zadáno, musí být větší než aktuální, kód činnosti (KodCinnosti), typ subjektu (TypSubjektu), zda je možné provést úkon elektronicky (UkonElektronicky), místní příslušnost (MistniPrislusnost), kód agendy a datum platnosti agendy (VerzeAgendy), kód agendy (Agenda), identifikátor úkonu (IdentifikatorUkonu) maximální počet vrácených záznamů (MaximalniPocet) 9 Kontroly při volání služby Na vstupu jsou prováděny běžné kontroly na oprávnění při volání služby. Dále jsou prováděny věcné kontroly popsané v kapitole Vstupní údaje. 10 Příklad volání služby 10.1 Příklad volání služby <?xml version="1.0"?> <RppVypisSeznamUkonuNaZadostType xmlns:xsi=" xmlns:xsd=" <ZadostInfo xmlns="urn:cz:isvs:iszr:schemas:iszrabstract:v1"> <CasZadosti xmlns="urn:cz:isvs:reg:schemas:regtypy:v1"> T13:02: :00</CasZadosti> <Agenda xmlns="urn:cz:isvs:reg:schemas:regtypy:v1">x999</agenda> <AgendovaRole xmlns="urn:cz:isvs:reg:schemas:regtypy:v1">xr1</agendovarole> <Ovm xmlns="urn:cz:isvs:reg:schemas:regtypy:v1"> </ovm> <Ais xmlns="urn:cz:isvs:reg:schemas:regtypy:v1">999001</ais> <Subjekt xmlns="urn:cz:isvs:reg:schemas:regtypy:v1">subjekt F5klient</Subjekt> <Uzivatel xmlns="urn:cz:isvs:reg:schemas:regtypy:v1">uzivatel</uzivatel> <DuvodUcel xmlns="urn:cz:isvs:reg:schemas:regtypy:v1">duvod a ucel/testid=0</duvoducel> <AgendaZadostId xmlns="urn:cz:isvs:reg:schemas:regtypy:v1">9591ffa1-a3ba fc-64663f816472</agendazadostid> </ZadostInfo> <Zadost xmlns="urn:cz:isvs:iszr:schemas:iszrrppvypisseznamukonunazadost:v1"> <RppVypisSeznamUkonuNaZadostData /> </Zadost> </RppVypisSeznamUkonuNaZadostType> 11 Výstupní údaje Výstupní údaje jsou definované datovým typem RppVypisSeznamUkonuNaZadostResponseType. Na Vápence 14 Strana 5 z 13

6 11.1 OdpovedInfo Struktura položky OdpovedInfo obsahuje údaje, které ISZR ale i AIS očekává k dokončení vyřízení požadavku. Struktura a obsah hlavičky zprávy jsou dány datovým typem OdpovedInfoType Stavy Stav provedení služby je uveden v elementu Status/VysledekKod: - OK služba byla zpracována v pořádku - CHYBA zpracování není možné provést - VAROVANI služba byla zpracována v pořádku, ale vstupní parametry nejsou formálně správné, případně je výsledkem prázdná množina Pokud skončí služba stavem CHYBA nebo VAROVANI a jsou známy detailnější informace, jsou podrobnosti uvedeny v elementu VysledekDetail. Definované chybové stavy jsou uvedeny v následující tabulce: VysledekSubKod NEVALIDNI_ZADOST PRAZDNY_POVINNY_PARAMETR NEVALIDNI_DATA OBECNA_CHYBA_SLUZBY VysledekPopis Kód služby není definován nebo je neznámý. Parametry výběru OVM nebo SPUU musí být vyplněny. Stavy varování jsou uvedeny v následující tabulce: VysledekSubKod VysledekPopis PREKROCEN_POCET Maximální počet záznamů: {0}. PRAZDNY_SEZNAM Pro zadané vstupní parametry nebyl nalezen žádný záznam úkonu na žádost. Stav CHYBA dále může nastat v situaci, kdy službu nebylo možné z nějakého závažného důvodu vykonat nebo sestavit odpověď. Příkladem situace, ve které vzniká tato chyba, je například chybný vstup služby, nedostupnost databáze nebo základního registru a podobně RppOdpoved Položka je vyplněna, pokud bylo provedeno volání RPP. V elementu jsou vrácena aplikační data. Jsou umístěna v elementu RppVypisSeznamUkonuNaZadostDataResponse. Služba vrací seznam úkonů na žádost, které vyhovují zadaným vstupním parametrům. Vrací 0 až max 1000 záznamů v seznamu a výsledný status zpracování služby. V záznamu o úkonu na žádost se vrací: kód agendy, datum počátku platnosti verze agendy, unikátní identifikátor úkonu, název úkonu, Na Vápence 14 Strana 6 z 13

7 komentář úkonu, umožnění elektronické formy úkonu, subjekty, které úkon vykonávají. 12 Příklad odpovědi 12.1 Příklad odpovědi <?xml version="1.0"?> <RppVypisSeznamUkonuNaZadostResponseType xmlns:xsi=" xmlns:xsd=" <OdpovedInfo xmlns="urn:cz:isvs:iszr:schemas:iszrabstract:v1"> <CasOdpovedi xmlns="urn:cz:isvs:reg:schemas:regtypy:v1"> T13:02: :00</CasOdpovedi> <Status xmlns="urn:cz:isvs:reg:schemas:regtypy:v1"> <VysledekKod>OK</VysledekKod> </Status> <AgendaZadostId xmlns="urn:cz:isvs:reg:schemas:regtypy:v1">9591ffa1-a3ba fc-64663f816472</agendazadostid> <IszrZadostId xmlns="urn:cz:isvs:reg:schemas:regtypy:v1">e0f3cdb b-a6a6-3a9d009a5e7d</iszrzadostid> </OdpovedInfo> <RppOdpoved xmlns="urn:cz:isvs:iszr:schemas:iszrrppvypisseznamukonunazadost:v1"> <RppVypisSeznamUkonuNaZadostDataResponse> <AplikacniStatus xmlns="urn:cz:isvs:rpp:schemas:rppdotazydata:v1"> <VysledekKod xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1">ok</vysledekkod> </AplikacniStatus> <SeznamUkonu xmlns="urn:cz:isvs:rpp:schemas:rppdotazydata:v1"> <KodAgendy>A1181</KodAgendy> <DatumPlatnostiOd> </DatumPlatnostiOd> <Identifikator>U361</Identifikator> <Nazev>Zaměření budov a záznamy do systémů</nazev> <Komentar>Zaměření budov a záznamy do systémů</komentar> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1">ko116</subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1">ko127</subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <KodAgendy>A1181</KodAgendy> <DatumPlatnostiOd> </DatumPlatnostiOd> <Identifikator>U381</Identifikator> <Nazev>Poskytování geografických dat</nazev> <Komentar>Poskytování geografických dat</komentar> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1">ko116</subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1">ko127</subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <KodAgendy>A1181</KodAgendy> <DatumPlatnostiOd> </DatumPlatnostiOd> <Identifikator>U382</Identifikator> Na Vápence 14 Strana 7 z 13

8 <Nazev>Příprava a předání geografických dat</nazev> <Komentar>Příprava a předání geografických dat ostatním systémům, komunikace s ostatními systémy na jejich vyžádání</komentar> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1">ko116</subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1">ko127</subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <KodAgendy>A1181</KodAgendy> <DatumPlatnostiOd> </DatumPlatnostiOd> <Identifikator>U383</Identifikator> <Nazev>Inspekce v zeměměřictví</nazev> <Komentar>Inspekce v zeměměřictví, kontroly, sankce, právní dohled</komentar> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1">ko116</subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1">ko127</subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <KodAgendy>A8623</KodAgendy> <DatumPlatnostiOd> </DatumPlatnostiOd> <Identifikator>U101</Identifikator> <Nazev>Úkon pro všechny</nazev> <Komentar>úkon pro všechny</komentar> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1">ko851</subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1">ko14</subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <KodAgendy>A8623</KodAgendy> <DatumPlatnostiOd> </DatumPlatnostiOd> <Identifikator>U41</Identifikator> <Nazev>Úkon FO</Nazev> <Komentar>Úkon OVM - FO</Komentar> <UkonElektronicky>Ne</UkonElektronicky> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1">ko851</subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <KodAgendy>A8623</KodAgendy> <DatumPlatnostiOd> </DatumPlatnostiOd> <Identifikator>U42</Identifikator> <Nazev>Úkon PFO</Nazev> <Komentar>Úkon OVM - PFO</Komentar> Na Vápence 14 Strana 8 z 13

9 <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <KodAgendy>A8623</KodAgendy> <DatumPlatnostiOd> </DatumPlatnostiOd> <Identifikator>U61</Identifikator> <Nazev>Úkon PO</Nazev> <Komentar>Úkon OVM - PO</Komentar> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1">ko851</subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <KodAgendy>A8663</KodAgendy> <DatumPlatnostiOd> </DatumPlatnostiOd> <Identifikator>U181</Identifikator> <Nazev>Úkon dopravy</nazev> <Komentar>Úkon dopravy</komentar> <KodAgendy>A8663</KodAgendy> <DatumPlatnostiOd> </DatumPlatnostiOd> <Identifikator>U201</Identifikator> <Nazev>Úkon kultury</nazev> <Komentar>Úkon kultury</komentar> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <KodAgendy>A8663</KodAgendy> <DatumPlatnostiOd> </DatumPlatnostiOd> <Identifikator>U202</Identifikator> <Nazev>Úkon OVM</Nazev> <Komentar>Úkon OVM</Komentar> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <KodAgendy>A8703</KodAgendy> <DatumPlatnostiOd> </DatumPlatnostiOd> <Identifikator>U261</Identifikator> <Nazev>Úkony OVM</Nazev> <Komentar>Úkony OVM</Komentar> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> Na Vápence 14 Strana 9 z 13

10 <KodAgendy>A8703</KodAgendy> <DatumPlatnostiOd> </DatumPlatnostiOd> <Identifikator>U262</Identifikator> <Nazev>Úkony OVM státních úřadů</nazev> <Komentar>Úkony OVM státních úřadů</komentar> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <KodAgendy>A8703</KodAgendy> <DatumPlatnostiOd> </DatumPlatnostiOd> <Identifikator>U281</Identifikator> <Nazev>Úkony kategorie OVM</Nazev> <Komentar>Úkony kategorie OVM</Komentar> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <KodAgendy>A8823</KodAgendy> <DatumPlatnostiOd> </DatumPlatnostiOd> <Identifikator>U321</Identifikator> <Nazev>Poskytování informací 1</Nazev> <Komentar>Poskytování informací</komentar> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <KodAgendy>A8823</KodAgendy> <DatumPlatnostiOd> </DatumPlatnostiOd> <Identifikator>U322</Identifikator> <Nazev>Poskytování informací 2</Nazev> <Komentar>Poskytování informací</komentar> <UkonElektronicky>Ne</UkonElektronicky> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <KodAgendy>A8823</KodAgendy> <DatumPlatnostiOd> </DatumPlatnostiOd> <Identifikator>U341</Identifikator> <Nazev>Poskytování informací 3</Nazev> <Komentar>Poskytování informací</komentar> Na Vápence 14 Strana 10 z 13

11 <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <KodAgendy>A8863</KodAgendy> <DatumPlatnostiOd> </DatumPlatnostiOd> <Identifikator>U401</Identifikator> <Nazev>Úkon informační 1</Nazev> <Komentar>Úkon informační</komentar> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <KodAgendy>A8863</KodAgendy> <DatumPlatnostiOd> </DatumPlatnostiOd> <Identifikator>U402</Identifikator> <Nazev>Úkon informační 2</Nazev> <Komentar>Úkon informační</komentar> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <KodAgendy>A8863</KodAgendy> <DatumPlatnostiOd> </DatumPlatnostiOd> <Identifikator>U421</Identifikator> <Nazev>Úkon informační 4</Nazev> <Komentar>Úkon informační</komentar> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <KodAgendy>A8883</KodAgendy> <DatumPlatnostiOd> </DatumPlatnostiOd> <Identifikator>U441</Identifikator> <Nazev>Úkon FO</Nazev> <Komentar>úkon pro fyzické osoby</komentar> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <KodAgendy>A8883</KodAgendy> <DatumPlatnostiOd> </DatumPlatnostiOd> <Identifikator>U461</Identifikator> <Nazev>Úkon PFO</Nazev> <Komentar>úkon podnikající fyzické osoby</komentar> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> Na Vápence 14 Strana 11 z 13

12 <KodAgendy>A8883</KodAgendy> <DatumPlatnostiOd> </DatumPlatnostiOd> <Identifikator>U481</Identifikator> <Nazev>Úkon PO</Nazev> <Komentar>úkon pro právnickou osobu</komentar> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <KodAgendy>A8983</KodAgendy> <DatumPlatnostiOd> </DatumPlatnostiOd> <Identifikator>U561</Identifikator> <Nazev>úkon OVM</Nazev> <Komentar>úkon všech OVM</Komentar> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <KodAgendy>A8983</KodAgendy> <DatumPlatnostiOd> </DatumPlatnostiOd> <Identifikator>U581</Identifikator> <Nazev>Úkon OVM v kategorii</nazev> <Komentar>Úkon OVM v kategorii</komentar> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> <Subjekt xmlns="urn:cz:isvs:rpp:schemas:rpptypy:v1"> </subjekt> </SeznamUkonu> </RppVypisSeznamUkonuNaZadostDataResponse> </RppOdpoved> </RppVypisSeznamUkonuNaZadostResponseType> 13 Notifikace změn Služba není editační, notifikace změn pro ni není relevantní. 14 Chybová hlášení Služba neobsahuje specifická chybová hlášení. 15 Odkazy na další dokumenty 15.1 Definice služby WSDL služby: XSD služby: egon/wsdl/iszrrppvypisseznamukonunazadost.wsdl egon/xsd/iszrrppvypisseznamukonunazadost.xsd Na Vápence 14 Strana 12 z 13

13 15.2 Egon služby SZR_popis_eGON_služeb_E230_rppCtiZmenyUkonuNaZadost.docx SZR_popis_eGON_služeb_E232_rppVypisUkonNaZadost.docx Na Vápence 14 Strana 13 z 13