Popis webových služeb pro uživatele
Název dokumentu
Popis webových služeb pro uživatele
Název souboru
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Verze APV
7.1
Verze dokumentu
1.0
Dostupnost
www.cuzk.cz / distribuce koncovým uživatelům
Zpracoval
NESS Czech s.r.o.
Datum
15.8.2013
Kontroloval
Ing. Jan Bílek, konzultant ČÚZK
Datum
19.8.2013
Schválil
Ing. Karel Štencel, místopředseda ČÚZK
Datum
19.8.2013
Číslo jednací
ČÚZK-08523/2013-24
Platnost od
26.8.2013
Popis webových služeb pro uživatele
Obsah: 2
Základní informace............................................................................................................................... 5 Použité zkratky ..................................................................................................................................... 5 3 Webové služby používající RPC style ................................................................................................ 7 3.1 Přístupový bod .............................................................................................................................. 7 3.2 Vstupní formát ............................................................................................................................... 8 3.3 Formát datumových parametrů ................................................................................................... 8 3.4 Kontrola formátů parametrů ........................................................................................................ 9 3.5 Parametry specifické pro jednotlivé typy uživatelů .................................................................. 9 3.6 Číselníky ...................................................................................................................................... 10 3.7 Sestavy ......................................................................................................................................... 10 Seznam sestav .................................................................................................................................... 10 Odebrání sestavy ............................................................................................................................... 11 Smazání sestavy................................................................................................................................. 11 List vlastnictví .................................................................................................................................... 11 Kopie katastrální mapy ...................................................................................................................... 14 Informace o parcelách ....................................................................................................................... 15 Informace o stavbách ........................................................................................................................ 16 Informace o jednotkách ..................................................................................................................... 17 Informace o řízení ............................................................................................................................... 18 Informace o definičních bodech ....................................................................................................... 19 Přehled vlastnictví.............................................................................................................................. 20 Evidence práv pro osobu .................................................................................................................. 21 Výpis zákaznického účtu ................................................................................................................... 21 3.8 Vyhledávaní ................................................................................................................................. 22 Vyhledávání OS .................................................................................................................................. 22 Vyhledávaní parcely ........................................................................................................................... 22 Vyhledávaní stavby ............................................................................................................................ 23 Vyhledávaní jednotky......................................................................................................................... 23 Získání MBR ........................................................................................................................................ 23 3.9 Správa účtu .................................................................................................................................. 24 Změna hesla uživatele ....................................................................................................................... 24 3.10 Příklady volání webových služeb (WS) ................................................................................. 25 3.11 Autorizace ................................................................................................................................ 31 4 Webové služby 2 verze (WS2) ........................................................................................................... 32 4.1 Přístupový bod ............................................................................................................................ 32 4.2 Obecný vstupní formát ............................................................................................................... 32 4.3 Výstupní formát ........................................................................................................................... 32 4.4 Formát datumových parametrů ................................................................................................. 33 4.5 Kontrola formátů parametrů ...................................................................................................... 33 4.6 Parametry specifické pro jednotlivé typy uživatelů ................................................................ 33 4.7 Číselníky ...................................................................................................................................... 33 4.8 Informace ..................................................................................................................................... 35 Získání MBR ........................................................................................................................................ 35 4.9 Sestavy ......................................................................................................................................... 36 Seznam sestav .................................................................................................................................... 36 Odebrání sestavy ............................................................................................................................... 36
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 2/73
Popis webových služeb pro uživatele
5 6
7
8
Smazání sestavy................................................................................................................................. 36 Společná část požadavků na sestavu .............................................................................................. 37 List vlastnictví .................................................................................................................................... 37 Kopie katastrální mapy ...................................................................................................................... 38 Informace o parcelách ....................................................................................................................... 39 Informace o stavbách ........................................................................................................................ 39 Informace o jednotkách ..................................................................................................................... 40 Informace o řízení ............................................................................................................................... 40 Informace o definičních bodech ....................................................................................................... 41 Přehled vlastnictví.............................................................................................................................. 41 Evidence práv pro osobu .................................................................................................................. 42 Výpis zákaznického účtu ................................................................................................................... 42 4.10 Správa účtu .............................................................................................................................. 43 Změna hesla uživatele ....................................................................................................................... 43 4.11 Vyhledávaní.............................................................................................................................. 43 Vyhledávání OS .................................................................................................................................. 43 Vyhledávaní parcely ........................................................................................................................... 43 Vyhledávaní stavby ............................................................................................................................ 44 Vyhledávaní jednotky......................................................................................................................... 44 4.12 Příklady volání webových služeb (WS) ................................................................................. 44 4.13 Autorizace ................................................................................................................................ 48 4.14 Bezpečnost .............................................................................................................................. 49 4.15 Zahrnutí provozních informací do odpovědí webových služeb ......................................... 49 Zpoplatnění poskytovaných výstupů ............................................................................................... 51 Vracení sestav .................................................................................................................................... 52 6.1 Sestavy – možné stavy ............................................................................................................... 52 6.2 List vlastnictví - záložky ............................................................................................................. 52 Podrobný popis záložek .................................................................................................................... 53 XML formát sestav ............................................................................................................................. 54 6.3 Kódování diakritiky ..................................................................................................................... 54 6.4 Omezení délky výstupů .............................................................................................................. 54 6.5 Omezení uživatelů typu Bezúplatný uživatel, Ověřující osoba .............................................. 54 6.6 Definice chyb ............................................................................................................................... 55 Prostředí pro ověření služeb WSDP ................................................................................................. 56 XSD definice WSDP v1....................................................................................................................... 56 WSDL soubory WSDP v1 ................................................................................................................... 56 WSDL soubory WSDP v2 ................................................................................................................... 56 XSD definice WSDP v2....................................................................................................................... 56 Přílohy ................................................................................................................................................. 58 8.1 Příloha 1 Komunikace klient – server (RPC) ............................................................................ 58 8.2 Příloha 2: Komunikace klient – server (WS2) ........................................................................... 65 8.3 Příloha 3: Přehled změn ve výstupech generovaných do XML .............................................. 69 VypisZKatastruNemovitosti.xsd ....................................................................................................... 69 PrehledVlastnictvi.xsd ....................................................................................................................... 71 InformaceOStavbach.xsd .................................................................................................................. 71 InformaceOParcelach.xsd ................................................................................................................. 71 InformaceOJednotkach.xsd .............................................................................................................. 72
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 3/73
Popis webových služeb pro uživatele
1
Úvod
ISKN je součástí ISVS pro správu a vedení KN. V tomto dokumentu jsou popsány jednotlivé webové služby včetně služeb podpůrných (číselníky, vyhledávání, seznam výstupů a vyžádání výstupu), způsoby jejich volání a struktura odpovědí. Dále je zde popsán společný způsob autorizace. Dokument je vypracován v souladu se zákonem č. 365/2000 Sb., o informačních systémech veřejné správy, ve znění pozdějších předpisů, a na základě požadavků vyhlášky č. 529/2006 Sb., o požadavcích na strukturu a obsah informační koncepce a provozní dokumentace a o požadavcích na řízení bezpečnosti a kvality informačních systémů veřejné správy (vyhláška o dlouhodobém řízení informačních systémů veřejné správy). Zkratky použité v tomto dokumentu jsou vysvětleny v kapitole Použité zkratky.
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 4/73
Popis webových služeb pro uživatele
2 Základní informace Od listopadu 2007 je Výpis z KN v PDF formátu v části B rozšířen o záložky (bookmarks), které umožňují jeho jednodušší automatické zpracování. Tato nová funkčnost je popsána v kapitole Chyba! Nenalezen zdroj odkazů.. Od ledna 2008 je funkčnost webových služeb rozšířena o poskytování částečného výpisu z KN – změny vyvolané tímto rozšířením jsou do tohoto popisu zapracovány. Od ledna 2009 je funkčnost webových služeb rozšířena o sestavu „Informace o řízení“ a „Kopie katastrální mapy“. Od května 2009 je funkčnost webových služeb rozšířena o výstupy ve formátu XML a doplněna o novou sestavu „Informace o definičních bodech“ (pouze ve formátu XML). Od června 2010 je funkčnost webových služeb upravena následovně: - je vytvořena nová funkce dejMBRParcel, která umožňuje získat minimální opsaný obdélník pro každou ze zadaných parcel, - sestava Výpis z KN ve formátu XML byla doplněna o elektronickou značku, - sestava Výpis z KN byla doplněna o název a kód katastrálního pracoviště vykonávající správu KN v daném území, - došlo ke změnám ve funkci najdiOS, včetně úprav vráceného XML (doplnění informací o SJM, doplnění části rodného čísla odpovídající datu narození), - byla upravena funkce vratCiselniky/seznamPracovist, nyní obsahuje adresu pracoviště, e-mail a adresu datové schránky. Od srpna 2011 jsou PDF i XML výstupy sestav „Informace o parcelách/stavbách/jednotkách“ doplněny textem „Tiskový výstup informativního charakteru“. Ve verzi APV 6.0 (v provozu od 15. 8. 2011) dochází ke změnám v XSD souborech popisujících sestavy ve formátu XML. Změnou technologické infrastruktury došlo ke změně SOAP zpráv a označování příloh. Nový je též certifikát pro SSL komunikaci (vydavatel GeoTrust). Od verze APV 7.1 (v provozu od 26. 8. 2013) jsou provozovány paralelní webové služby, používající jiný způsob implementace, který je založen na používání WSS, striktní kontrole vůči XSD a zejména vyhlašování chyb rozhraní. Tyto služby jsou zde nazvány „WS2“, „WSDP2“ nebo „webové služby 2. verze“.
Použité zkratky Zkratka
Text
APV ČÚZK DB DP ID ISKN k.ú. KN LV
aplikační programové vybavení – základní aplikace pro práci se systémem ISKN Český úřad zeměměřický a katastrální Databáze dálkový přístup unikátní identifikátor záznamu v tabulce informační systém katastru nemovitostí katastrální území katastr nemovitostí list vlastnictví
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 5/73
Popis webových služeb pro uživatele
Zkratka
Text
MBR
minimum bounding rectangle – minimální ohraničující obdélník SOAP Message Transmission Optimization Mechanism – systém přenášení příloh v SOAP protokolu (viz http://www.w3c.org) oprávněný subjekt v případě popisu programového prostředí operační systém Portable Document Format (standard ISO 32000) Remote Procedure Call – vzdálené volání procedur Uniform Resource Locator – adresa zdroje Web Service Description Language – jazyk popisující webové služby Web Service Security – způsob zabezpečení webových služeb, rozšiřující standard SOAP eXtensible Markup Language Definice struktury XML (XML Schema Definition) webové služby Označení webových služeb nové verze Webové služby Dálkového přístupu do KN – název aplikace provozované ČÚZK
MTOM OS PDF RPC URL WSDL WSS XML XSD WS WS2, WSDP2 WSDP
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 6/73
Popis webových služeb pro uživatele
3 Webové služby používající RPC style 3.1
Přístupový bod
Jedná se o WSDP verze 1.0 a tato verze bude v budoucí verzi ISKN zrušena. Je třeba se seznámit s novou implementací viz kapitola Webové služby 2 verze (WS2). Každá webová služba je přístupná přes uvedený přístupný bod, který se skládá z několika částí: https://[doména]/[kontextAplikace]/[názevSlužby] (Např. https://katastr.cuzk.cz/isknws/sestavy pro práci se sestavami). Při nedostupnosti aplikačního serveru jsou předsunuté webové servery nastaveny tak, aby jako chybovou odpověď při dotazu na kontext aplikace isknws vracely jako odpověď: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <SOAP-ENV:Fault>
SOAP-ENV:Server Requested service is inaccessible <detail> <e:myfaultdetails xmlns:e="https://katastr.cuzk.cz/uvod/odstavky.aspx"> <message> Aplikace Dálkový přístup do katastru není právě dostupná. Sledujte prosím provozní informace na úvodní stránce Dálkového přístupu. Případně vyčkejte prosím nějakou dobu a pokuste se akci zopakovat. <errorcode> 1001
V případě zadání nesprávné URL (http chyba 404) vrací WSDP: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <SOAP-ENV:Fault>
SOAP-ENV:Server Requested service is inaccessible <detail> <e:myfaultdetails xmlns:e="https://katastr.cuzk.cz/uvod/odstavky.aspx"> <message> Váš požadavek nemohl být zpracován. Zkontrolujte, zdali přistupujete na správnou adresu. Je také možné, že aplikace Dálkový přístup do katastru není právě dostupná. V takovém případě sledujte prosím provozní informace na úvodní stránce Dálkového přístupu, případně vyčkejte prosím nějakou dobu a pokuste se akci zopakovat. <errorcode> 1002
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 7/73
Popis webových služeb pro uživatele
3.2
Vstupní formát
V dotazu je používán vstupní formát typu RPC style. Webová služba obsahuje více vstupních parametrů, definovaných u jednotlivých služeb. Výhodou toho formátu je, že vstupní formát je přímo definován ve WSDL, vstupní parametry jsou automaticky rozparsovány. Volání služby na straně klienta je jednodušší. Každý výstup je zabalen do obálky isknResponse. Obálka má 7 hlavních častí, z nichž je vyplněna větev 1 – chyba nebo větev 1 (může být prázdná <error/>) spolu s jednou z větví 2-7: 1. chyba, která je vyplněna pouze v případě chyby nebo varování 2. větev pro vrácení reportu 3. větev pro vrácení seznamu reportů 4. větev pro vrácení vyhledaných objektů (parcel, staveb a jednotek) 5. větev pro vrácení vyhledaných OS 6. větev pro vrácení seznamu událostí 7. větev pro vrácení obsahu číselníků Webové služby jsou rozděleny do 4 skupin. Každá skupina funkcí má stejný přístupový bod a k jedné skupině existuje jeden WSDL soubor popisující funkce a jejich parametry. WSDL soubor je dostupný přes URL: https://katastr.cuzk.cz/static/wsdl/[název WSDL souboru] (např. https://katastr.cuzk.cz/static/wsdl/sestavy.wsdl popisující práci se sestavami). Skupiny:
číselníky
(ciselnik.wsdl)
sestavy
(sestavy.wsdl)
vyhledávaní
(vyhledat.wsdl)
správa účtu
(ucet.wsdl)
3.3
Formát datumových parametrů
Vstupní parametry služeb sloužící pro předávání datumových hodnot akceptují formát „yyyy-mm-ddThh24:mi:ss“. Výstupní parametry obsahující datum a čas používají tentýž formát. Výstupní parametry obsahující pouze datum pak formát „yyyy-mm-dd“. Formáty znakových parametrů Název parametru
Popis
automatickeZaplaceni, overovaciDolozka, castecnyVypis, orientaceNaSirku, vecnaBremena
znaková hodnota nabývající „a“, „n“ (case insensitive)
format
znaková hodnota nabývající „PDF“ nebo „XML“
typPravnihoVztahuKod
znaková hodnota max. délky 4 znaků
typSeznamuObjektu
hodnota nabývající „PAR_S“,“STA_S“,“JED_S“ (case insensitive)
Rc
hodnota min. délky 9 a max. délky 10, kde jednotlivé znaky mohou nabývat hodnot „0“-„9“
rclcoOS
znaková hodnota max. délky 10 znaků
Username
znaková hodnota max. délky 30 znaků
seznamObjektu, seznamParcel
pole celočíselných hodnot max. délky 30
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 8/73
Popis webových služeb pro uživatele
password, noveHeslo
znaková hodnota
Nazev
znaková hodnota max délky 255
nazevOS
znaková hodnota max délky 255
cisloJednaci, poradoveCislo
znaková hodnota max. délky 20 znaků
cisloRizeni
hodnota délky 12 – 21 znaků
meritkoMapy
znaková hodnota jednoho z čísel (500, 1000, 2000)
formatPapiru
znaková hodnota nabývající „A3“, „A4“ (case insensitive)
souradniceX
znaková hodnota číselná s pevnou desetinnou čárkou délky 9,2 (7 číslic před desetinnou čárkou, 2 za desetinnou čárkou)
souradniceY
znaková hodnot číselná s pevnou desetinnou čárkou délky 8,2. (6 číslic před desetinnou čárkou, 2 za desetinnou čárkou)
Formáty celočíselných parametrů všechny celočíselné hodnoty jsou očekávány bez znaménka typStavbyKod
celočíselná hodnota délky 1
krajKod, ucelKod
celočíselná hodnota max. délky 2
Poddeleni
celočíselná hodnota max. délky 3
cpCe
celočíselná hodnota max. délky 4
kmenoveCislo
celočíselná hodnota max. délky 5
kmenoveCislo
celočíselná hodnota max. délky 5
cisloLV, katastrUzemiKod, celočíselná hodnota max. délky 6 castObceKod, obecKod ico
celočíselná hodnota max. délky 8
cisloJednotky
celočíselná hodnota max. délky 10
idSestava, idLV, idOS, celočíselná hodnota max. délka 30 staId, parcId, jednId, rizId maximalniCena
3.4
celočíselná hodnota bez znaménka
Kontrola formátů parametrů
V případě, že funkce je vyvolána s formátem neodpovídajícím výše uvedeným omezením, funkce vrátí chybu 116.
3.5
Parametry specifické pro jednotlivé typy uživatelů
Dále v textu dokumentu se ověřující osobou rozumí uživatel, který k WS přistupuje pod účtem typu „Ověřující“. Parametry ucelKod, cisloJednaci, poradoveCislo a overovaciDolozka jsou použity u služeb vytvářejících výstupy z katastru nemovitostí ve formátu PDF/XML. S výjimkou výstupů, které zadání těchto parametrů nevyžadují (vypisUctu), tak jako je tomu v interaktivní aplikaci DP. Parametry ucelKod a cisloJednaci jsou povinné pro bezúplatné uživatele. V případě, že hodnoty parametrů jsou vyplněny u uživatele jiného typu, jsou tyto hodnoty ignorovány. Hodnoty parametru ucelKod jsou kontrolovány proti platným hodnotám číselníku účelů. Pokud kód v číselníku neexistuje, je vrácena chyba 117.
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 9/73
Popis webových služeb pro uživatele
Parametr poradoveCislo je povinný pro ověřující osoby. V případě, že hodnota parametru je vyplněna u uživatele jiného typu, je tato hodnota ignorována. Parametr overovaciDolozka je volitelný parametr pro ověřující osoby. V případě, že parametr u tohoto typu uživatele není zadán, použije se výchozí hodnota „n“. V případě, že je hodnota parametru vyplněna a služba je vyvolána uživatelem jiného typu, je tato hodnota ignorována. Parametry poradoveCislo a overovaciDolozka jsou použity u všech služeb generujících sestavy (s výjimkou vypisUctu). Povolené hodnoty parametrů jsou kontrolovány vždy, tj. i v případě, kdy uživatel vyplní parametr, který je pro takový typ uživatele ignorován. Např. pokud platící uživatel vyplní parametr overovaciDolozka hodnotou „X“, bude vyhlášena chyba 116.
3.6
Číselníky
V této skupině služeb je funkce na vyhledávání hodnot v číselníku. Přístupový bod webové služby je https://katastr.cuzk.cz/isknws/ciselnik. Název funkce: vratCiselniky Vstupní formát a parametry: RPC style Název parametru
Nepovinný
Popis
username
Ne
Přihlašovací jméno uživatele do Dálkového přístupu
password
Ne
Heslo uživatele
nazevCiselniku
Ne
Název číselníku ze seznamu číselníků. Jedním typem číselníku je pseudo-číselník s názvem seznamCiselniku, který vrací seznam všech číselníků
omezujiciParametr
ano
Hodnota omezujícího parametru pro omezení výstupních hodnot ve formě sloupec (porovnávací operátor) hodnota. Formát omezujícího parametru se kontroluje; pokud neodpovídá uvedenému formátu, je vráceno chybové hlášení. Omezující sloupec se kontroluje vůči seznamu povolených atributů definovaných v číselníku. Jsou povoleny porovnávací operátory =, !=, <, > a LIKE.
zmenenOd
ano
Datum a čas, ke kterému má uživatel číselník již k dispozici. Pokud je vyplněn a datum/čas poslední změny daného číselníku je starší než zadaná hodnota, vrátí funkce jenom vyplněnou část error, s hodnotou 308.
Výstupní formát: XML dokument definovaný XSD dostupným na URL https://katastr.cuzk.cz/static/xml/ciselnik.xsd, zabalený do isknResponse – vyplněná větev ciselnikList Funkce: Umožní načíst obsah číselníků, vyhledat název podle kódu a vyhledat seznam na základě omezující podmínky.
3.7
Sestavy
V této skupině služeb je funkce pro práci se sestavami – zařazení, odebrání, atd. Přístupový bod webové služby je https://katastr.cuzk.cz/isknws/sestavy Pomocí webových služeb není možné vytvářet sestavy k historii, služby nemají vstupní parametr pro zadání datumu.
Seznam sestav Název funkce: seznamSestav Vstupní formát: RPC style Název parametru
Nepovinný
Popis
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 10/73
Popis webových služeb pro uživatele
Název parametru
Nepovinný
Popis
username
Ne
Přihlašovací jméno uživatele do Dálkového přístupu
password
Ne
Heslo uživatele
idSestava
Ano
Parametr pro načítání atributů určité sestavy
Výstupní formát: XML dokument typu isknResponse – vyplněná větev reportList Funkce: vrací seznam sestav zabalený do obálky isknResponse. Součástí odpovědi je informace o typu sestavy (PDF/XML), cena, stav sestavy a informace o tom, zda je sestava opatřena el. značkou. Pokud je zadané číslo sestavy, potom seznam obsahuje jen informace o sestavě s příslušným ID.
Odebrání sestavy Název funkce: vratSestavu Vstupní formát: RPC style Název parametru
Nepovinný
Popis
username
Ne
Přihlašovací jméno uživatele do Dálkového přístupu
password
Ne
Heslo uživatele
idSestava
Ne
ID sestavy, která má být odebírána
Výstupní formát: XML dokument, který je zabalený do isknResponse – vyplněná větev report. PDF/XML dokument je součástí odpovědi ve formě přílohy (odpověď bude mít formát MIME MultiPart/Related složená se dvou částí) a isknResponse obsahuje informace o příloze. Pokud sestava, která má obsahovat el. značku, není touto opatřena a uživatel, který požaduje odebrání sestavy, je typu ověřující, je vrácena chyba 314. Pokud uživatel není typu ověřující, je sestava vytvořena a uživatel je upozorněn chybou 316 Výstup nebylo možno opatřit elektronickou značkou. Funkce: zaplatí (pokud nebyl ještě zaúčtován) a vrací vygenerovanou sestavu zabalenou do obálky isknResponse. Součástí odpovědi je informace o typu sestavy (PDF/XML), cena, stav sestavy a informace o tom, zda je sestava opatřena el. značkou.
Smazání sestavy Název funkce: smazSestavu Vstupní formát: RPC style Název parametru
Nepovinný
Popis
username
Ne
Přihlašovací jméno uživatele do Dálkového přístupu
password
Ne
Heslo uživatele
idSestava
Ne
ID sestavy, která má být smazána
Výstupní formát: XML dokument typu isknResponse – vyplněná větev error Funkce: označí sestavu s daným ID jako smazanou. Sestava již nebude uživateli přístupná. Při úspěšném provedení akce bude odpověď ve větvi error obsahovat kód 0 – Požadovaná akce byla úspěšně provedena.
List vlastnictví 4 formy spuštění: 1. přes ID LV 2. přes kód k.ú. a číslo LV 3. přes kód k.ú. a ID OS 4. přes seznam objektů
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 11/73
Popis webových služeb pro uživatele
Přes ID LV Název funkce: generujLV Vstupní formát: RPC style Název parametru
Nepovinný
Popis
username
Ne
Přihlašovací jméno uživatele do Dálkového přístupu
password
Ne
Heslo uživatele
idLV
ne
ID LV, které se má vygenerovat
format
ano
Formát výstupu – PDF nebo XML. Je předvolené PDF.
automatickeZaplaceni
ano
Příznak, zda se má sestava automaticky zaplatit. Viz odstavec Vracení sestav
maximalniCena
ano
Maximální cena, která může být automaticky zaplacena. Pokud nebude definován, potom bude zaplacení bez omezení.
cisloJednaci
ano
Číslo jednací. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů je parametr ignorován.
ucelKod
ano
Kód účelu. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů je parametr ignorován.
poradoveCislo
ano
Pořadové číslo pro ověřující osoby. Parametr je povinný pro ověřující osoby. U uživatelů ostatních typů je parametr ignorován.
overovaciDolozka
ano
Parametr u ověřující osoby určuje, zda bude k sestavě připojena ověřovací doložka. Pokud ověřující uživatel parametr nezadá, bude použita výchozí hodnota „n“. U uživatelů ostatních typů je parametr ignorován.
Výstupní formát: Viz odstavec Vracení sestav XSD: https://katastr.cuzk.cz/static/xml/VypisZKatastruNemovitosti.xsd Funkce: Zařazuje sestavu do fronty a vrácení výstupu (synchronně nebo asynchronně). Přes kód k.ú. a číslo LV Název funkce: generujLVZjednodusene Vstupní formát: RPC style Název parametru
Nepovinný
Popis
username
ne
Přihlašovací jméno uživatele do Dálkového přístupu
password
ne
Heslo uživatele
katastrUzemiKod
ne
Kód k.ú. (šestimístný)
cisloLV
ne
Číslo listu vlastnictví
format
ano
viz popis u funkce generujLV
automatickeZaplaceni
ano
viz popis u funkce generujLV
maximalniCena
ano
viz popis u funkce generujLV
cisloJednaci
ano
Číslo jednací. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů je parametr ignorován.
ucelKod
ano
Kód účelu. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů je parametr ignorován.
poradoveCislo
ano
Pořadové číslo pro ověřující osoby. Parametr je povinný pro ověřující osoby. U uživatelů ostatních typů je parametr
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 12/73
Popis webových služeb pro uživatele
Název parametru
Nepovinný
Popis ignorován.
overovaciDolozka
ano
Parametr u ověřující osoby určuje, zda bude k sestavě připojena ověřovací doložka. Pokud ověřující uživatel parametr nezadá, bude použita výchozí hodnota „n“. U uživatelů ostatních typů je parametr ignorován.
Výstupní formát: Viz odstavec Vracení sestav Přes kód k.ú. a ID OS Název funkce: generujLVPresOS Vstupní formát: RPC style Název parametru
Nepovinný
Popis
username
ne
Přihlašovací jméno uživatele do Dálkového přístupu
password
ne
Heslo uživatele
katastrUzemiKod
ne
Kód k.ú. (šestimístný)
idOS
ne
ID oprávněného subjektu (nebo master tohoto OS)
format
ano
viz popis u funkce generujLV
automatickeZaplaceni
ano
viz popis u funkce generujLV
maximalniCena
ano
viz popis u funkce generujLV
cisloJednaci
ano
Číslo jednací. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů je parametr ignorován.
ucelKod
ano
Kód účelu. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů je parametr ignorován.
poradoveCislo
ano
Pořadové číslo pro ověřující osoby. Parametr je povinný pro ověřující osoby. U uživatelů ostatních typů je parametr ignorován.
overovaciDolozka
ano
Parametr u ověřující osoby určuje, zda bude k sestavě připojena ověřovací doložka. Pokud ověřující uživatel parametr nezadá, bude použita výchozí hodnota „n“. U uživatelů ostatních typů je parametr ignorován.
Výstupní formát: Viz odstavec Vracení sestav Přes objekty Název funkce: generujLVPresObjekty Vstupní formát: RPC style Název parametru
Nepovinný
Popis
username
ne
Přihlašovací jméno uživatele do Dálkového přístupu
password
ne
Heslo uživatele
typSeznamuObjektu
ne
Určení typu seznamu objektů (PAR_S, STA_S, JED_S)
seznamObjektu
ne
Seznam ID objektů jednoho typu (všechny objekty musí být ze stejného LV)
castecnyVypis
ano
Příznak, zda má být vytvářen částečný výpis. Výchozí hodnota „n“.
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 13/73
Popis webových služeb pro uživatele
Název parametru
Nepovinný
Popis
format
ano
viz popis u funkce generujLV
automatickeZaplaceni
ano
viz popis u funkce generujLV
maximalniCena
ano
viz popis u funkce generujLV
cisloJednaci
ano
Číslo jednací. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů je parametr ignorován.
ucelKod
ano
Kód účelu. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů je parametr ignorován.
poradoveCislo
ano
Pořadové číslo pro ověřující osoby. Parametr je povinný pro ověřující osoby. U uživatelů ostatních typů je parametr ignorován.
overovaciDolozka
ano
Parametr u ověřující osoby určuje, zda bude k sestavě připojena ověřovací doložka. Pokud ověřující uživatel parametr nezadá, bude použita výchozí hodnota „n“. U uživatelů ostatních typů je parametr ignorován.
Výstupní formát: Viz odstavec „Vracení sestav“. Funkce: Vytvoří „Výpis z KN“ na základě seznamu objektů jednoho typu – parcel, staveb nebo jednotek. Při nastavení parametru „castecnyVypis“ na hodnotu „a“ výstup obsahuje částečný výpis (výpis omezený na vybrané objekty). Pokud nejsou zadány povinné parametry „typSeznamuObjektu“ a „seznamObjektu“, je vrácena chyba 115 – „Parametr % je povinný!“. Pokud není zadán parametr „castecnyVypis“, je použita jeho výchozí hodnota („n“). Pokud formát resp. hodnoty parametrů neodpovídají požadovanému formátu/hodnotám, je vrácena chyba 116 - „Neplatný formát parametru %!“ resp. 117 - „Neplatná hodnota parametru %!“. Pokud parametr „seznamObjektu“ obsahuje prvky z více různých LV, je vrácena chyba 117.
Kopie katastrální mapy Název funkce: generujMapu Vstupní formát: RPC style Název parametru
Nepovinný
Popis
username
ne
Přihlašovací jméno uživatele do Dálkového přístupu
password
ne
Heslo uživatele
souradniceX
ano
X souřadnice středu snímku (jen pokud není parcId)
souradniceY
ano
Y souřadnice středu snímku (jen pokud není parcId)
parcId
ano
ID parcely, pro jejíž souřadnice definičního bodu vygenerovat mapa. Alternativa k zadání souřadnic.
formatPapiru
ano
Velikost formátu papíru, výchozí hodnota „A4“
orientaceNaSirku
ano
Příznak orientace papíru na šířku. Výchozí hodnota „n“.
meritkoMapy
ano
Výchozí hodnota „1000“.
vecnaBremena
ano
Příznak, zda na snímku mají být věcná břemena. Výchozí hodnota „n“.
format
ano
Formát výstupu. Předvolené a jedině povolené bude PDF.
automatickeZaplaceni
ano
viz popis u funkce generujLV
maximalniCena
ano
viz popis u funkce generujLV
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
se
má
Strana 14/73
Popis webových služeb pro uživatele
Název parametru
Nepovinný
Popis
cisloJednaci
ano
Číslo jednací. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů bude parametr ignorován.
ucelKod
ano
Kód účelu. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů bude parametr ignorován.
poradoveCislo
ano
Pořadové číslo pro ověřující osoby. Parametr je povinný pro ověřující osoby. U uživatelů ostatních typů bude parametr ignorován.
overovaciDolozka
ano
Parametr u ověřující osoby určuje, zda bude k sestavě připojena ověřovací doložka. Pokud ověřující uživatel parametr nezadá, bude použita výchozí hodnota „n“. U uživatelů ostatních typů bude parametr ignorován.
Výstupní formát: Viz odstavec „Vracení sestav“. Funkce generujMapu vytvoří PDF výstup „Kopie katastrální mapy“. Funkce během běhu může vyhlásit následující chyby: Pokud nejsou zadány povinné parametry, je vrácena chyba: 115 – „Parametr % je povinný!“. Zadání parametrů (souradniceX, souradniceY) a parcId je vzájemně výlučné. Současné uvedení souřadnic i parcId je vyhlašováno jako chyba: 321– „Použity navzájem výlučné parametry!“. Pokud není nalezena parcela podle zadaného parcId, je vrácena chyba: 304 – „Neexistuje záznam s daným identifikátorem!“. Pokud k parcele podle zadaného parcId nejsou nalezeny souřadnice definičního bodu, je vrácena chyba: 322– „Nenalezen definiční bod parcely!“. Pokud není ve zvoleném výřezu detekován žádný prvek typu „hranice parcely“, je vrácena chyba: 323– „Zvolený výřez neobsahuje žádnou hranici parcely“ Pokud není nalezena pro funkci platná cena v ceníku služeb, je vrácena standardní chyba 304 Neexistuje záznam s daným identifikátorem! Pokud není zadán kterýkoli nepovinný parametr, je použita jeho výchozí hodnota podle tabulky výše.
Informace o parcelách (funkce není pro uživatele ověřovacích účtů dostupná) Název funkce: generujInfoOParcelach Vstupní formát: RPC style Název parametru
Nepovinný
Popis
username
ne
Přihlašovací jméno uživatele do Dálkového přístupu
password
ne
Heslo uživatele
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 15/73
Popis webových služeb pro uživatele
Název parametru
Nepovinný
Popis
parcId
právě jeden způsob identifikace musí být zadán
ID parcely, pro kterou se má vygenerovat sestava Informace o parcelách. Pokud není parametr zadán, musí být zadány parametry katastrUzemiKod a Cislo.
katastrUzemiKod kmenoveCislo
Kód katastrálního území, ve kterém se bude vyhledávat Číslo parcely
poddeleni format
ano
viz popis u funkce generujLV
automatickeZaplaceni
ano
viz popis u funkce generujLV
maximalniCena
ano
viz popis u funkce generujLV
cisloJednaci
ano
Číslo jednací. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů je parametr ignorován.
ucelKod
ano
Kód účelu. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů je parametr ignorován.
poradoveCislo
ano
Pořadové číslo pro ověřující osoby. Parametr je povinný pro ověřující osoby. U uživatelů ostatních typů je parametr ignorován.
overovaciDolozka
ano
Parametr u ověřující osoby určuje, zda bude k sestavě připojena ověřovací doložka. Pokud ověřující uživatel parametr nezadá, bude použita výchozí hodnota „n“. U uživatelů ostatních typů je parametr ignorován.
Výstupní formát: Viz odstavec Vracení sestav XSD: https://katastr.cuzk.cz/static/xml/InformaceOParcelach.xsd Funkce: Vybere všechny parcely, které odpovídají zadání (obvykle jednu) do seznamu. V případě nevyplnění podlomení se vyhledává pouze parcela bez podlomení. V případě, že existuje více parcel se stejnou identifikací (liší se údajem stavební-pozemková, PKN-PK nebo obsahuje díly) budou zařazeny všechny.
Informace o stavbách (funkce není pro uživatele ověřovacích účtů dostupná) Název funkce: generujInfoOStavbach Vstupný formát: RPC style Název parametru
Nepovinný
Popis
username
ne
Přihlašovací jméno uživatele do Dálkového přístupu
password
ne
Heslo uživatele
staId
právě jeden způsob identifikace musí být zadán
ID stavby, pro kterou se má vygenerovat sestava Informace o stavbách. Pokud není parametr zadán, musí být zadány parametry castObceKod, typStavbyKod, cpCe
castObceKod typStavbyKod cpCe
Kód části obce, v které se bude vyhledávat Kód typu stavby (povolené hodnoty 1, 2 nebo 4) Číslo popisné resp. evidenční stavby
format
ano
viz popis u funkce generujLV
automatickeZaplaceni
ano
viz popis u funkce generujLV
maximalniCena
ano
viz popis u funkce generujLV
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 16/73
Popis webových služeb pro uživatele
Název parametru
Nepovinný
Popis
cisloJednaci
ano
Číslo jednací. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů je parametr ignorován.
ucelKod
ano
Kód účelu. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů je parametr ignorován.
poradoveCislo
ano
Pořadové číslo pro ověřující osoby. Parametr je povinný pro ověřující osoby. U uživatelů ostatních typů je parametr ignorován.
overovaciDolozka
ano
Parametr u ověřující osoby určuje, zda bude k sestavě připojena ověřovací doložka. Pokud ověřující uživatel parametr nezadá, bude použita výchozí hodnota „n“. U uživatelů ostatních typů je parametr ignorován.
Výstupní formát: Viz odstavec Vracení sestav XSD: https://katastr.cuzk.cz/static/xml/InformaceOStavbach.xsd Funkce: Vybere všechny stavby, které odpovídají zadání (obvykle jednu). V případě, že budou existovat dvě stavby, které se budou lišit typem čísla (č.p. – č.e.) nebo v případě duplicit v č.p./č.e. budou zařazeny obě.
Informace o jednotkách (funkce není pro uživatele ověřovacích účtů dostupná) Název funkce: generujInfoOJednotkach Vstupní formát: RPC style Název parametru
Nepovinný
Popis
username
ne
Přihlašovací jméno uživatele do Dálkového přístupu
password
ne
Heslo uživatele
jednId
právě jeden způsob identifikace musí být zadán
ID jednotky, pro kterou se má vygenerovat sestava Informace o jednotkách. Pokud není parametr zadán, musí být zadány parametry castObceKod, typStavbyKod a cpCe.
castObceKod
Kód části obce, ve které se bude vyhledávat
typStavbyKod
Kód typu stavby (povolené hodnoty 1, 2 nebo 4)
cpCe
Číslo popisné resp. evidenční stavby
cisloJednotky
Číslo jednotky. Pokud není zadán, potom je výstupem seznam všech jednotek v budově.
format
ano
viz popis u funkce generujLV
automatickeZaplaceni
ano
viz popis u funkce generujLV
maximalniCena
ano
viz popis u funkce generujLV
cisloJednaci
ano
Číslo jednací. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů je parametr ignorován.
ucelKod
ano
Kód účelu. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů je parametr ignorován.
poradoveCislo
ano
Pořadové číslo pro ověřující osoby. Parametr je povinný pro ověřující osoby. U uživatelů ostatních typů je parametr ignorován.
overovaciDolozka
ano
Parametr u ověřující osoby určuje, zda bude k sestavě připojena ověřovací doložka. Pokud ověřující uživatel parametr nezadá,
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 17/73
Popis webových služeb pro uživatele
Název parametru
Nepovinný
Popis bude použita výchozí hodnota „n“. U uživatelů ostatních typů je parametr ignorován.
Výstupní formát: Viz odstavec Vracení sestav XSD: https://katastr.cuzk.cz/static/xml/InformaceOJednotkach.xsd Funkce: Vybere všechny jednotky odpovídající zadání a spustí pro ně sestavu.
Informace o řízení (funkce není pro uživatele ověřovacích účtů dostupná) Název funkce: generujInfoORizeni Vstupní formát: RPC style Název parametru
Nepovinný
Popis
username
ne
Přihlašovací jméno uživatele do Dálkového přístupu
password
ne
Heslo uživatele
rizId
právě jeden způsob identifikace musí být zadán
ID řízení, pro které se má vygenerovat sestava. Pokud není parametr zadán, musí být zadán parametr cisloRizeni
format
ano
viz popis u funkce generujLV
automatickeZaplaceni
ano
viz popis u funkce generujLV
maximalniCena
ano
viz popis u funkce generujLV
cisloJednaci
ano
Číslo jednací. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů bude parametr ignorován.
ucelKod
ano
Kód účelu. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů bude parametr ignorován.
poradoveCislo
ano
Pořadové číslo pro ověřující osoby. Parametr je povinný pro ověřující osoby. U uživatelů ostatních typů bude parametr ignorován.
overovaciDolozka
ano
Parametr u ověřující osoby určuje, zda bude k sestavě připojena ověřovací doložka. Pokud ověřující uživatel parametr nezadá, bude použita výchozí hodnota „a“. U uživatelů ostatních typů bude parametr ignorován.
cisloRizeni
Číslo řízení ve tvaru XXX-cccccccc/RRRR-ccc.
Funkce: Spustí sestavu Informace o řízení. XSD: https://katastr.cuzk.cz/static/xml/InformaceORizeni.xsd Pro vytvoření sestavy je potřeba zadat ID řízení (je možné získat ze sestavy ve formátu XML) nebo úplné číslo řízení ve tvaru „XXX-cccccccc/RRRR-ccc“. Není poskytována funkce pro vyhledávání řízení. Hodnota parametru „cisloRizeni“ musí být zadána ve tvaru „XXX-cccccccc/RRRR-ccc“, kde platí:
XXX - typ řízení, znaková hodnota délky 1-3 znaky (case insensitive)
cccccccc - pořadové číslo, celočíselná hodnota délky 1-8 číslic (bez úvodních nul)
RRRR - rok
ccc – kód pracoviště, právě 3 číslice (včetně úvodních nul, např. 020). Pokud neexistuje řízení s daným ID nebo číslem řízení je vrácena chyba 304 „Neexistuje záznam s daným identifikátorem!“
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 18/73
Popis webových služeb pro uživatele
Informace o definičních bodech (funkce není pro uživatele ověřovacích účtů dostupná) Název funkce: generujInfoOBodech Vstupní formát: RPC style Název parametru
Nepovinný
Popis
username
ne
Přihlašovací jméno uživatele do Dálkového přístupu
password
ne
Heslo uživatele
katastrUzemiKod
Skupina 1
Kód katastrálního území, pro které se mají vyhledat def. body
parcId,
Skupina 2
ID parcely, pro kterou se má dohledat definiční bod
staId
Skupina 3
ID stavby, pro kterou se má dohledat definiční bod
souradniceX
Skupina 4 Ne, s výjimkou parametru „vzdalenost“
X souřadnice v metrech - znaková hodnota číselná s pevnou desetinnou čárkou délky 9,2 (7 číslic před desetinnou čárkou, 2 za desetinnou čárkou
souradniceY
Y souřadnice v metrech - znaková hodnot číselná s pevnou desetinnou čárkou délky 8,2. (6 číslic před desetinnou čárkou, 2 za desetinnou čárkou).
vzdalenost
Vzdálenost pro prohledávání okolí bodu dle zadaných souřadnic (v metrech, na dvě desetinná místa, oddělovač desetinné části čárka)
typBodu
Typ hledaného definičního bodu; může nabývat hodnot ‘p’ (parcela) nebo ‘s’ (stavba)
Format
ano
Formát výstupu – pouze XML.
automatickeZaplaceni
ano
viz popis u funkce generujLV
maximalniCena
ano
viz popis u funkce generujLV
cisloJednaci
ano
Číslo jednací. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů bude parametr ignorován.
ucelKod
ano
Kód účelu. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů bude parametr ignorován.
poradoveCislo
ano
Pořadové číslo pro ověřující osoby. Parametr je povinný pro ověřující osoby. U uživatelů ostatních typů bude parametr ignorován.
overovaciDolozka
ano
Parametr u ověřující osoby určuje, zda bude k sestavě připojena ověřovací doložka. Pokud ověřující uživatel parametr nezadá, bude použita výchozí hodnota „a“. U uživatelů ostatních typů bude parametr ignorován.
XSD: https://katastr.cuzk.cz/static/xml/SeznamDefinicnichBoduParcel.xsd Poznámka: U parametrů, kde je povinnost označena jako SkupinaX platí, že musí být povinně zadány parametry právě jedné ze skupin. Parametry omezují výběr objektů takto: Musí být zadána právě jedna ze skupin identifikačních parametrů. Při použití parID a staID se předpokládá, že uživatel má k dispozici ID objektu nebo že ho předem zjistil s využitím funkce najdiParcelu, najdiStavbu. Pokud je zadáno katastrální území, je vrácen úplný seznam def. bodů parcel a staveb. Pokud jsou zadány souřadnice a typ bodu a:
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 19/73
Popis webových služeb pro uživatele
není zadána vzdálenost, je vrácen nejbližší definiční bod dle zadaného typu (bez omezení na jeho vzdálenost).
je zadána vzdálenost a: o pokud je v zadané vzdálenosti od zadaných souřadnic zjištěn výskyt právě jednoho bodu zadaného typu, je nalezený bod vrácen o pokud je v zadané vzdálenosti od zadaných souřadnic zjištěn výskyt více než jednoho definičního bodu zadaného typu, je vrácena chyba 329 o pokud není v zadané vzdálenosti od zadaných souřadnic zjištěn výskyt ani jednoho definičního bodu zadaného typu, je vrácena chyba 328
Funkce aktivně detekuje následující chyby: 304 Neexistuje záznam s daným identifikátorem! 326 Seznam objektů nesmí být prázdný! 327 Pro vybrané objekty nebyl nalezen ani jeden definiční bod! 328 Pro zadanou podmínku nebyl nalezen žádný definiční bod! 329 Pro zadanou podmínku bylo nalezeno více definičních bodů, zpřesněte výběr!
Přehled vlastnictví (funkce není pro uživatele ověřovacích účtů dostupná) Název funkce: generujPrehledVlastnictvi Vstupní formát: RPC style Název parametru
Nepovinný
Popis
username
ne
Přihlašovací jméno uživatele do Dálkového přístupu
password
ne
Heslo uživatele
krajKod
ano
Kód kraje, pro který se vlastnictví bude vypisovat
obecKod
ano
Kód obce, pro kterou se vlastnictví bude vypisovat
idOS
ne
ID OS, pro který se má vygenerovat sestava Přehled vlastnictví
typPravnihoVztahuKod
ano
Typ právního vztahu, podle kterého se bude vyhledávat (musí odpovídat položce číselníku, která má atribut Vlastnictví = "a")
format
ano
viz popis u funkce generujLV
automatickeZaplaceni
ano
viz popis u funkce generujLV
maximalniCena
ano
viz popis u funkce generujLV
cisloJednaci
ano
Číslo jednací. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů je parametr ignorován.
ucelKod
ano
Kód účelu. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů je parametr ignorován.
poradoveCislo
ano
Pořadové číslo pro ověřující osoby. Parametr je povinný pro ověřující osoby. U uživatelů ostatních typů je parametr ignorován.
overovaciDolozka
ano
Parametr u ověřující osoby určuje, zda bude k sestavě připojena ověřovací doložka. Pokud ověřující uživatel parametr nezadá, bude použita výchozí hodnota „n“. U uživatelů ostatních typů je parametr ignorován.
Výstupní formát: Viz odstavec Vracení sestav XSD: https://katastr.cuzk.cz/static/xml/PrehledVlastnictvi.xsd
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 20/73
Popis webových služeb pro uživatele
Funkce: Spustí sestavu pro zadaný OS. Vyhledávání bude provedeno v rozsahu podle případně zadaných parametrů krajKod a obecKod nebo, pokud nebudou zadány, přes celou ČR. Pokud bude funkce vyvolána s hodnotou typPravnihoVztahu, které neodpovídá záznam s hodnotou atributu Vlastnictví = "a", funkce vrátí chybu 117.
Evidence práv pro osobu Název funkce: generujEvidenciPravProOsobu Vstupní formát: RPC style Název parametru
Nepovinný
Popis
username
ne
Přihlašovací jméno uživatele do RDP
password
ne
Heslo uživatele
typOS
ne
Typ oprávněného subjektu („OFO“,“OPO“)
nazevOS
ne
Příjmenía Jméno / Název OS, pro který se má vygenerovat sestava Evidence práv pro osobu
rcIcoOS
ne
RČ / datum narození ve formátu RRMMDD / IČO OS (IČO včetně úvodních nul), pro který se má vygenerovat sestava Evidence práv pro osobu
format
ano
viz. popis u funkce generujLV
automatickeZaplaceni
ano
viz. popis u funkce generujLV
maximalniCena
ano
viz. popis u funkce generujLV
cisloJednaci
ano
Číslo jednací. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů je parametr ignorován.
ucelKod
ano
Kód účelu. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů je parametr ignorován.
poradoveCislo
ano
Pořadové číslo pro ověřující osoby. Parametr je povinný pro ověřující osoby. U uživatelů ostatních typů je parametr ignorován.
overovaciDolozka
ano
Parametr u ověřující osoby určuje, zda bude k sestavě připojena ověřovací doložka. Pokud ověřující uživatel parametr nezadá, bude použita výchozí hodnota „a“. U uživatelů ostatních typů je parametr ignorován.
Funkce: Spustí sestavu Evidence práv pro osobu pro zadaný OS. XSD: https://katastr.cuzk.cz/static/xml/EvidencePravProOsobu.xsd Funkce je přístupná i uživatelům typu Ověřující osoba. Ošetření stavu, kdy není možné opatřit výstup elektronickou značkou, je shodné s popisem v kapitole Odebrání sestavy. Zpoplatnění sestavy je stejné jako v aplikaci DP.
Výpis zákaznického účtu Název funkce: vypisUctu Vstupní formát: RPC style Název parametru
Nepovinný
Popis
username
ne
Přihlašovací jméno uživatele do Dálkového přístupu
password
ne
Heslo uživatele
datumOd
ne
Počáteční datum, od kterého má být výpis vytvořen
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 21/73
Popis webových služeb pro uživatele
Název parametru
Nepovinný
Popis
datumDo
ano
Koncové datum, do kterého má být výpis vytvořen. Implicitní hodnota je aktuální datum.
format
ano
„PDF“ nebo „XML“. Pokud uživatel parametr nezadá, bude použita výchozí hodnota "PDF".
Výstupní formát: Viz odstavec Vracení sestav XSD: https://katastr.cuzk.cz/static/xml/VypisStavuZakaznickehoUctu.xsd Funkce: Spustí sestavu.
3.8
Vyhledávaní
V této skupině služeb je funkce pro vyhledávání oprávněných subjektů, parcel, staveb a jednotek. Přístupový bod webové služby je https://katastr.cuzk.cz/isknws/vyhledavani
Vyhledávání OS Název funkce: najdiOS Vstupní formát: RPC style Název parametru
Nepovinný
Popis
username
ne
Přihlašovací jméno uživatele do Dálkového přístupu
password
ne
Heslo uživatele
ano
Parametr pro vyhledávání podle názvu resp. podle příjmení a jména
ico
ano
Parametr pro vyhledávání podle IČO firmy
rc
ano
Parametr pro vyhledávání podle RČ či části RČ subjektu
nazev
Výstupní formát: XML dokument typu isknResponse – vyplněná větev OSList Funkce: Umožní vyhledat OS na základě názvu (resp. jména a příjmení), IČO a RČ. Je dovoleno zadat kombinaci parametrů „nazev“ a „rc“, „nazev“ a „ico“. Pokud bude vyplněn parametr nazev, funkce bude nejdříve hledat přesnou shodu s příjmením a jménem a nalezené záznamy budou doplněny o hledání na částečnou shodu (začátek názvu) s názvem organizace. Funkce bude vracet pouze OS s nevyplněným zdrojem, tj. v případě OS, které mají master, bude funkce vracet pouze sjednocené OS. Jestliže je v dotazu na OS vyhledána fyzická osoba, která má partnera SJM, pak v odpovědi bude uveden blok pro tuto fyzickou osobu a dále pak blok SJM (v datech typ BSM), v němž se vypíší záznamy pro oba partnery. Postup vyhledávání je tedy shodný s interaktivním DP. Vyhledávání je provedeno přes celou republiku. Při nedostatečně selektivním zadání parametrů nazev, ico a rc nebo při současném vyplnění parametrů „rc“ a „ico“, funkce vrátí chybu (viz seznam chyb).
Vyhledávaní parcely Název funkce: najdiParcelu Vstupní formát: RPC style Název parametru
Nepovinný
Popis
username
ne
Přihlašovací jméno uživatele do Dálkového přístupu
password
ne
Heslo uživatele
katastrUzemiKod
ne
Kód katastrálního území, ve kterém se bude vyhledávat
kmenoveCislo
ne
poddeleni
ano
Číslo parcely
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 22/73
Popis webových služeb pro uživatele
Výstupní formát: XML dokument typu isknResponse – vyplněná větev PARCList Funkce: Umožní vyhledat parcelu na základě k.ú. a jejího čísla. Vrátí seznam všech parcel, které odpovídají zadání. V případě nevyplnění podlomení se vyhledává pouze parcela bez podlomení.
Vyhledávaní stavby Název funkce: najdiStavbu Vstupní formát: RPC style Název parametru
Nepovinný
Popis
username
ne
Přihlašovací jméno uživatele do Dálkového přístupu
password
ne
Heslo uživatele
castObceKod
ne
Kód části obce, v které se bude vyhledávat
typStavbyKod
ne
Kód typu stavby (povolené hodnoty 1, 2 nebo 4)
cpCe
ne
Číslo popisné resp. evidenční budovy
Výstupní formát: XML dokument typu isknResponse – vyplněná větev STAList Funkce: Umožní vyhledat stavbu na základě části obce a čísla popisného nebo evidenčního.
Vyhledávaní jednotky Název funkce: najdiJednotku Vstupní formát: RPC style Název parametru
Nepovinný
Popis
username
ne
Přihlašovací jméno uživatele do Dálkového přístupu
password
ne
Heslo uživatele
staId
právě jeden způsob identifikace musí být zadán
ID stavby, ve které se mají jednotky vyhledávat. Pokud není parametr zadán, musí být zadány parametry castObceKod, typStavbyKod, cpCe
castObceKod
Kód části obce, v které se bude vyhledávat
typStavbyKod
Kód typu stavby (povolené hodnoty 1, 2 nebo 4)
cpCe
Číslo popisné resp. evidenční budovy
cisloJednotky
ano
Číslo jednotky.
Výstupní formát: XML dokument typu isknResponse – vyplněná větev JEDNList Funkce: Umožní vyhledat jednotku na základě identifikace stavby a čísla jednotky. Vrátí seznam všech jednotek, které odpovídají zadání. Pokud číslo jednotky není zadáno, potom je výstupem seznam všech jednotek v dané budově (nebo budovách).
Získání MBR Název funkce: dejMBRParcel Vstupní formát: RPC style Název parametru
Nepovinný
Popis
username
ne
Přihlašovací jméno uživatele do Dálkového přístupu
password
ne
Heslo uživatele
seznamParcel
ne
Seznam ID parcel
Výstupní formát: XML dokument typu isknResponse – vyplněná větev infoList/MBR
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 23/73
Popis webových služeb pro uživatele
Funkce: Vrací minimální omezující obdélník pro jednotlivé parcely ze zadaného výběru parcel. Seznam parcel je vstupním parametrem a obsahuje výčet ID parcel. MBR je určen pro každou parcelu zvlášť a to jako obdélník opsaný hranicím parcely. Pro každou parcelu na vstupu je v XML odpovědi vytvořen samostatný XML element s názvem „MBR“, který kromě identifikátoru parcely obsahuje i její MBR (je-li jej možné určit). Pokud některé z parcel ze vstupního seznamu parcel nebudou existovat v přítomnosti ISKN, bude vyhlášena chyba s tím, že seznam identifikátorů těchto parcel bude uložen v XML elementu <error>. Pro vrácení údajů o MBR jednotlivých parcel jsou v rámci isknResponse použity XML elementy z namespace GML (tzn. Geography Markup Language) definovaného Open Geospatial Consortium (http://www.opengeospatial.org/). Ukázka:
<MBRList> <MBR> 1356963210 <Envelope> 757443 1065814 757460 1065834
Pokud nebudou nenalezeny pro některou ze zadaného seznamu parcel hranice parcely (tj. bez ohledu na existenci jejich definičních bodů), odpověď pro takovou parcelu bude obsahovat uvnitř „MBR“ elementu pod „boundedBy“ XML element „Null“ s prázdným obsahem: Ukázka „prázdného“ XML elementu „boundedBy“:
Hodnoty souřadnic protilehlých rohů MBR jsou vraceny v metrech jako (Y, X) v prvním kvadrantu a zaokrouhleně na metry – tj. bez desetinných míst (a bez desetinné čárky). Zaokrouhlení MBR je provedeno na celá čísla (= metry) tak, aby minimální souřadnice byly zaokrouhleny na celé číslo směrem dolů a maximální souřadnice na celé číslo směrem nahoru. Cílem je následně s těmito parametry volat generování sestavy kopie katastrální mapy, kde se vstupní hodnoty zadávají v metrech.
3.9
Správa účtu
V této skupině služeb je funkce pro správu účtu – změna hesla. Přístupový bod webové služby je https://katastr.cuzk.cz/isknws/ucet
Změna hesla uživatele Název funkce: zmenHeslo Vstupní formát a parametry: RPC style Název parametru
Nepovinný
Popis
username
ne
Přihlašovací jméno uživatele do Dálkového přístupu
password
ne
Heslo uživatele
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 24/73
Popis webových služeb pro uživatele
Název parametru
Nepovinný
Popis
noveHeslo
ne
Nové heslo daného uživatele
Výstupní formát: XML dokument typu isknResponse – vyplněná větev error Funkce: Umožní změnit heslo daného uživatele.
3.10 Příklady volání webových služeb (WS) Na vstupu jsou uvedeny použité vstupní parametry pro volání WS, parametry username a password jsou povinné pro všechny WS a v následujících diagramech jsou vynechány. Tučně zvýrazněné parametry byly získány z odpovědi některého z předchozích volání WS. Parametr „time“ představuje skutečnou dobu vytváření sestavy, parametr „timeOut“ nastavení max. doby vytváření sestavy, kdy je ještě použit synchronní přístup. Vytvoření sestavy list vlastnictví na základě ID listu vlastnictví získaného pomocí některé ze služeb „Vyhledávání“. Ukázka komunikace klient – server pro tento způsob získání Výpisu z KN je v příloze.
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 25/73
Popis webových služeb pro uživatele
Vytvoření sestavy list vlastnictví na základě idOS a kódu katastrálního území.
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 26/73
Popis webových služeb pro uživatele
Vytvoření sestavy „list vlastnictví“ na „automatickeZaplaceni“ a „maximalniCena“
základě
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
ID
listu
vlastnictví
a
nastavení
parametrů
Strana 27/73
Popis webových služeb pro uživatele
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 28/73
Popis webových služeb pro uživatele
Vytvoření sestavy „Výpis zákaznického účtu“
Vytvoření sestavy „Informace o jednotkách“ pro stavbu bez č.p./č.e.
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 29/73
Popis webových služeb pro uživatele
Odpověď na vyhledávání s nedostatečnými parametry (nevyplněny povinné parametry):
<error> 106
C <description>Parametr katastrUzemiKod je povinný!
Odpověď na neúspěšné vyhledávání (např. chybná podmínka):
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 30/73
Popis webových služeb pro uživatele
3.11 Autorizace Autorizace uživatelů je vykonávaná při každém dotazu. Autorizace je provedena na základě vstupních parametrů username a password. Při autorizaci uživatelů platí totožná pravidla jako u aplikace Dálkový přístup („DP“) – včetně expirace hesla. V případě, že se bude blížit expirace, bude uživatel upozorňován vyplněním větve Chyba, která bude obsahovat varování. Ve výstupu bude současně obsažena požadovaná sestava nebo výsledek dotazu. Po expiraci hesla bude vráceno pouze chybové hlášení ve větvi Chyba.
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 31/73
Popis webových služeb pro uživatele
4 Webové služby 2 verze (WS2) 4.1
Přístupový bod
Jsou k dispozici od srpna 2013 a svoji funkčností plně nahrazují dosavadní webové služby (označované jako verze 1). Rozhraní webových služeb je definováno za použití standardů Web Service Definition Language a XML Schema Definition Language. XSD jsou sdíleny. WSDL i XSD jsou dostupné v rámci dokumentace v adresáři: https://katastr.cuzk.cz/dokumentace/ws2/wsdp/[název služby].[wsdl nebo xsd] (např. https://katastr.cuzk.cz/dokumentace/ws2/wsdp/sestavy.wsdl https://katastr.cuzk.cz/dokumentace/ws2/wsdp/sestavy.xsd pro práci se sestavami). Společné XSD jsou potom v adresáři https://katastr.cuzk.cz/dokumentace/xsd/, jsou to soubory commonTypes.xsd a baseTypes.xsd. Kromě nich WS2 využívají i gml.xsd. Jednotlivé WS jsou:
číselníky
(ciselnik.wsdl)
informace
(informace.wsdl)
sestavy
(sestavy.wsdl)
správa účtu
(ucet.wsdl)
vyhledávaní
(vyhledat.wsdl)
Každá webová služba je přístupná přes uvedený přístupný bod, který se skládá z několika částí: https://[doména]/[verzeWS]/[kontextAplikace]/[názevSlužby] https://katastr.cuzk.cz/ws2/wsdp/sestavy pro práci se sestavami).
4.2
(Např.
Obecný vstupní formát
Definice webových služeb jsou realizováný pomocí WSDL souborů. Příchozí požadavek se validuje vůči XSD, zkontrolováno je především vyplnění povinných elementů, správná délka a formát u jednotlivých elementů, při použití výčtových typů i to, zda hodnota náleží do výčtu. Kromě toho existují ještě aplikační omezení, které nelze v XSD definovat. Požadavky se na tyto omezení kontrolují až při samotném zpracování v rámci aplikace a případné chyby jsou vráceny jakou součást odpovědi.
4.3
Výstupní formát
Odpověď WS vracená v rámci SOAP Body je členěna na hlavičku, element „vysledek“, kde jsou uvedena všechna hlášení spjatá se zpracováním požadavku v podobě elementů “zprava“. Vždy je zde uvedena nejméně jedna zpráva, buďto informace o úspěšně provedené operace nebo chybové hlášení z důvodu chyby při zpracování. Zprávy obsahují následující informace: - kód (atribut „kod“) – kód zprávy definovaný číselníkem chyb - úroveň (atribut „uroven“) – definuje závažnost zprávy (INFORMACE, VAROVANI, CHYBA) - text zprávy – textový popis zprávy - identifikátor chyby – v případě zpráv úrovně „CHYBA“ je součástí textu zprávy jednoznačný identifikátor chyby. Tento identifikátor může být vyžadován ze strany uživatelské podpory aplikace. Dále následuje samotné tělo zprávy s požadovanými údaji.
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 32/73
Popis webových služeb pro uživatele
4.4
Formát datumových parametrů
Vstupní parametry služeb sloužící pro předávání datumových hodnot jsou ve formátu vycházejícím ze standardu XML Schema Datatypes „yyyy-mm-ddThh24:mi:ss“. Výstupní parametry obsahující datum a čas používají tentýž formát. Výstupní parametry obsahující pouze datum jsou ve formátu „yyyy-mm-dd“. Podrobně jsou tyto formáty popsané v xsd nebo HTML dokumentaci.
4.5
Kontrola formátů parametrů
Kontrola formátu položek je dvojí, ta první je na úrovni parsování XML podle platného XSD. V případě chyby se vrátí zpět následné XML: <SOAP-ENV:Envelope xmlns:SOAP-ENV ="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <SOAP-ENV:Fault>
SOAP-ENV:Client cvc-enumeration-valid: [Podrobný popis chyby]
Druhá je kontrola podle aplikační logiky, kde se v případě chyby chybové hlášení vrací jako součást zprávy – tag „vysledek“.
4.6
Parametry specifické pro jednotlivé typy uživatelů
Dále v textu dokumentu se ověřující osobou rozumí uživatel, který k WS přistupuje pod účtem typu „Ověřující“. Parametry ucelKod, cisloJednaci, poradoveCislo a overovaciDolozka jsou použity u služeb vytvářejících výstupy z katastru nemovitostí ve formátu PDF/XML. S výjimkou výstupů, které zadání těchto parametrů nevyžadují (vypisUctu), tak jako je tomu v interaktivní aplikaci DP. Parametry ucelKod a cisloJednaci jsou povinné pro bezúplatné uživatele. V případě, že hodnoty parametrů jsou vyplněny u uživatele jiného typu, jsou tyto hodnoty ignorovány. Hodnoty parametru ucelKod jsou kontrolovány proti platným hodnotám číselníku účelů. Pokud kód v číselníku neexistuje, je vrácena chyba 117. Parametr poradoveCislo je povinný pro ověřující osoby. V případě, že hodnota parametru je vyplněna u uživatele jiného typu, je tato hodnota ignorována. Parametr overovaciDolozka je volitelný parametr pro ověřující osoby. V případě, že parametr u tohoto typu uživatele není zadán, použije se výchozí hodnota „n“. V případě, že je hodnota parametru vyplněna a služba je vyvolána uživatelem jiného typu, je tato hodnota ignorována. Parametry poradoveCislo a overovaciDolozka jsou použity u všech služeb generujících sestavy (s výjimkou vypisUctu). Povolené hodnoty parametrů jsou kontrolovány vždy, tj. i v případě, kdy uživatel vyplní parametr, který je pro takový typ uživatele ignorován. Např. pokud platící uživatel vyplní parametr overovaciDolozka hodnotou „X“, bude vyhlášena chyba 116.
4.7
Číselníky
V této skupině služeb jsou funkce na vyhledávání hodnot v číselnících. Přístupový bod webové služby je https://katastr.cuzk.cz/ws2/wsdp/ciselnik. Celkově je tato služba rozdělena na následující skupiny operací a jednotlivé operace: skupina operací
operace základní číselníky
ciselniky
seznamCiselniku seznamStatu
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 33/73
Popis webových služeb pro uživatele
seznamKraju seznamOperaciRizeni seznamCislovaniParcel seznamZdrojuCislovaniZE seznamDruhuPozemku seznamVyuzitiStavby seznamVyuzitiJednotky seznamVyuzitiPozemku seznamUrceniVymery seznamZpusobOchrany seznamTypuPravnichVztahu seznamUcelu seznamTypuStaveb seznamDmlOperaci seznamTypuOperaci seznamPredmetuRizeni seznamTypParcely seznamTypuJednotek základní číselníky s číselným kódem: seznamTypuParcel seznamTypuOS seznamKategorii seznamTypuRizeni seznamKU seznamMestskychCasti seznamUlic základní číselníky s číselným kódem seznamOkresu seznamTypuOS seznamKategorii seznamTypuRizeni ostatní číselníky seznamOkresu seznamObci seznamCastiObci seznamPracovist seznamOperaciRizeni seznamZdrojuCislovaniZE seznamTypuPravnichVztahu
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 34/73
Popis webových služeb pro uživatele
seznamZprav seznamHistKU V podmínce „obsahuje“ (viz xsd) je možné využít zástupný znak ‚%‘. Například při hledání obcí a zadání „Velt%“ budou vráceny všechny obce obsahující shluk písmen „Velt“ (např.: Veltruby, Veltrusy, Veltěže).
4.8
Informace
V této skupině služeb jsou funkce pro získání informací. Přístupový bod webové služby je https://katastr.cuzk.cz/ws2/wsdp/informace.
Získání MBR Název funkce: dejMBRParcel Název parametru
Může být Popis nevyplněný
seznamParcel
ne
Seznam ID parcel
Výstupní formát: XML dokument typu DejMBRParcelResponse. Funkce: Vrací minimální omezující obdélník pro jednotlivé parcely ze zadaného výběru parcel. Seznam parcel je vstupním parametrem a obsahuje výčet ID parcel. MBR je určen pro každou parcelu zvlášť a to jako obdélník opsaný hranicím parcely. Pro každou parcelu na vstupu je v XML odpovědi vytvořen samostatný XML element s názvem „MBR“, který kromě identifikátoru parcely obsahuje i její MBR (je-li jej možné určit). Pokud některé z parcel ze vstupního seznamu parcel nebudou existovat v přítomnosti ISKN, bude vyhlášena chyba s tím, že seznam identifikátorů těchto parcel bude uložen v XML elementu
. Pro vrácení údajů o MBR jednotlivých parcel jsou v rámci isknResponse použity XML elementy z namespace GML (tzn. Geography Markup Language) definovaného Open Geospatial Consortium (http://www.opengeospatial.org/). Ukázka: <MBRList> <MBR> 5569112301 <ns1:boundedBy> <ns1:Envelope> <ns1:lowerCorner>749749 1164022 <ns1:upperCorner>749775 1164055
Pokud nebudou nenalezeny pro některou ze zadaného seznamu parcel hranice parcely (tj. bez ohledu na existenci jejich definičních bodů), odpověď pro takovou parcelu bude obsahovat uvnitř „MBR“ elementu pod „boundedBy“ XML element „Null“ s prázdným obsahem: Ukázka „prázdného“ XML elementu „boundedBy“:
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 35/73
Popis webových služeb pro uživatele
Hodnoty souřadnic protilehlých rohů MBR jsou vraceny v metrech jako (Y, X) v systému S-JTSK a zaokrouhleně na metry – tj. bez desetinných míst (a bez desetinné čárky). Zaokrouhlení MBR je provedeno na celá čísla (= metry) tak, aby minimální souřadnice byly zaokrouhleny na celé číslo směrem dolů a maximální souřadnice na celé číslo směrem nahoru. Cílem je následně s těmito parametry volat generování sestavy kopie katastrální mapy, kde se vstupní hodnoty zadávají v metrech.
4.9
Sestavy
V této skupině služeb je funkce pro práci se sestavami – zařazení, odebrání, atd. Přístupový bod webové služby je https://katastr.cuzk.cz/ws2/wsdp/sestavy Pomocí webových služeb není možné vytvářet sestavy k historii, služby nemají vstupní parametr pro zadání datumu.
Seznam sestav Název funkce: seznamSestav Název parametru
Nepovinný
Popis
idSestava
ano
Parametr pro načítání atributů určité sestavy
Funkce: vrací seznam sestav. Součástí odpovědi je informace o typu sestavy (PDF/XML), cena, stav sestavy a informace o tom, zda je sestava opatřena el. značkou. Pokud je zadané číslo sestavy, potom seznam obsahuje jen informace o sestavě s příslušným ID.
Odebrání sestavy Název funkce: vratSestavu Název parametru
Nepovinný
Popis
idSestava
ne
ID sestavy, která má být odebírána
Výstupní formát: XML dokument, který obsahuje informace o příloze - sestavě. PDF/XML dokument je součástí odpovědi ve formě přílohy přenášené pomocí MTOM. Pokud sestava, která má obsahovat el. značku, není touto opatřena a uživatel, který požaduje odebrání sestavy, je typu ověřující, je vrácena chyba 314. Pokud uživatel není typu ověřující, je sestava vytvořena a uživatel je upozorněn chybou 316 Výstup nebylo možno opatřit elektronickou značkou. Funkce: zaplatí (pokud nebyl ještě zaúčtován) a vrací vygenerovanou sestavu zabalenou do obálky isknResponse. Součástí odpovědi je informace o typu sestavy (PDF/XML), cena, stav sestavy a informace o tom, zda je sestava opatřena el. značkou.
Smazání sestavy Název funkce: smazSestavu Název parametru
Nepovinný
Popis
idSestava
ne
ID sestavy, která má být smazána
Výstupní formát: XML dokument. Funkce: označí sestavu s daným ID jako smazanou. Sestava již nebude uživateli přístupná. Při úspěšném provedení akce bude odpověď ve větvi error obsahovat kód 0 – Požadovaná akce byla úspěšně provedena.
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 36/73
Popis webových služeb pro uživatele
Společná část požadavků na sestavu Všechny požadavky na zpracování sestavy mají společnou část zprávy, kterou tvoří následující elementy, které tvoří dvě dvojice parametru typu choice, takže může být vyplněno cisloJednaci a ucelKod, nebo naopak poradoveCislo a overovaciDolozka. Název parametru
Nepovinný
Popis
Format
ano
Formát výstupu – PDF nebo XML. Je předvolené PDF.
cisloJednaci
ano
Číslo jednací. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů je parametr ignorován.
ucelKod
ano
Kód účelu. Parametr je povinný pro bezúplatné uživatele. U uživatelů ostatních typů je parametr ignorován.
poradoveCislo
ano
Pořadové číslo pro ověřující osoby. Parametr je povinný pro ověřující osoby. U uživatelů ostatních typů je parametr ignorován.
overovaciDolozka
ano
Parametr u ověřující osoby určuje, zda bude k sestavě připojena ověřovací doložka. Pokud ověřující uživatel parametr nezadá, bude použita výchozí hodnota „n“. U uživatelů ostatních typů je parametr ignorován.
List vlastnictví 4 formy spuštění: 5. přes ID LV 6. přes kód k.ú. a číslo LV 7. přes kód k.ú. a ID OS 8. přes seznam objektů Přes ID LV Název funkce: generujLV Název parametru
Nepovinný
Popis
idLV
ne
ID LV, které se má vygenerovat
Výstupní formát: Viz odstavec Vracení sestav XSD: https://katastr.cuzk.cz/dokumentace/xsd/sestavy/VypisZKatastruNemovitosti.xsd Funkce: Zařazuje sestavu do fronty a vrácení výstupu (synchronně nebo asynchronně). Přes kód k.ú. a číslo LV Název funkce: generujLVZjednodusene Název parametru
Nepovinný
Popis
katastrUzemiKod
ne
Kód k.ú. (šestimístný)
lvCislo
ne
Číslo listu vlastnictví
Výstupní formát: Viz odstavec Vracení sestav
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 37/73
Popis webových služeb pro uživatele
Přes kód k.ú. a ID OS Název funkce: generujLVPresOS Název parametru
Nepovinný
Popis
katastrUzemiKod
ne
Kód k.ú. (šestimístný)
osId
ne
ID oprávněného subjektu (nebo master tohoto OS)
Výstupní formát: Viz odstavec Vracení sestav Přes objekty Název funkce: generujLVPresObjekty Název parametru
Nepovinný
Popis
typSeznamuObjektu
ne
Určení typu seznamu objektů (PAR_S, STA_S, JED_S, BUD_S)
seznamObjektu
ne
Seznam ID objektů jednoho typu (všechny objekty musí být ze stejného LV)
castecnyVypis
ano
Příznak, zda má být vytvářen částečný výpis. Výchozí hodnota „n“.
Výstupní formát: Viz odstavec „Vracení sestav“. Funkce: Vytvoří „Výpis z KN“ na základě seznamu objektů jednoho typu – parcel, staveb nebo jednotek. Při nastavení parametru „castecnyVypis“ na hodnotu „a“ výstup obsahuje částečný výpis (výpis omezený na vybrané objekty). Pokud nejsou zadány povinné parametry „typSeznamuObjektu“ a „seznamObjektu“, je vrácena chyba 115 – „Parametr % je povinný!“. Pokud není zadán parametr „castecnyVypis“, je použita jeho výchozí hodnota („n“). Pokud formát resp. hodnoty parametrů neodpovídají požadovanému formátu/hodnotám, je vrácena chyba 116 - „Neplatný formát parametru %!“ resp. 117 - „Neplatná hodnota parametru %!“. Pokud parametr „seznamObjektu“ obsahuje prvky z více různých LV, je vrácena chyba 117.
Kopie katastrální mapy Název funkce: generujMapu Název parametru
Nepovinný
Popis
parcelaId
ano
ID parcely, pro jejíž souřadnice definičního bodu vygenerovat mapa. Alternativa k zadání souřadnic.
souradniceX
ano
X souřadnice středu snímku (jen pokud není parcId)
souradniceY
ano
Y souřadnice středu snímku (jen pokud není parcId)
formatPapiru
ano
Velikost formátu papíru, výchozí hodnota „A4“
orientaceNaSirku
ano
Příznak orientace papíru na šířku. Výchozí hodnota „n“.
meritkoMapy
ano
Výchozí hodnota „1000“.
vecnaBremena
ano
Příznak, zda na snímku mají být věcná břemena. Výchozí hodnota „n“.
se
má
Výstupní formát: Viz odstavec „Vracení sestav“. Funkce generujMapu vytvoří PDF výstup „Kopie katastrální mapy“. Funkce během běhu může vyhlásit následující chyby:
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 38/73
Popis webových služeb pro uživatele
Pokud nejsou zadány povinné parametry, je vrácena chyba: 115 – „Parametr % je povinný!“. Zadání parametrů (souradniceX, souradniceY) a parcelaId je vzájemně výlučné. Současné uvedení souřadnic i parcId je vyhlašováno jako chyba: 321– „Použity navzájem výlučné parametry!“. Pokud není nalezena parcela podle zadaného parcId, je vrácena chyba: 304 – „Neexistuje záznam s daným identifikátorem!“. Pokud k parcele podle zadaného parcId nejsou nalezeny souřadnice definičního bodu, je vrácena chyba: 322– „Nenalezen definiční bod parcely!“. Pokud není ve zvoleném výřezu detekován žádný prvek typu „hranice parcely“, je vrácena chyba: 323– „Zvolený výřez neobsahuje žádnou hranici parcely“ Pokud není nalezena pro funkci platná cena v ceníku služeb, je vrácena standardní chyba 304 Neexistuje záznam s daným identifikátorem! Pokud není zadán kterýkoli nepovinný parametr, je použita jeho výchozí hodnota podle tabulky výše.
Informace o parcelách (funkce není pro uživatele ověřovacích účtů dostupná) Název funkce: generujInfoOParcelach Název parametru
Nepovinný
Popis
parcelaId
právě jeden způsob identifikace musí být zadán
ID parcely, pro kterou se má vygenerovat sestava Informace o parcelách. Pokud není parametr zadán, musí být zadány parametry katastrUzemiKod a Cislo.
katastrUzemiKod kmenoveCislo
Kód katastrálního území, ve kterém se bude vyhledávat Číslo parcely
poddeleni
Výstupní formát: Viz odstavec Vracení sestav XSD: https://katastr.cuzk.cz/dokumentace/xsd/sestavy/InformaceOParcelach.xsd Funkce: Vybere všechny parcely, které odpovídají zadání (obvykle jednu) do seznamu. V případě nevyplnění podlomení se vyhledává pouze parcela bez podlomení. V případě, že existuje více parcel se stejnou identifikací (liší se údajem stavební-pozemková, PKN-PK nebo obsahuje díly) budou zařazeny všechny.
Informace o stavbách (funkce není pro uživatele ověřovacích účtů dostupná) Název funkce: generujInfoOStavbach Název parametru
Nepovinný
Popis
stavbaId
právě jeden způsob identifikace musí být zadán
ID stavby, pro kterou se má vygenerovat sestava Informace o stavbách. Pokud není parametr zadán, musí být zadány parametry castObceKod, typStavbyKod, cpCe
castObceKod
Kód části obce, v které se bude vyhledávat
typStavbyKod
Kód typu stavby (povolené hodnoty 1, 2 nebo 4)
cisloDomovni
Číslo popisné resp. evidenční stavby
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 39/73
Popis webových služeb pro uživatele
Výstupní formát: Viz odstavec Vracení sestav XSD: https://katastr.cuzk.cz/dokumentace/xsd/sestavy/InformaceOStavbach.xsd Funkce: Vybere všechny stavby, které odpovídají zadání (obvykle jednu). V případě, že budou existovat dvě stavby, které se budou lišit typem čísla (č.p. – č.e.) nebo v případě duplicit v č.p./č.e. budou zařazeny obě.
Informace o jednotkách (funkce není pro uživatele ověřovacích účtů dostupná) Název funkce: generujInfoOJednotkach Název parametru
Nepovinný
Popis
jednotkaId
právě jeden způsob identifikace musí být zadán
ID jednotky, pro kterou se má vygenerovat sestava Informace o jednotkách. Pokud není parametr zadán, musí být zadány parametry castObceKod, typStavbyKod a cpCe.
castObceKod
Kód části obce, ve které se bude vyhledávat
typStavbyKod
Kód typu stavby (povolené hodnoty 1, 2 nebo 4)
cisloDomovni
Číslo popisné resp. evidenční stavby
cisloJednotky
Číslo jednotky. Pokud není zadán, potom je výstupem seznam všech jednotek v budově.
Výstupní formát: Viz odstavec Vracení sestav XSD: https://katastr.cuzk.cz/dokumentace/xsd/sestavy/InformaceOJednotkach.xsd Funkce: Vybere všechny jednotky odpovídající zadání a spustí pro ně sestavu.
Informace o řízení (funkce není pro uživatele ověřovacích účtů dostupná) Název funkce: generujInfoORizeni Název parametru
Nepovinný
Popis
rizeniId
právě jeden způsob identifikace musí být zadán
ID řízení, pro které se má vygenerovat sestava. Pokud není parametr zadán, musí být zadán parametr cisloRizeni
cisloRizeni
Číslo řízení ve tvaru XXX-cccccccc/RRRR-ccc.
Funkce: Spustí sestavu Informace o řízení. XSD: https://katastr.cuzk.cz/dokumentace/xsd/sestavy/InformaceORizeni.xsd Pro vytvoření sestavy je potřeba zadat ID řízení (je možné získat ze sestavy ve formátu XML) nebo úplné číslo řízení ve tvaru „XXX-cccccccc/RRRR-ccc“. Není poskytována funkce pro vyhledávání řízení. Hodnota parametru „cisloRizeni“ musí být zadána ve tvaru „XXX-cccccccc/RRRR-ccc“, kde platí:
XXX - typ řízení, znaková hodnota délky 1-3 znaky (case insensitive)
cccccccc - pořadové číslo, celočíselná hodnota délky 1-8 číslic (bez úvodních nul)
RRRR - rok
ccc – kód pracoviště, právě 3 číslice (včetně úvodních nul, např. 020). Pokud neexistuje řízení s daným ID nebo číslem řízení je vrácena chyba 304 „Neexistuje záznam s daným identifikátorem!“
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 40/73
Popis webových služeb pro uživatele
Informace o definičních bodech (funkce není pro uživatele ověřovacích účtů dostupná) Název funkce: generujInfoOBodech Název parametru
Nepovinný
Popis
katastrUzemiKod
Skupina 1
Kód katastrálního území, pro které se mají vyhledat def. body
parcelaId
Skupina 2
ID parcely, pro kterou se má dohledat definiční bod
stavbaId
Skupina 3
ID stavby, pro kterou se má dohledat definiční bod
souradniceX
Skupina 4 Ne, s výjimkou parametru „vzdalenost“
X souřadnice v metrech - znaková hodnota číselná s pevnou desetinnou čárkou délky 9,2 (7 číslic před desetinnou čárkou, 2 za desetinnou čárkou
souradniceY
Y souřadnice v metrech - znaková hodnot číselná s pevnou desetinnou čárkou délky 8,2. (6 číslic před desetinnou čárkou, 2 za desetinnou čárkou).
vzdalenost
Vzdálenost pro prohledávání okolí bodu dle zadaných souřadnic (v metrech, na dvě desetinná místa, oddělovač desetinné části čárka)
typBodu
Typ hledaného definičního bodu; může nabývat hodnot ‘p’ (parcela) nebo ‘s’ (stavba)
XSD: https://katastr.cuzk.cz/dokumentace/xsd/sestavy/SeznamDefinicnichBoduParcel.xsd Poznámka: U parametrů, kde je povinnost označena jako SkupinaX platí, že musí být povinně zadány parametry právě jedné ze skupin. Parametry omezují výběr objektů takto: Musí být zadána právě jedna ze skupin identifikačních parametrů. Při použití parcelaID a stavbaID se předpokládá, že uživatel má k dispozici ID objektu nebo že ho předem zjistil s využitím funkce najdiParcelu, najdiStavbu. Pokud je zadáno katastrální území, je vrácen úplný seznam def. bodů parcel a staveb. Pokud jsou zadány souřadnice a typ bodu a:
není zadána vzdálenost, je vrácen nejbližší definiční bod dle zadaného typu (bez omezení na jeho vzdálenost).
je zadána vzdálenost a: o pokud je v zadané vzdálenosti od zadaných souřadnic zjištěn výskyt právě jednoho bodu zadaného typu, je nalezený bod vrácen o pokud je v zadané vzdálenosti od zadaných souřadnic zjištěn výskyt více než jednoho definičního bodu zadaného typu, je vrácena chyba 329 o pokud není v zadané vzdálenosti od zadaných souřadnic zjištěn výskyt ani jednoho definičního bodu zadaného typu, je vrácena chyba 328
Funkce aktivně detekuje následující chyby: 304 Neexistuje záznam s daným identifikátorem! 326 Seznam objektů nesmí být prázdný! 327 Pro vybrané objekty nebyl nalezen ani jeden definiční bod! 328 Pro zadanou podmínku nebyl nalezen žádný definiční bod! 329 Pro zadanou podmínku bylo nalezeno více definičních bodů, zpřesněte výběr!
Přehled vlastnictví (funkce není pro uživatele ověřovacích účtů dostupná)
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 41/73
Popis webových služeb pro uživatele
Název funkce: generujPrehledVlastnictvi Název parametru
Nepovinný
Popis
osId
ano
ID OS, pro který se má vygenerovat sestava Přehled vlastnictví
krajKod
ano
Kód kraje, pro který se vlastnictví bude vypisovat
obecKod
ano
Kód obce, pro kterou se vlastnictví bude vypisovat
typPravnihoVztahuKod
ano
Typ právního vztahu, podle kterého se bude vyhledávat (musí odpovídat položce číselníku, která má atribut Vlastnictví = "a")
Výstupní formát: Viz odstavec Vracení sestav XSD: https://katastr.cuzk.cz/dokumentace/xsd/sestavy/PrehledVlastnictvi.xsd Funkce: Spustí sestavu pro zadaný OS nebo bude vyhledávání provedeno v rozsahu podle případně zadaných parametrů krajKod a obecKod a typPravnihoVztahu nebo, pokud nebudou zadány, přes celou ČR. Pokud bude funkce vyvolána s hodnotou typPravnihoVztahu, které neodpovídá záznam s hodnotou atributu Vlastnictví = "a", funkce vrátí chybu 117.
Evidence práv pro osobu Název funkce: generujEvidenciPravProOsobu Název parametru
Nepovinný
Popis
typ
ne
Typ oprávněného subjektu („OFO“,“OPO“)
nazev
ne
Příjmenía Jméno / Název OS, pro který se má vygenerovat sestava Evidence práv pro osobu
rcIco
ne
RČ / datum narození ve formátu RRMMDD / IČO OS (IČO včetně úvodních nul), pro který se má vygenerovat sestava Evidence práv pro osobu
Funkce: Spustí sestavu Evidence práv pro osobu pro zadaný OS. XSD: https://katastr.cuzk.cz/dokumentace/xsd/sestavy/EvidencePravProOsobu.xsd Funkce je přístupná i uživatelům typu Ověřující osoba. Ošetření stavu, kdy není možné opatřit výstup elektronickou značkou, je shodné s popisem v kapitole Odebrání sestavy. Zpoplatnění sestavy je stejné jako v aplikaci DP.
Výpis zákaznického účtu Název funkce: vypisUctu Vstupní formát: RPC style Název parametru
Nepovinný
Popis
datumOd
ne
Počáteční datum, od kterého má být výpis vytvořen
datumDo
ano
Koncové datum, do kterého má být výpis vytvořen. Implicitní hodnota je aktuální datum.
format
ano
„PDF“ nebo „XML“. Pokud uživatel parametr nezadá, bude použita výchozí hodnota "PDF".
Výstupní formát: Viz odstavec Vracení sestav Tento výpis nemá společnou část na rozdíl od výše uvedených funkcí (operací). XSD: https://katastr.cuzk.cz/static/xml/VypisStavuZakaznickehoUctu.xsd Funkce: Spustí sestavu.
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 42/73
Popis webových služeb pro uživatele
4.10 Správa účtu V této skupině služeb je funkce pro správu účtu – změna hesla. Přístupový bod webové služby je https://katastr.cuzk.cz/ws2/wsdp/ucet
Změna hesla uživatele Název funkce: zmenHeslo Název parametru
Nepovinný
Popis
stareHeslo
Ne
Původní heslo daného uživatele
noveHeslo
Ne
Nové heslo daného uživatele
Výstupní formát: XML dokument typu ZmenHesloResponse. Funkce: Umožní změnit heslo daného uživatele.
4.11 Vyhledávaní V této skupině služeb jsou funkce pro vyhledávání oprávněných subjektů, parcel, staveb a jednotek. Přístupový bod webové služby je https://katastr.cuzk.cz/dokumentace/ws2/wsdp/vyhledat
Vyhledávání OS Název funkce: najdiOS Název parametru
Nepovinný
Popis
ano
Parametr pro vyhledávání podle názvu resp. podle příjmení a jména
ico
ano
Parametr pro vyhledávání podle IČO firmy
rc
ano
Parametr pro vyhledávání podle RČ či části RČ subjektu
nazev
Výstupní formát: XML dokument typu NajdiOSResponse. Funkce: Umožní vyhledat OS na základě názvu (resp. jména a příjmení) a IČO anebo RČ. Je dovoleno zadat kombinaci parametrů „nazev“ a „rc“, „nazev“ a „ico“. Pokud bude vyplněn parametr nazev, funkce bude nejdříve hledat přesnou shodu s příjmením a jménem a nalezené záznamy budou doplněny o hledání na částečnou shodu (začátek názvu) s názvem organizace. Funkce bude vracet pouze OS s nevyplněným zdrojem, tj. v případě OS, které mají master, bude funkce vracet pouze sjednocené OS. Jestliže je v dotazu na OS vyhledána fyzická osoba, která má partnera SJM, pak v odpovědi bude uveden blok pro tuto fyzickou osobu a dále pak blok SJM (v datech typ BSM), v němž se vypíší záznamy pro oba partnery. Postup vyhledávání je tedy shodný s interaktivním DP. Vyhledávání je provedeno přes celou republiku. Při nedostatečně selektivním zadání parametrů nazev, ico a rc nebo při současném vyplnění parametrů „rc“ a „ico“, funkce vrátí chybu (viz seznam chyb).
Vyhledávaní parcely Název funkce: najdiParcelu Název parametru
Nepovinný
Popis
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 43/73
Popis webových služeb pro uživatele
Název parametru
Nepovinný
Popis
katastrUzemiKod
ne
Kód katastrálního území, ve kterém se bude vyhledávat
kmenoveCislo
ne
poddeleni
ano
Číslo parcely
Výstupní formát: XML dokument typu NajdiParceluResponse. Funkce: Umožní vyhledat parcelu na základě k.ú. a jejího čísla. Vrátí seznam všech parcel, které odpovídají zadání. V případě nevyplnění podlomení se vyhledává pouze parcela bez podlomení.
Vyhledávaní stavby Název funkce: najdiStavbu Název parametru
Nepovinný
Popis
castObceKod
ne
Kód části obce, v které se bude vyhledávat
typStavbyKod
ne
Kód typu stavby (povolené hodnoty 1, 2 nebo 4)
cisloDomovni
ne
Číslo popisné resp. evidenční budovy
Výstupní formát: XML dokument typu NajdiStavbuResponse. Funkce: Umožní vyhledat stavbu na základě části obce a čísla popisného nebo evidenčního.
Vyhledávaní jednotky Název funkce: najdiJednotku Název parametru
Nepovinný
Popis
stavbaId
právě jeden způsob identifikace musí být zadán
ID stavby, ve které se mají jednotky vyhledávat. Pokud není parametr zadán, musí být zadány parametry castObceKod, typStavbyKod, cpCe
castObceKod
Kód části obce, v které se bude vyhledávat
typStavbyKod
Kód typu stavby (povolené hodnoty 1, 2 nebo 4)
cisloDomovni
Číslo popisné resp. evidenční budovy
cisloJednotky
ano
Číslo jednotky.
Výstupní formát: XML dokument typu NajdiJednotkuResponse. Funkce: Umožní vyhledat jednotku na základě identifikace stavby a čísla jednotky. Vrátí seznam všech jednotek, které odpovídají zadání. Pokud číslo jednotky není zadáno, potom je výstupem seznam všech jednotek v dané budově (nebo budovách).
4.12 Příklady volání webových služeb (WS) Na vstupu jsou uvedeny použité vstupní parametry pro volání WS. Tučně zvýrazněné parametry byly získány z odpovědi některého z předchozích volání WS. Parametr „time“ představuje skutečnou dobu vytváření sestavy, parametr „timeOut“ nastavení max. doby vytváření sestavy, kdy je ještě použit synchronní přístup. Vytvoření sestavy list vlastnictví na základě ID listu vlastnictví získaného pomocí některé ze služeb „Vyhledávání“. Ukázka komunikace klient – server pro tento způsob získání Výpisu z KN je v příloze.
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 44/73
Popis webových služeb pro uživatele
Vytvoření sestavy list vlastnictví na základě idOS a kódu katastrálního území.
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 45/73
Popis webových služeb pro uživatele
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 46/73
Popis webových služeb pro uživatele
Vytvoření sestavy „Výpis zákaznického účtu“
Neúspěšné vyhledávání (např. neexistující identifikátor atd.) <ns0:zprava kod=”0” uroven=”INFORMACE”>Operace proběhla úspěšně <ParcelaList/>
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 47/73
Popis webových služeb pro uživatele
4.13 Autorizace Autorizace uživatelů je vykonávaná při každém dotazu. Pro zabezpečení volání je použit mechanismus WSS – Web Service Security. V definici WSS jsou specifikovány položky v sekci SOAP:Header a související mechanismy. Údaje o uživateli a hesle jsou součástí každého volání WS2. <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://katastr.cuzk.cz/sestavy/types/"> <soapenv:Header> <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasisopen.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasisopen.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"> <wsse:UsernameToken wsu:Id="UsernameToken-3"> <wsse:Username>USERNAME <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wssusername-token-profile-1.0#PasswordText">PASSWORD <soapenv:Body> 11111111010
Pokud nastane chyba ve jménu nebo heslu, klient dostane SOAP:Fault zprávu, kde je důvod chyby: <env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"> <env:Body> <env:Fault xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecuritysecext-1.0.xsd"> wsse:FailedAuthentication Failed to assert identity with UsernameToken.
Při autorizaci uživatelů platí totožná pravidla jako u aplikace Dálkový přístup („DP“) – včetně expirace hesla. V případě, že se bude blížit expirace, bude uživatel upozorňován v elementu „vysledek“, který bude obsahovat varování. Ve výstupu bude současně obsažena požadovaná sestava nebo výsledek dotazu. Po expiraci hesla bude vráceno pouze chybové hlášení v elementu „vysledek“.
Přehled chybových odpovědí WS-Security Vstupní údaje
faltcode
faultstring
Chybné autentifikační údaje – nesprávné uživatelské jméno, heslo, přístup z nepovolené IP adresy, ukončený či blokovaný uživatelský účet. Nedostatečná práva pro přístup k aplikaci.
wsse:FailedAuthentication
Failed to assert identity with UsernameToken.
Chybějící hlavička WS-Security.
wsse:InvalidSecurity
Error on verifying message against security policy
Časová značka požadavku z minulosti nebo budoucnosti (wsse:Nonce, wsu:Created).
wsse:InvalidSecurityToken
Security validate.
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
token
failed
Strana 48/73
to
Popis webových služeb pro uživatele
Nepodporovaný typ WS-Security Token.
wsse:InvalidSecurity
různé
4.14 Bezpečnost Všechny zde uvedené webové služby jsou přístupné prostřednictvím HTTPS protokolu. Šifrovaný přístup zabezpečuje bezpečný přenos dat včetně přihlašovacích údajů. Pro uživatele jsou zakládány zvláštní účty umožňující pouze přístup k webovým službám (nikoliv do interaktivního DP nebo k jiné aplikaci). Při pokusu o přihlášení je uživateli kontrolováno přiřazení role pro přístup k webovým službám. Pokud uživatel nemá roli přiřazenu, bude vrácena chyba 207 (viz tabulka hlášených chyb). Autorizovaný přístup ke každému účtu je zabezpečován prostřednictvím uživatelského hesla. Tvorba a užívaní hesel (struktura hesla, časově omezená platnost) se řídí stejnými pravidly jako u interaktivního přístupu. Varování před blížícím se ukončením platnosti hesla bude předáváno v rámci odpovědi (viz kod 206 v tabulce hlášených chyb). Vybrané výstupy ve formátech PDF a XML jsou pro testovací účely opatřeny elektronickou značkou.
4.15 Zahrnutí provozních informací do odpovědí webových služeb V případě potřeby může ČÚZK vložit do aplikace WSDP informační texty provozního charakteru. Tyto texty jsou následně vraceny v každé odpovědi aplikace WSDP v elementu „vysledek“ (viz popis elementu v kapitole Chyba! Nenalezen zdroj odkazů.). Texty budou mít ve většině případů omezenou dobu platnosti (např. od 24.7.2013 22:00 do 26.7.2013 19:00) a budou se zapisovat do odpovědí pouze po tuto dobu platnosti. Jedná se tedy o určitou obdobu úvodní stránky interaktivního DP(https://katastr.cuzk.cz/uvod/) , kde se zobrazují provozní informace včetně novinek v aplikaci. Touto cestou předávány následující typy informací: informace o plánovaných odstávkách aplikace WSDP (případně celého systému ISKN) upozornění na omezení funkčnosti části aplikace upozornění na problémy s aktualizací dat KN pro některé pracoviště (např. rozsáhlý výpadek proudu znemožní přijímat podání na konkrétním pracovišti a dojde k jednodennímu zpoždění při vyřizování vkladů a vyznačování plomb u nemovitostí) upozornění na ukončení provozu souběžně provozovaných služeb WSDP verze 1 Protože informace jsou do odpovědí vkládány samotnou aplikací WSDP, nebudou při výpadku aplikace WSDP nebo během plánované odstávky vraceny v odpovědích tyto informační texty. V těchto případech bude jako doposud vracena obecná informace o nedostupnosti aplikace WSDP. Informační text může být vkládán do všech odpovědí aplikace WSDP nebo může být vztažen ke konkrétní webové službě: ciselniky informace sestavy ucet vyhledat enx (poznámka: aplikace ENX je popisována v samostatném dokumentu) V takovém případě se zobrazuje v odpovědích jen dané webové služby. Informační texty se budou zobrazovat jako elementy „zprava“ zahrnuté do elementu „vysledek“. I u těchto zpráv bude přiřazen atribut „úroveň“ definující závažnost zprávy (INFORMACE, VAROVANI, CHYBA). Abychom umožnili rozlišení, které elementy „zprava“ se vztahují k vlastní konkrétní odpovědi (informují o
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 49/73
Popis webových služeb pro uživatele
stavu zpracování požadavku a zobrazují případné chyby zpracování požadavku) a které elementy jsou vkládána jako informační texty, přistoupili jsme k zavedení konvence, že informační texty budou mít kód větší než 9000. Zároveň tyto kódy nebudou obsažené v číselníků zpráv, který je možné získat pomocí funkce „seznamZprav“. Ukázka informačních textů: ... <ns0:zprava kod="0" uroven="INFORMACE">Požadovaná akce byla úspěšně provedena. <ns0:zprava kod="9002" uroven="VAROVANI">Příklad varování: Aplikace WSDP má omezení ve funkci XXX z důvodu YYY. <ns0:zprava kod="9001" uroven="INFORMACE">Toto je příklad provozní informace, která bude v ostré verzi aplikace WSDP vkládána v případě potřeby. Cílem je upozornit na plánované odstávky nebo informovat o dočasných omezeních aplikace. Podobné informace se pro interkativní aplikaci DP zobrazují na úvodní stránce (https://katastr.cuzk.cz/uvod/). <ns0:zprava kod="9004" uroven="CHYBA">Příklad závažné chyby: V aplikaci WSDP bylo dočasně znemožněno opatřování výstupů elektronickou značkou!. <ns0:zprava kod="9003" uroven="CHYBA">Příklad oznámení o chybném chování: Sestava XXX neobsahuje správnou značku YYY. ...
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 50/73
Popis webových služeb pro uživatele
5 Zpoplatnění poskytovaných výstupů Pro zpoplatnění PDF sestav platí stejná pravidla jako v interaktivním DP, včetně specifické odlišnosti pro ověřovací účty. Služby vyhledávaní, správa účtu, číselníky a práce se sestavami jsou poskytovány bezúplatně. Způsob zpoplatnění ve formátu XML je podrobně popsán ve vyhlášce č.162/2001 Sb., o poskytování údajů z katastru nemovitostí České republiky, ve znění pozdějších předpisů.
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 51/73
Popis webových služeb pro uživatele
6 Vracení sestav Základní způsob vracení sestav je asynchronní. Služba po zařazení sestavy do fronty vrátí ID výstupu a uživatel si ji po vytvoření (které se dá zkontrolovat pomocí služby přehledu sestav) může další službou odebrat. V tomto případě je výstupem ID sestavy. Vrácení sestavy on-line je možné jen u WSDP v1 za předpokladu, že sestava bude zpracována dříve, než vyprší interní časový limit. Pokud bude uživatel, který požaduje odebrání sestavy, typu ověřující, bude kontrolováno, zda daná funkce vyžaduje opatření el. značkou viz popis služby Odebrání sestavy (vratSestavu). Pokud jsou všechny předpoklady splněny, potom je výstupem funkcí vygenerovaný dokument PDF, který je součástí odpovědi jako MIME příloha (WSDP v1) nebo MTOM příloha (WSDP v2). Pokud bude výstup opatřen el. značkou, bude uživateli vráceno informační hlášení s kódem 317 Výstup je opatřen elektronickou značkou poskytovatele. Pokud je povoleno automatické zaplacení a cena bude vyšší než definovaná maximální cena, potom bude výstup obsahovat pouze ID sestavy jako při základním způsobu. Zaplacení a odebírání bude moci uživatel vykonat pomocí funkce na odebírání sestav – asynchronní odebírání. Součástí procesu vytváření sestav ve formátu XML je jejich validace proti aktuálnímu XSD. V případě, že je výstup vyhodnocen jako nevalidní, je o tom uživatel při odebrání informován zprávou 371 -„Výstup ve formátu XML není validní!“.
6.1 Sestavy – možné stavy Stavy vytvářených sestav jsou definovány v XSD souboru isknResponse.xsd. Sestava se může nacházet v některém z následujících stavů: Název stavu
Popis
čeká
Uživatel skrze aplikaci zadal požadavek na vytvoření vybrané sestavy spolu s vyžadovanými parametry sestavy. Sestava byla přijata ke zpracování a byla zařazena do fronty čekajících sestav.
vytváří se
Sestava byla odebrána z fronty čekajících sestav a bylo započato s jejím vytvářením.
podepisuje se
Sestava byla vytvořena a nyní se opatřuje elektronickou značkou.
zpracován
Sestava je vytvořena (a případně opatřena elektronickou značkou) a je připravena k odebrání uživatelem.
chyba při vytváření
Nastala chyba při vytváření sestavy nebo elektronické značky pro sestavu. Zkuste zadat nový požadavek na vytvoření sestavy.
chyba při zpracování
Nastala chyba při zpracovávání požadavku na vytvoření sestavy. Sestava se v takovém případě nezačne vytvářet. Příčinou může být chyba na infrastruktuře provozující aplikaci WSDP. Zkuste zadat nový požadavek na vytvoření sestavy později.
zaúčtován
Sestava byla odebrána uživateli (po odsouhlasení ceny).
zrušen
Sestava byla označena za smazanou (uživatelem nebo systémem).
Posledním stavem sestavy je její smazání. Tento stav již uživatelé neuvidí.
6.2
List vlastnictví - záložky
List vlastnictví generovaný přes WS ve formátu PDF je doplněn v části B záložkami (bookmarky). 1. Bookmarky se týkají sekce B - root stromu bookmarků. 2. Každá část sekce B, tj. Pozemky, Stavby, Jednotky a Pozemky ve zjednodušené evidenci (PZE) je další úroveň stromu.
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 52/73
Popis webových služeb pro uživatele
3. V rámci PZE jsou rozlišeny jednotlivé zdroje parcel jako úrovně stromu. 4. V rámci uvedených úrovní je každá entita (parcela, stavba, jednotka) další samostatná úroveň stromu. 5. V rámci každé entity je každý datový objekt reportu reprezentován samostatným bookmarkem. Rozumí se tím výsledné pole na sestavě, není nutné parsovat vnořená pole. Strom záložek začíná uzlem NEMOVITOSTI. Po rozbalení uzlu NEMOVITOSTI se zobrazí uzly POZEMKY, STAVBY, JEDNOTKY a POZEMKY_V_ZE. Uzel pozemky ve zjednodušené evidenci se dále větví na jednotlivé zdroje parcel. V rámci uvedených úrovní je každá entita (parcela, stavba, jednotka) další samostatná úroveň stromu. Každý datový objekt reportu na úrovni zmíněných entit je reprezentován samostatnou záložkou, která obsahuje název pole a jeho hodnotu. V oddíle Jednotky je pro výčet parcel pod budovou použit uzel s textem ‚NA_PARCELACH‘. Pro výčet parcel, které jsou součástí spoluvlastnictví jednotky je další uzel s textem ‚PRISLUSEJICI_SPOLUVLASTNICTVI‘, v rámci tohoto uzlu je každá parcela další samostatná úroveň stromu. Všechny hodnoty položek jsou před zápisem do záložek konvertovány. Konvertovány jsou znaky s ASCII kódem nad 127 do podoby \xxxx, kde xxxx představuje UNICODE (UTF-16) hodnotu (např. text "zemědělský" bude zapsán jako "zem\011Bd\011Blsk\00FD").
Podrobný popis záložek - NEMOVITOSTI - POZEMKY - PARCELA= VYMERA= DRUH_POZEMKU= ZPUSOB_VYUZITI= ZPUSOB_OCHRANY= - STAVBY - STAVBA= ZPUSOB_VYUZITI= ZPUSOB_OCHRANY= - NA_PARCELACH PARCELA= - JEDNOTKY - CISLO_JEDNOTKY=<JED_CISLO_JEDNOTKY> ZPUSOB_VYUZITI=<JED_TYP_JEDNOTKY> ZPUSOB_OCHRANY=<JED_OCHRANA> PODIL= POPIS_JEDNOTKY= BUDOVA=<JED_OPSUB> - NA_PARCELACH PARCELA=<J_PAR_C_P> - PRISLUSEJICI_SPOLUVLASTNICTVI - PARCELA= DRUH_POZEMKU= ZPUSOB_VYUZITI= VYMERA= - POZEMKY_V_ZE - ZDROJ_PARCELY= - PARCELA_ZE=
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 53/73
Popis webových služeb pro uživatele
DIL= TYP= VYMERA= PUVODNI_KU= Formát sestav vracených aplikací
Aplikace umožňuje vytvářet výstupy z KN formou sestav. K dispozici jsou dva formáty sestavy:
PDF XML
XML formát sestav Výstupy XML jsou generovány stejnou technologií jako PDF výstupy. Obsah XML odpovídá obsahu PDF výstupu, proto mohou být v některých položkách obsaženy úvodní mezery, formátovací znaky, atd. Pro každý výstup existuje XSD popis dostupný na: https://katastr.cuzk.cz/static/xml/ a https://katastr.cuzk.cz/dokumentace/xsd/sestavy/. Problematické znaky (např. <, >, &) jsou nahrazeny entitami, případně odstraněny (znaky s kódy 0–8, 11, 12, 14 – 31). Vybrané výstupy ve formátu XML mohou být opatřeny elektronickou značku vytvářenou v souladu se standardem W3C "XML Signature Syntax and Processing". Tyto výstupy obsahují elementy z externího jmenného prostoru "http://www.w3.org/2000/09/xmldsig#"" definovaného http://www.w3.org/TR/2008/REC-xmldsig-core-20080610/xmldsig-core-schema.xsd.
6.3
Kódování diakritiky
Pokud bude dotaz obsahovat specifikaci kódování, pak vstupní data budou interpretována v zadaném kódování a výstupní XML dokumenty budou vytvořeny taky v zadaném kódování. Kódování sestav v XML je vždy UTF-8.
6.4
Omezení délky výstupů
Délka výstupu je omezena na úrovni elementů OSList, PARCList, STAList, JEDNList, reportList a ciselnikList. Maximální počet přímých podelementů je 20000.
6.5
Omezení uživatelů typu Bezúplatný uživatel, Ověřující osoba
Pro bezúplatné uživatele - jsou pro služby Sestavy s výjimkou služeb seznamSestav, vratSestavu, smazSestavu a vypisUctu povinné parametry cisloJednací a ucelKod. Pro ověřující osoby - je pro služby generující sestavy (s výjimkou služby vypisUctu, obdobně jako je tomu u interaktivní aplikace) povinný parametr poradoveCislo – pořadové číslo, pod kterým je ověření vedeno v evidenci ověření výstupu z ISVS u ověřující osoby. Zadání této hodnoty je povinné a může obsahovat jakékoliv znaky. Pro ověřující osoby jsou dostupné bezplatné služby. Pro uživatele tohoto typu jsou dále přístupné služby generujLV, generujLVZjednodusene a generujLVPresOS (služby generující sestavu “Výpis z katastru nemovitostí“). Sestavy, které mají být opatřeny el. značkou, nemohou být ověřujícím uživatelům zpřístupněny, pokud nebudou el. značkou opatřeny. Pokud minimálně jedna z těchto podmínek (povolený typ sestavy, podepisování sestavy) není splněna, je vrácena chyba 313. Pokud je v době požadavku ověřující osoby na vytvoření výstupu opatřeného elektronickou značkou vytváření elektronické značky vypnuto, je uživateli vrácena chyba 312. Bezplatné služby jsou i v takovém případě přístupné. Uživatel typu Ověřující osoba má přístup pouze k výpisu z katastru nemovitostí, výstupu evidence práv pro osobu a k výpisu stavu zákaznického účtu.
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 54/73
Popis webových služeb pro uživatele
6.6
Definice chyb
Číselník aplikačních chyb je uživateli dostupný pomocí funkce seznamZprav.
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 55/73
Popis webových služeb pro uživatele
7 Prostředí pro ověření služeb WSDP Pro odzkoušení možných webových služeb a ladění klientských aplikací jsou zavedeny stejné webové služby i v DP na zkoušku. Služby mají upravenou adresu. URL pro WSDP v1 je /isknwsTrial/ pro WSDP v2 /trial/ws2/wsdp/. Zároveň jsou oproti plnému přístupu provedeny následující úpravy:
Jako zdroj dat je použita databáze DP na zkoušku obsahující data omezeného rozsahu, která byla po obsahové (nikoliv strukturní) stránce záměrně pozměněna tak, aby neodpovídala platnému stavu KN.
Pro připojení je vytvořen speciální aplikační účet a uživatel WSTEST s heslem WSHESLO (simulující přístup běžného platícího uživatele).
Pro omezení zátěže je stanoven limit maximálního počtu současně pracujících uživatelů obdobným způsobem jako omezení interaktivních uživatelů.
Dále jsou vytvořeny účty a uživatelé WSTESTB (typ – bezúplatný, heslo WSHESLOB) a WSTESTO (typ – ověřovatel, heslo WSHESLOO). Omezení hesel a zátěže jsou stejná.
Vybrané výstupy aplikace WSDP na zkoušku jsou pro testovací účely opatřeny elektronickou značkou.
Aplikace WSDP na zkoušku neposkytuje sestavu „Kopie katastrální mapy“.
Aplikace DP na zkoušku slouží pro seznámení interaktivních uživatelů s aplikací a pro odzkoušení klientských aplikací přistupujících pomocí WS – před zahájením využívání placené verze aplikace. Proto je aplikace na zkoušku provozována na stejném technologickém základu a stejné verzi aplikace jako provozní verze. Aplikace na zkoušku je přesto nezávislá na placené aplikaci DP a bude-li potřeba, je možné aplikaci na zkoušku dočasně provozovat na jiné (novější) verzi a tím např. umožnit uživatelům se lépe připravit na novinky v nových verzích aplikací. Z tohoto důvodu je třeba brát do úvahy samostatné definice webových služeb aplikace DP na zkoušku:
XSD definice WSDP v1 https://katastr.cuzk.cz/staticTrial/xml/isknResponse.xsd https://katastr.cuzk.cz/staticTrial/xml/ciselnik.xsd
WSDL soubory WSDP v1 https://katastr.cuzk.cz/staticTrial/wsdl/ciselnik.wsdl https://katastr.cuzk.cz/staticTrial/wsdl/sestavy.wsdl https://katastr.cuzk.cz/staticTrial/wsdl/vyhledat.wsdl https://katastr.cuzk.cz/staticTrial/wsdl/ucet.wsdl
WSDL soubory WSDP v2 https://katastr.cuzk.cz/trial/dokumentace/ws2/wsdp/ciselnik.wsdl https://katastr.cuzk.cz/trial/dokumentace/ws2/wsdp/informace.wsdl https://katastr.cuzk.cz/trial/dokumentace/ws2/wsdp/sestavy.wsdl https://katastr.cuzk.cz/trial/dokumentace/ws2/wsdp/ucet.wsdl https://katastr.cuzk.cz/trial/dokumentace/ws2/wsdp/vyhledat.wsdl
XSD definice WSDP v2 https://katastr.cuzk.cz/trial/dokumentace/ws2/wsdp/ciselnik.xsd https://katastr.cuzk.cz/trial/dokumentace/ws2/wsdp/informace.xsd
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 56/73
Popis webových služeb pro uživatele
https://katastr.cuzk.cz/trial/dokumentace/ws2/wsdp/sestavy.xsd https://katastr.cuzk.cz/trial/dokumentace/ws2/wsdp/ucet.xsd https://katastr.cuzk.cz/trial/dokumentace/ws2/wsdp/vyhledat.xsd V aplikaci WSDP na zkoušku byly nadefinovány následující ukázky provozních informací:
pro všechny webové služby se bude vracet obecný text s úrovní=INFORMACE a ukázkový text s úrovní=VAROVANI
<ns0:zprava kod="0" uroven="INFORMACE">Požadovaná akce byla úspěšně provedena. <ns0:zprava kod="9002" uroven="VAROVANI">Příklad varování: Aplikace WSDP má omezení ve funkci XXX z důvodu YYY. <ns0:zprava kod="9001" uroven="INFORMACE">Toto je příklad provozní informace, která bude v ostré verzi aplikace WSDP vkládána v případě potřeby. Cílem je upozornit na plánované odstávky nebo informovat o dočasných omezeních aplikace. Podobné informace se pro interkativní aplikaci DP zobrazují na úvodní stránce (https://katastr.cuzk.cz/uvod/).
pro službu sestavy pak navíc ještě ukázkový text s úrovní=CHYBA
<ns0:zprava kod="9003" uroven="CHYBA">Příklad oznámení o chybném chování: Sestava XXX neobsahuje správnou značku YYY.
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 57/73
Popis webových služeb pro uživatele
8 Přílohy 8.1
Příloha 1 Komunikace klient – server (RPC)
Ukázka komunikace mezi klientem a serverem nad webovými službami na zkoušku. Cílem je vytvořit Výpis z KN pro stavební parcelu 77 v k. ú. Jáma (okres Prachatice): Nejprve je třeba v číselníku vyhledat kód k. ú. Jáma. Dotaz: <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cis="http://katastr.cuzk.cz/ciselnik/"> <soapenv:Header/> <soapenv:Body> <username xsi:type="xsd:string">WSTEST <password xsi:type="xsd:string">WSHESLO seznamKU NAZEV like 'Jáma'
Odpověď: <env:Envelope env:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"> <env:Header/> <env:Body> <m:vratCiselnikyResponse xmlns:m="http://katastr.cuzk.cz/ciselnik/"> <element> 693936 Jáma 550426 <error/>
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 58/73
Popis webových služeb pro uživatele
Pokračujeme vyhledáním stavební parcely. Funkce najdiParcelu nerozlišuje stavební a pozemkovou parcelu či parcelu ZE, proto může být vráceno více parcel s požadovaným parcelním číslem. Dotaz: <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:vyh="http://katastr.cuzk.cz/vyhledat/"> <soapenv:Header/> <soapenv:Body> <username xsi:type="xsd:string">WSTEST <password xsi:type="xsd:string">WSHESLO 693936 77 <poddeleni xsi:type="xsd:string"/>
Odpověď: <env:Envelope env:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"> <env:Header/> <env:Body> <m:najdiParceluResponse xmlns:m="http://katastr.cuzk.cz/vyhledat/"> 2850901306 <parType>PKN 693936 77 2 13 893 674660306 1 <staId>293229306 <error/>
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 59/73
Popis webových služeb pro uživatele
Nyní jsme získali jednoznačný identifikátor LV. Zašleme požadavek na Výpis z KN ve formátu PDF. Cena nebude kontrolována na maximální hodnotu. Bude-li dotaz vyřízen rychle (do 3 s), vrátí se nám v příloze Výpis z KN. Jinak se vrátí identifikátor sestavy. Dotaz: <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ses="http://katastr.cuzk.cz/sestavy/"> <soapenv:Header/> <soapenv:Body> <ses:generujLV soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <username xsi:type="xsd:string">WSTEST <password xsi:type="xsd:string">WSHESLO 674660306 pdf a <maximalniCena xsi:type="xsd:string"/> <poradoveCislo xsi:type="xsd:string"/>
Odpověď: <env:Envelope env:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"> <env:Header/> <env:Body> <m:generujLVResponse xmlns:m="http://katastr.cuzk.cz/sestavy/"> 27033088011 Výpis z katastru <pocetJednotek>0 <pocetStran>0 0 2013-08-19T11:06:59 2013-08-19T11:07:01 <stav>vytváří se pdf <error/> >
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 60/73
Popis webových služeb pro uživatele
Dostali jsme odpověď, že se Výpis z KN vytváří. Proto se dotážeme znovu na stav našich sestav. Dotaz: <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ses="http://katastr.cuzk.cz/sestavy/"> <soapenv:Header/> <soapenv:Body> <ses:seznamSestav soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <username xsi:type="xsd:string">WSTEST <password xsi:type="xsd:string">WSHESLO 27033088011
Odpověď: <env:Envelope env:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"> <env:Header/> <env:Body> <m:seznamSestavResponse xmlns:m="http://katastr.cuzk.cz/sestavy/"> 27033088011 Výpis z katastru <pocetJednotek>2 <pocetStran>2 100 2013-08-19T11:06:59 2013-08-19T11:07:01 2013-08-19T11:07:03 <stav>zpracován pdf <elZnacka>a <error/>
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 61/73
Popis webových služeb pro uživatele
Máme sestavu ve stavu „zpracován“. Můžeme si ji tedy vyzvednout. Dotaz: <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ses="http://katastr.cuzk.cz/sestavy/"> <soapenv:Header/> <soapenv:Body> <ses:vratSestavu soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <username xsi:type="xsd:string">WSTEST <password xsi:type="xsd:string">WSHESLO 27033088011
Odpověď: <env:Envelope env:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"> <env:Header/> <env:Body> <m:vratSestavuResponse xmlns:m="http://katastr.cuzk.cz/sestavy/"> 27033088011 Výpis z katastru <pocetJednotek>2 <pocetStran>2 100 2013-08-19T11:06:59 2013-08-19T11:07:01 2013-08-19T11:07:03 <stav>zaúčtován pdf <elZnacka>a <error> 317
I <description>Výstup je opatřen elektronickou značkou poskytovatele. + attachment
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 62/73
Popis webových služeb pro uživatele
Část B Výpisu z KN je reprezentována stromem záložek takto: NEMOVITOSTI |--POZEMKY |--|--PARCELA=St.
77
|--|--|--VYMERA=893 |--|--|--DRUH_POZEMKU=zastav\011Bn\00E1 plocha a n\00E1dvo\0159\00ED |--|-|--|--PARCELA=
1516
|--|--|--VYMERA=19916 |--|--|--DRUH_POZEMKU=trval\00FD travn\00ED porost |--|--|--ZPUSOB_OCHRANY=zem\011Bd\011Blsk\00FD p\016Fdn\00ED fond |--|-|--|--PARCELA=
1538/4
|--|--|--VYMERA=7423 |--|--|--DRUH_POZEMKU=lesn\00ED pozemek |--|--|--ZPUSOB_OCHRANY=pozemek ur\010Den\00FD k pln\011Bn\00ED funkc\00ED lesa |--|-|--|--PARCELA=
1538/5
|--|--|--VYMERA=66270 |--|--|--DRUH_POZEMKU=trval\00FD travn\00ED porost |--|--|--ZPUSOB_OCHRANY=zem\011Bd\011Blsk\00FD p\016Fdn\00ED fond |--|-|--|--PARCELA=
1542
|--|--|--VYMERA=8062 |--|--|--DRUH_POZEMKU=lesn\00ED pozemek |--|--|--ZPUSOB_OCHRANY=pozemek ur\010Den\00FD k pln\011Bn\00ED funkc\00ED lesa |--|-|--|--PARCELA=
1544/2
|--|--|--VYMERA=6034 |--|--|--DRUH_POZEMKU=zahrada |--|--|--ZPUSOB_OCHRANY=zem\011Bd\011Blsk\00FD p\016Fdn\00ED fond |--|-|--|--PARCELA=
1545
|--|--|--VYMERA=3194 |--|--|--DRUH_POZEMKU=trval\00FD travn\00ED porost |--|--|--ZPUSOB_OCHRANY=zem\011Bd\011Blsk\00FD p\016Fdn\00ED fond |--|-|--|--PARCELA=
1558/1
|--|--|--VYMERA=8791 |--|--|--DRUH_POZEMKU=ostatn\00ED plocha |--|--|--ZPUSOB_VYUZITI=neplodn\00E1 p\016Fda |--|-|--|--PARCELA=
1558/2
|--|--|--VYMERA=1486 |--|--|--DRUH_POZEMKU=trval\00FD travn\00ED porost |--|--|--ZPUSOB_OCHRANY=zem\011Bd\011Blsk\00FD p\016Fdn\00ED fond |--|-|--|--PARCELA=
2301
|--|--|--VYMERA=1173 |--|--|--DRUH_POZEMKU=ostatn\00ED plocha |--|--|--ZPUSOB_VYUZITI=ostatn\00ED komunikace |--|-|-|--STAVBY |--|--STAVBA=J\00E1ma, \010D.p. 25 |--|--|--ZPUSOB_VYUZITI=bydlen\00ED |--|--|--NA_PARCELACH |--|--|--|--PARCELA=St.
77
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 63/73
Popis webových služeb pro uživatele
Po úspěšném přijetí Výpisu z KN je možné sestavu smazat. Dotaz: <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ses="http://katastr.cuzk.cz/sestavy/"> <soapenv:Header/> <soapenv:Body> <ses:smazSestavu soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <username xsi:type="xsd:string">WSTEST <password xsi:type="xsd:string">WSHESLO 27033088011
Odpověď: <env:Envelope env:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"> <env:Header/> <env:Body> <ns0:smazSestavuResponse env:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <error> 0
I <description>Požadovaná akce byla úspěšně provedena.
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 64/73
Popis webových služeb pro uživatele
8.2
Příloha 2: Komunikace klient – server (WS2)
Ukázka komunikace mezi klientem a serverem nad webovými službami na zkoušku. Cílem je vytvořit Výpis z KN pro stavební parcelu 77 v k. ú. Jáma (okres Prachatice): Nejprve je třeba v číselníku vyhledat kód k. ú. Jáma. Dotaz: <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://katastr.cuzk.cz/ciselnik/types/"> <soapenv:Header> <wsse:Security soapenv:mustUnderstand="0" xmlns:wsse="http://docs.oasisopen.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasisopen.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"> <wsse:UsernameToken wsu:Id="UsernameToken-2"> <wsse:Username>WSTEST <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wssusername-token-profile-1.0#PasswordText">WSHESLO <soapenv:Body> Jáma%
Odpověď: <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <SeznamKUResponse posledniAktualizaceCiselniku="2008-01-16" xmlns="http://katastr.cuzk.cz/ciselnik/types/" xmlns:ns0="http://katastr.cuzk.cz/commonTypes"> <ns0:zprava kod="0" uroven="INFORMACE">Požadovaná akce byla úspěšně provedena. <ns0:zprava kod="9002" uroven="VAROVANI">Příklad varování: Aplikace WSDP má omezení ve funkci XXX z důvodu YYY. <ns0:zprava kod="9001" uroven="INFORMACE">Toto je příklad provozní informace, která bude v ostré verzi aplikace WSDP vkládána v případě potřeby. Cílem je upozornit na plánované odstávky nebo informovat o dočasných omezeních aplikace. Podobné informace se pro interkativní aplikaci DP zobrazují na úvodní stránce (https://katastr.cuzk.cz/uvod/). 693936 Jáma 550426
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 65/73
Popis webových služeb pro uživatele
Pokračujeme vyhledáním stavební parcely. Funkce najdiParcelu nerozlišuje stavební a pozemkovou parcelu či parcelu ZE, proto může být vráceno více parcel s požadovaným parcelním číslem. Dotaz: <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://katastr.cuzk.cz/vyhledat/types/"> <soapenv:Header> <wsse:Security soapenv:mustUnderstand="0" xmlns:wsse="http://docs.oasisopen.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasisopen.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"> <wsse:UsernameToken wsu:Id="UsernameToken-2"> <wsse:Username>WSTEST <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wssusername-token-profile-1.0#PasswordText">WSHESLO <soapenv:Body> 693936 77
Odpověď: <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns0:zprava kod="0" uroven="INFORMACE">Požadovaná akce byla úspěšně provedena. <ns0:zprava kod="9002" uroven="VAROVANI">Příklad varování: Aplikace WSDP má omezení ve funkci XXX z důvodu YYY. <ns0:zprava kod="9001" uroven="INFORMACE">Toto je příklad provozní informace, která bude v ostré verzi aplikace WSDP vkládána v případě potřeby. Cílem je upozornit na plánované odstávky nebo informovat o dočasných omezeních aplikace. Podobné informace se pro interkativní aplikaci DP zobrazují na úvodní stránce (https://katastr.cuzk.cz/uvod/). <ParcelaList> <Parcela> <ns0:idParcely>2850901306 <ns0:parcelaType>PKN <ns0:katuzeKod>693936 <ns0:kmenoveCislo>77 <ns0:zpUrVyKod>2 <ns0:drupozKod>13 <ns0:vymera>893 <ns0:lvId>807841306 <ns0:druhCislovaniPar>1 <ns0:stavbaId>293229306
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 66/73
Popis webových služeb pro uživatele
Nyní jsme získali jednoznačný identifikátor LV. Zašleme požadavek na Výpis z KN ve formátu PDF. Cena nebude kontrolována na maximální hodnotu. Bude-li dotaz vyřízen rychle (do 3 s), vrátí se nám v příloze Výpis z KN. Jinak se vrátí identifikátor sestavy. Dotaz: <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://katastr.cuzk.cz/sestavy/types/"> <soapenv:Header> <wsse:Security soapenv:mustUnderstand="0" xmlns:wsse="http://docs.oasisopen.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasisopen.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"> <wsse:UsernameToken wsu:Id="UsernameToken-2"> <wsse:Username>WSTEST <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wssusername-token-profile-1.0#PasswordText">WSHESLO <soapenv:Body> 807841306 pdf
Odpověď: <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Header/> <S:Body> <ns0:zprava kod="0" uroven="INFORMACE">Požadovaná akce byla úspěšně provedena. <ns0:zprava kod="9002" uroven="VAROVANI">Příklad varování: Aplikace WSDP má omezení ve funkci XXX z důvodu YYY. <ns0:zprava kod="9001" uroven="INFORMACE">Toto je příklad provozní informace, která bude v ostré verzi aplikace WSDP vkládána v případě potřeby. Cílem je upozornit na plánované odstávky nebo informovat o dočasných omezeních aplikace. Podobné informace se pro interkativní aplikaci DP zobrazují na úvodní stránce (https://katastr.cuzk.cz/uvod/). <ns0:zprava kod="9003" uroven="CHYBA">Příklad oznámení o chybném chování: Sestava XXX neobsahuje správnou značku YYY. 27033090011 Výpis z katastru <pocetJednotek>0 <pocetStran>0 0 2013-08-19T11:16:28 <stav>čeká pdf
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 67/73
Popis webových služeb pro uživatele
Máme sestavu ve stavu „zpracován“. Můžeme si ji tedy vyzvednout. Dotaz: <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://katastr.cuzk.cz/sestavy/types/"> <soapenv:Header><wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasisopen.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasisopen.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"><wsse:UsernameToken wsu:Id="UsernameToken-5"><wsse:Username>WSTEST<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile1.0#PasswordText">WSHESLO <soapenv:Body> 27033090011
Odpověď: <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Header/> <S:Body> <ns0:zprava kod="0" uroven="INFORMACE">Požadovaná akce byla úspěšně provedena. <ns0:zprava kod="9002" uroven="VAROVANI">Příklad varování: Aplikace WSDP má omezení ve funkci XXX z důvodu YYY. <ns0:zprava kod="9001" uroven="INFORMACE">Toto je příklad provozní informace, která bude v ostré verzi aplikace WSDP vkládána v případě potřeby. Cílem je upozornit na plánované odstávky nebo informovat o dočasných omezeních aplikace. Podobné informace se pro interkativní aplikaci DP zobrazují na úvodní stránce (https://katastr.cuzk.cz/uvod/). <ns0:zprava kod="9003" uroven="CHYBA">Příklad oznámení o chybném chování: Sestava XXX neobsahuje správnou značku YYY. 27033090011 Výpis z katastru <pocetJednotek>4 <pocetStran>4 200 2013-08-19T11:16:28 2013-08-19T11:16:29 2013-08-19T11:16:31 <stav>zaúčtován pdf <elZnacka>a <souborSestavy>JVBERi0xLjcKJeLjz...
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 68/73
Popis webových služeb pro uživatele
Po úspěšném přijetí Výpisu z KN je možné sestavu smazat. Dotaz: <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://katastr.cuzk.cz/sestavy/types/"> <soapenv:Header> <wsse:Security soapenv:mustUnderstand="0" xmlns:wsse="http://docs.oasisopen.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasisopen.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"> <wsse:UsernameToken wsu:Id="UsernameToken-2"> <wsse:Username>WSTEST <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wssusername-token-profile-1.0#PasswordText">WSHESLO <soapenv:Body> 27033090011
Odpověď: <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Header/> <S:Body> <ns0:zprava kod="0" uroven="INFORMACE">Požadovaná akce byla úspěšně provedena.
8.3
Příloha 3: Přehled změn ve výstupech generovaných do XML
VypisZKatastruNemovitosti.xsd V připravené verzi výstupu do dodávky D7.1 je upravena struktura informací o jiných právech v listu vlastnictví v sekci C a D. Je zrušena větev – – včetně detailů. Tato zrušená větev je nahrazena následující strukturou: – – obsahující další detaily. JPV na straně „K“ jsou členěna podle údajů oprávněných subjektů, které jsou obsaženy ve skupině elementů <JP_K_IDENT_C_OS> (dříve bylo součástí <JP_K_IDENT>). V sekci jsou obsaženy elementy s identifikací řízení a dále elementy <JP_K_IDENT_C_NEM> obsahující informace o nemovitostech. Část dotčené struktury: < C_JPV_OS> < JP_K_IDENT_C_OS> … < C_JPV_NEM>
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 69/73
Popis webových služeb pro uživatele
< IDENT_RIZENI> … < JP_K_IDENT_C_NEM> … Je zrušena větev – – včetně detailů. Tato zrušená větev je nahrazena následující strukturou: – – obsahující další detaily. JPV na straně „K“ jsou členěna podle údajů oprávněných subjektů, které jsou obsaženy ve skupině elementů <JP_K_IDENT_D_OS> (dříve bylo součástí <JP_K_IDENT_D>). V sekci jsou obsaženy elementy s identifikací řízení a dále elementy <JP_K_IDENT_D_NEM> obsahující informace o nemovitostech. Část dotčené struktury: < D_JINY_ZAPIS_OS> < JP_K_IDENT_D_OS> … < IDENT_RIZENI> … < JP_K_IDENT_D_NEM> …
Element JINE_KU obsahuje nově podelementy a < F_BONITY> < F_BONITA> < BON_PARCELNI_CISLO> … < JINE_KU> < kod> < nazev> < BONITY_BPEJ>
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 70/73
Popis webových služeb pro uživatele
< PARCELY_ZE_A_PK> < PARCELA_ZE> < DIL_PARCELY_ZE > < PARCELNI_CISLO_ZE > … < PUV_NAZEV_KU> < kod> < nazev> < TYP_1> < VYMERA_PARCELY_ZE> < PLOMBA_PARCELY_1>
Vypis tagu byl nahrazen dvema tagy: - zpusob vyuziti jednotky s atributem kod. Hodnota tagu obsahuje zkratku. - typ jednotky s atributem kod. Hodnota tagu bude obsahovat zkratku. Příklad: garáž rozest. Došlo ke sjednocení výpisu struktury adresy oprávněného subjektu (OS), do vypisovaných elementů byla doplněna položka obsahující stát <stat>. <xs:element name="adresa" minOccurs="0"> <xs:complexType> <xs:sequence maxOccurs="unbounded"> <xs:element name="nazev_ulice" type="xs:string" minOccurs="0"/> <xs:element name="cislo_domovni" type="xs:string" minOccurs="0"/> <xs:element name="cislo_orient" type="xs:string" minOccurs="0"/> <xs:element name="cast_obce" type="xs:string" minOccurs="0"/> <xs:element name="obec" type="xs:string" minOccurs="0"/> <xs:element name="psc" type="xs:string" minOccurs="0"/> <xs:element name="dod_posta" type="xs:string" minOccurs="0"/> <xs:element name="stat" type="xs:string" minOccurs="0"/>
Dále řešeny úpravy ve formátování některých elementů – zejména se jedná o odstranění formátovacích znaků použitých v PDF formě dokumentu (lomítka, pomlčky, čárky), sjednocení vypisovaných údajů.
PrehledVlastnictvi.xsd Došlo ke sjednocení výpisu struktury adresy oprávněného subjektu (OS), do vypisovaných elementů byla doplněna položka obsahující stát <stat>.
InformaceOStavbach.xsd Došlo ke sjednocení výpisu struktury adresy oprávněného subjektu (OS), do vypisovaných elementů byla doplněna položka obsahující stát <stat>. V elementu došlo k doplnění údaje obsahující zkratku využití budovy . V elementu došlo k doplnění údaje obsahující původní katastrální území .
InformaceOParcelach.xsd Došlo ke sjednocení výpisu struktury adresy oprávněného subjektu (OS), do vypisovaných elementů byla doplněna položka obsahující stát <stat>.
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 71/73
Popis webových služeb pro uživatele
V elementu došlo k doplnění údaje obsahující původní katastrální území . V elementu došlo k doplnění údaje obsahující zkratku využití budovy .
InformaceOJednotkach.xsd V elementech a došlo k doplnění údaje obsahující původní katastrální území .
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 72/73
Popis webových služeb pro uživatele
Popis_webovych_sluzeb_pro_uzivatele_v1.0_final
Strana 73/73